This Page

Psst... hey. You're reading the latest content, but it might be out of sync with code. You can read Nova 2011.2 docs or all OpenStack docs too.

The nova.db.sqlalchemy.api Module

Implementation of SQLAlchemy backend.

nova.db.sqlalchemy.api.agent_build_create(*args, **kwargs)
nova.db.sqlalchemy.api.agent_build_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.agent_build_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.agent_build_get_by_triple(*args, **kwargs)
nova.db.sqlalchemy.api.agent_build_update(*args, **kwargs)
nova.db.sqlalchemy.api.auth_token_create(*args, **kwargs)
nova.db.sqlalchemy.api.auth_token_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.auth_token_get(*args, **kwargs)
nova.db.sqlalchemy.api.auth_token_update(*args, **kwargs)
nova.db.sqlalchemy.api.authorize_project_context(context, project_id)

Ensures a request has permission to access the given project.

nova.db.sqlalchemy.api.authorize_user_context(context, user_id)

Ensures a request has permission to access the given user.

nova.db.sqlalchemy.api.block_device_mapping_create(*args, **kwargs)
nova.db.sqlalchemy.api.block_device_mapping_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.block_device_mapping_destroy_by_instance_and_volume(*args, **kwargs)
nova.db.sqlalchemy.api.block_device_mapping_get_all_by_instance(*args, **kwargs)
nova.db.sqlalchemy.api.block_device_mapping_update(*args, **kwargs)
nova.db.sqlalchemy.api.block_device_mapping_update_or_create(*args, **kwargs)
nova.db.sqlalchemy.api.can_read_deleted(context)

Indicates if the context has access to deleted objects.

nova.db.sqlalchemy.api.certificate_create(*args, **kwargs)
nova.db.sqlalchemy.api.certificate_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.certificate_get(*args, **kwargs)
nova.db.sqlalchemy.api.certificate_get_all_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.certificate_get_all_by_user(*args, **kwargs)
nova.db.sqlalchemy.api.certificate_get_all_by_user_and_project(*args, **kwargs)
nova.db.sqlalchemy.api.certificate_update(*args, **kwargs)
nova.db.sqlalchemy.api.compute_node_create(*args, **kwargs)
nova.db.sqlalchemy.api.compute_node_get(*args, **kwargs)
nova.db.sqlalchemy.api.compute_node_update(*args, **kwargs)
nova.db.sqlalchemy.api.console_create(context, values)
nova.db.sqlalchemy.api.console_delete(context, console_id)
nova.db.sqlalchemy.api.console_get(context, console_id, instance_id=None)
nova.db.sqlalchemy.api.console_get_all_by_instance(context, instance_id)
nova.db.sqlalchemy.api.console_get_by_pool_instance(context, pool_id, instance_id)
nova.db.sqlalchemy.api.console_pool_create(context, values)
nova.db.sqlalchemy.api.console_pool_get(context, pool_id)
nova.db.sqlalchemy.api.console_pool_get_all_by_host_type(context, host, console_type)
nova.db.sqlalchemy.api.console_pool_get_by_host_type(context, compute_host, host, console_type)
nova.db.sqlalchemy.api.export_device_count(*args, **kwargs)
nova.db.sqlalchemy.api.export_device_create_safe(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_associate(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_associate_pool(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_count_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_create(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_disassociate(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_disassociate_all_by_timeout(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_get_all_by_instance_host(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_get_by_address(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_get_by_instance(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_get_by_network_host(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_get_by_virtual_interface(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_get_network(*args, **kwargs)
nova.db.sqlalchemy.api.fixed_ip_update(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_allocate_address(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_count_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_create(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_deallocate(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_disassociate(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_fixed_ip_associate(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_get(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_get_all_by_host(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_get_all_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_get_by_address(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_set_auto_assigned(*args, **kwargs)
nova.db.sqlalchemy.api.floating_ip_update(*args, **kwargs)
nova.db.sqlalchemy.api.instance_action_create(*args, **kwargs)
nova.db.sqlalchemy.api.instance_add_security_group(context, instance_id, security_group_id)

Associate the given security group with the given instance

nova.db.sqlalchemy.api.instance_create(*args, **kwargs)
nova.db.sqlalchemy.api.instance_data_get_for_project(*args, **kwargs)
nova.db.sqlalchemy.api.instance_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_actions(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_active_by_window(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_active_by_window_joined(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_all_by_filters(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_all_by_host(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_all_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_all_by_reservation(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_all_by_user(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_by_fixed_ip(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_by_fixed_ipv6(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_by_uuid(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_fixed_addresses(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_fixed_addresses_v6(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_floating_address(*args, **kwargs)
nova.db.sqlalchemy.api.instance_get_project_vpn(*args, **kwargs)
nova.db.sqlalchemy.api.instance_metadata_delete(*args, **kwargs)
nova.db.sqlalchemy.api.instance_metadata_delete_all(*args, **kwargs)
nova.db.sqlalchemy.api.instance_metadata_get(*args, **kwargs)
nova.db.sqlalchemy.api.instance_metadata_get_item(*args, **kwargs)
nova.db.sqlalchemy.api.instance_metadata_update(*args, **kwargs)
nova.db.sqlalchemy.api.instance_remove_security_group(*args, **kwargs)
nova.db.sqlalchemy.api.instance_stop(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_create(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_extra_specs_delete(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_extra_specs_get(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_extra_specs_get_item(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_extra_specs_update_or_create(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_get(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_get_by_flavor_id(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_get_by_name(*args, **kwargs)
nova.db.sqlalchemy.api.instance_type_purge(*args, **kwargs)
nova.db.sqlalchemy.api.instance_update(*args, **kwargs)
nova.db.sqlalchemy.api.is_admin_context(context)

Indicates if the request context is an administrator.

nova.db.sqlalchemy.api.is_user_context(context)

Indicates if the request context is a normal user.

nova.db.sqlalchemy.api.iscsi_target_count_by_host(*args, **kwargs)
nova.db.sqlalchemy.api.iscsi_target_create_safe(*args, **kwargs)
nova.db.sqlalchemy.api.key_pair_create(*args, **kwargs)
nova.db.sqlalchemy.api.key_pair_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.key_pair_destroy_all_by_user(*args, **kwargs)
nova.db.sqlalchemy.api.key_pair_get(*args, **kwargs)
nova.db.sqlalchemy.api.key_pair_get_all_by_user(*args, **kwargs)
nova.db.sqlalchemy.api.migration_create(*args, **kwargs)
nova.db.sqlalchemy.api.migration_get(*args, **kwargs)
nova.db.sqlalchemy.api.migration_get_by_instance_and_status(*args, **kwargs)
nova.db.sqlalchemy.api.migration_update(*args, **kwargs)
nova.db.sqlalchemy.api.network_associate(*args, **kwargs)
nova.db.sqlalchemy.api.network_count(*args, **kwargs)
nova.db.sqlalchemy.api.network_count_allocated_ips(*args, **kwargs)
nova.db.sqlalchemy.api.network_count_available_ips(*args, **kwargs)
nova.db.sqlalchemy.api.network_count_reserved_ips(*args, **kwargs)
nova.db.sqlalchemy.api.network_create_safe(*args, **kwargs)
nova.db.sqlalchemy.api.network_delete_safe(*args, **kwargs)
nova.db.sqlalchemy.api.network_disassociate(*args, **kwargs)
nova.db.sqlalchemy.api.network_disassociate_all(*args, **kwargs)
nova.db.sqlalchemy.api.network_get(*args, **kwargs)
nova.db.sqlalchemy.api.network_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.network_get_all_by_host(*args, **kwargs)
nova.db.sqlalchemy.api.network_get_all_by_instance(*args, **kwargs)
nova.db.sqlalchemy.api.network_get_all_by_uuids(*args, **kwargs)
nova.db.sqlalchemy.api.network_get_associated_fixed_ips(*args, **kwargs)
nova.db.sqlalchemy.api.network_get_by_bridge(*args, **kwargs)
nova.db.sqlalchemy.api.network_get_by_cidr(*args, **kwargs)
nova.db.sqlalchemy.api.network_get_by_instance(*args, **kwargs)
nova.db.sqlalchemy.api.network_get_by_uuid(*args, **kwargs)
nova.db.sqlalchemy.api.network_set_host(*args, **kwargs)
nova.db.sqlalchemy.api.network_update(*args, **kwargs)
nova.db.sqlalchemy.api.project_add_member(context, project_id, user_id)
nova.db.sqlalchemy.api.project_create(_context, values)
nova.db.sqlalchemy.api.project_delete(context, id)
nova.db.sqlalchemy.api.project_get(context, id, session=None)
nova.db.sqlalchemy.api.project_get_all(context)
nova.db.sqlalchemy.api.project_get_by_user(context, user_id)
nova.db.sqlalchemy.api.project_get_networks(*args, **kwargs)
nova.db.sqlalchemy.api.project_get_networks_v6(*args, **kwargs)
nova.db.sqlalchemy.api.project_remove_member(context, project_id, user_id)
nova.db.sqlalchemy.api.project_update(context, project_id, values)
nova.db.sqlalchemy.api.provider_fw_rule_create(*args, **kwargs)
nova.db.sqlalchemy.api.provider_fw_rule_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.provider_fw_rule_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.provider_fw_rule_get_all_by_cidr(*args, **kwargs)
nova.db.sqlalchemy.api.queue_get_for(_context, topic, physical_node_id)
nova.db.sqlalchemy.api.quota_create(*args, **kwargs)
nova.db.sqlalchemy.api.quota_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.quota_destroy_all_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.quota_get(*args, **kwargs)
nova.db.sqlalchemy.api.quota_get_all_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.quota_update(*args, **kwargs)
nova.db.sqlalchemy.api.require_admin_context(f)

Decorator to require admin request context.

The first argument to the wrapped function must be the context.

nova.db.sqlalchemy.api.require_context(f)

Decorator to require any user or admin context.

This does no authorization for user or project access matching, see authorize_project_context() and authorize_user_context().

The first argument to the wrapped function must be the context.

nova.db.sqlalchemy.api.require_instance_exists(f)

Decorator to require the specified instance to exist.

Requres the wrapped function to use context and instance_id as their first two arguments.

nova.db.sqlalchemy.api.require_volume_exists(f)

Decorator to require the specified volume to exist.

Requres the wrapped function to use context and volume_id as their first two arguments.

nova.db.sqlalchemy.api.security_group_count_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_create(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_destroy_all(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_exists(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_get(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_get_by_instance(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_get_by_name(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_get_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_rule_count_by_group(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_rule_create(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_rule_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_rule_get(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_rule_get_by_security_group(*args, **kwargs)
nova.db.sqlalchemy.api.security_group_rule_get_by_security_group_grantee(*args, **kwargs)
nova.db.sqlalchemy.api.service_create(*args, **kwargs)
nova.db.sqlalchemy.api.service_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.service_get(*args, **kwargs)
nova.db.sqlalchemy.api.service_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.service_get_all_by_host(*args, **kwargs)
nova.db.sqlalchemy.api.service_get_all_by_topic(*args, **kwargs)
nova.db.sqlalchemy.api.service_get_all_compute_by_host(*args, **kwargs)
nova.db.sqlalchemy.api.service_get_all_compute_sorted(*args, **kwargs)
nova.db.sqlalchemy.api.service_get_all_network_sorted(*args, **kwargs)
nova.db.sqlalchemy.api.service_get_all_volume_sorted(*args, **kwargs)
nova.db.sqlalchemy.api.service_get_by_args(*args, **kwargs)
nova.db.sqlalchemy.api.service_get_by_host_and_topic(*args, **kwargs)
nova.db.sqlalchemy.api.service_update(*args, **kwargs)
nova.db.sqlalchemy.api.snapshot_create(*args, **kwargs)
nova.db.sqlalchemy.api.snapshot_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.snapshot_get(*args, **kwargs)
nova.db.sqlalchemy.api.snapshot_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.snapshot_get_all_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.snapshot_update(*args, **kwargs)
nova.db.sqlalchemy.api.user_add_project_role(context, user_id, project_id, role)
nova.db.sqlalchemy.api.user_add_role(context, user_id, role)
nova.db.sqlalchemy.api.user_create(*args, **kwargs)
nova.db.sqlalchemy.api.user_delete(*args, **kwargs)
nova.db.sqlalchemy.api.user_get(*args, **kwargs)
nova.db.sqlalchemy.api.user_get_all(context)
nova.db.sqlalchemy.api.user_get_by_access_key(*args, **kwargs)
nova.db.sqlalchemy.api.user_get_roles(context, user_id)
nova.db.sqlalchemy.api.user_get_roles_for_project(context, user_id, project_id)
nova.db.sqlalchemy.api.user_remove_project_role(context, user_id, project_id, role)
nova.db.sqlalchemy.api.user_remove_role(context, user_id, role)
nova.db.sqlalchemy.api.user_update(context, user_id, values)
nova.db.sqlalchemy.api.virtual_interface_create(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_delete(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_delete_by_instance(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_get(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_get_by_address(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_get_by_fixed_ip(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_get_by_instance(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_get_by_instance_and_network(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_get_by_network(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_get_by_uuid(*args, **kwargs)
nova.db.sqlalchemy.api.virtual_interface_update(*args, **kwargs)
nova.db.sqlalchemy.api.volume_allocate_iscsi_target(*args, **kwargs)
nova.db.sqlalchemy.api.volume_allocate_shelf_and_blade(*args, **kwargs)
nova.db.sqlalchemy.api.volume_attached(*args, **kwargs)
nova.db.sqlalchemy.api.volume_create(*args, **kwargs)
nova.db.sqlalchemy.api.volume_data_get_for_project(*args, **kwargs)
nova.db.sqlalchemy.api.volume_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.volume_detached(*args, **kwargs)
nova.db.sqlalchemy.api.volume_get(*args, **kwargs)
nova.db.sqlalchemy.api.volume_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.volume_get_all_by_host(*args, **kwargs)
nova.db.sqlalchemy.api.volume_get_all_by_instance(*args, **kwargs)
nova.db.sqlalchemy.api.volume_get_all_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.volume_get_instance(*args, **kwargs)
nova.db.sqlalchemy.api.volume_get_iscsi_target_num(*args, **kwargs)
nova.db.sqlalchemy.api.volume_get_shelf_and_blade(*args, **kwargs)
nova.db.sqlalchemy.api.volume_metadata_delete(*args, **kwargs)
nova.db.sqlalchemy.api.volume_metadata_delete_all(*args, **kwargs)
nova.db.sqlalchemy.api.volume_metadata_get(*args, **kwargs)
nova.db.sqlalchemy.api.volume_metadata_get_item(*args, **kwargs)
nova.db.sqlalchemy.api.volume_metadata_update(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_create(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_extra_specs_delete(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_extra_specs_get(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_extra_specs_get_item(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_extra_specs_update_or_create(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_get(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_get_by_name(*args, **kwargs)
nova.db.sqlalchemy.api.volume_type_purge(*args, **kwargs)
nova.db.sqlalchemy.api.volume_update(*args, **kwargs)
nova.db.sqlalchemy.api.vsa_create(*args, **kwargs)
nova.db.sqlalchemy.api.vsa_destroy(*args, **kwargs)
nova.db.sqlalchemy.api.vsa_get(*args, **kwargs)
nova.db.sqlalchemy.api.vsa_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.vsa_get_all_by_project(*args, **kwargs)
nova.db.sqlalchemy.api.vsa_update(*args, **kwargs)
nova.db.sqlalchemy.api.zone_create(*args, **kwargs)
nova.db.sqlalchemy.api.zone_delete(*args, **kwargs)
nova.db.sqlalchemy.api.zone_get(*args, **kwargs)
nova.db.sqlalchemy.api.zone_get_all(*args, **kwargs)
nova.db.sqlalchemy.api.zone_update(*args, **kwargs)