Previous topic

The cinder.db.migration Module

Next topic

The cinder.db.sqlalchemy.migrate_repo.manage Module

This Page

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

The cinder.db.sqlalchemy.api Module

Implementation of SQLAlchemy backend.

authorize_project_context(context, project_id)

Ensures a request has permission to access the given project.

authorize_quota_class_context(context, class_name)

Ensures a request has permission to access the given quota class.

authorize_user_context(context, user_id)

Ensures a request has permission to access the given user.

exact_filter(query, model, filters, legal_keys)

Applies exact match filtering to a query.

Returns the updated query. Modifies filters argument to remove filters consumed.

Parameters:
  • query – query to apply filters to
  • model – model object the query applies to, for IN-style filtering
  • filters – dictionary of filters; values that are lists, tuples, sets, or frozensets cause an ‘IN’ test to be performed, while exact matching (‘==’ operator) is used for other values
  • legal_keys – list of keys to apply exact filtering to
is_admin_context(context)

Indicates if the request context is an administrator.

is_user_context(context)

Indicates if the request context is a normal user.

iscsi_target_count_by_host(*args, **kwargs)
iscsi_target_create_safe(*args, **kwargs)
migration_create(*args, **kwargs)
migration_get(*args, **kwargs)
migration_get_all_unconfirmed(*args, **kwargs)
migration_get_by_instance_and_status(*args, **kwargs)
migration_update(*args, **kwargs)
model_query(context, *args, **kwargs)

Query helper that accounts for context’s read_deleted field.

Parameters:
  • context – context to query under
  • session – if present, the session to use
  • read_deleted – if present, overrides context’s read_deleted field.
  • project_only – if present and context is user-type, then restrict query to match the context’s project_id.
quota_class_create(*args, **kwargs)
quota_class_destroy(*args, **kwargs)
quota_class_destroy_all_by_name(*args, **kwargs)
quota_class_get(*args, **kwargs)
quota_class_get_all_by_name(*args, **kwargs)
quota_class_update(*args, **kwargs)
quota_create(*args, **kwargs)
quota_destroy(*args, **kwargs)
quota_destroy_all_by_project(*args, **kwargs)
quota_get(*args, **kwargs)
quota_get_all_by_project(*args, **kwargs)
quota_reserve(*args, **kwargs)
quota_update(*args, **kwargs)
quota_usage_create(*args, **kwargs)
quota_usage_destroy(*args, **kwargs)
quota_usage_get(*args, **kwargs)
quota_usage_get_all_by_project(*args, **kwargs)
quota_usage_update(*args, **kwargs)
require_admin_context(f)

Decorator to require admin request context.

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

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.

require_volume_exists(f)

Decorator to require the specified volume to exist.

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

reservation_commit(*args, **kwargs)
reservation_create(*args, **kwargs)
reservation_destroy(*args, **kwargs)
reservation_expire(*args, **kwargs)
reservation_get(*args, **kwargs)
reservation_get_all_by_project(*args, **kwargs)
reservation_rollback(*args, **kwargs)
service_create(*args, **kwargs)
service_destroy(*args, **kwargs)
service_get(*args, **kwargs)
service_get_all(*args, **kwargs)
service_get_all_by_host(*args, **kwargs)
service_get_all_by_topic(*args, **kwargs)
service_get_all_volume_sorted(*args, **kwargs)
service_get_by_args(*args, **kwargs)
service_get_by_host_and_topic(*args, **kwargs)
service_update(*args, **kwargs)
sm_backend_conf_create(*args, **kwargs)
sm_backend_conf_delete(*args, **kwargs)
sm_backend_conf_get(*args, **kwargs)
sm_backend_conf_get_all(*args, **kwargs)
sm_backend_conf_get_by_sr(*args, **kwargs)
sm_backend_conf_update(*args, **kwargs)
sm_flavor_create(*args, **kwargs)
sm_flavor_delete(*args, **kwargs)
sm_flavor_get(*args, **kwargs)
sm_flavor_get_all(*args, **kwargs)
sm_flavor_update(*args, **kwargs)
sm_volume_create(context, values)
sm_volume_delete(context, volume_id)
sm_volume_get(context, volume_id)
sm_volume_get_all(context)
sm_volume_update(context, volume_id, values)
snapshot_create(*args, **kwargs)
snapshot_destroy(*args, **kwargs)
snapshot_get(*args, **kwargs)
snapshot_get_all(*args, **kwargs)
snapshot_get_all_by_project(*args, **kwargs)
snapshot_get_all_for_volume(*args, **kwargs)
snapshot_update(*args, **kwargs)
volume_allocate_iscsi_target(*args, **kwargs)
volume_attached(*args, **kwargs)
volume_create(*args, **kwargs)
volume_data_get_for_project(*args, **kwargs)
volume_destroy(*args, **kwargs)
volume_detached(*args, **kwargs)
volume_get(*args, **kwargs)
volume_get_active_by_window(*args, **kwargs)
volume_get_all(*args, **kwargs)
volume_get_all_by_host(*args, **kwargs)
volume_get_all_by_instance_uuid(*args, **kwargs)
volume_get_all_by_project(*args, **kwargs)
volume_get_iscsi_target_num(*args, **kwargs)
volume_metadata_delete(*args, **kwargs)
volume_metadata_get(*args, **kwargs)
volume_metadata_get_item(*args, **kwargs)
volume_metadata_update(*args, **kwargs)
volume_type_create(*args, **kwargs)
volume_type_destroy(*args, **kwargs)
volume_type_extra_specs_delete(*args, **kwargs)
volume_type_extra_specs_get(*args, **kwargs)
volume_type_extra_specs_get_item(*args, **kwargs)
volume_type_extra_specs_update_or_create(*args, **kwargs)
volume_type_get(*args, **kwargs)
volume_type_get_all(*args, **kwargs)
volume_type_get_by_name(*args, **kwargs)
volume_update(*args, **kwargs)