1047 lines
36 KiB
Python
1047 lines
36 KiB
Python
# Copyright (c) 2011 X.commerce, a business unit of eBay Inc.
|
|
# Copyright 2010 United States Government as represented by the
|
|
# Administrator of the National Aeronautics and Space Administration.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
"""Defines interface for DB access.
|
|
|
|
The underlying driver is loaded as a :class:`LazyPluggable`.
|
|
|
|
Functions in this module are imported into the manila.db namespace. Call these
|
|
functions from manila.db namespace, not the manila.db.api namespace.
|
|
|
|
All functions in this module return objects that implement a dictionary-like
|
|
interface. Currently, many of these objects are sqlalchemy objects that
|
|
implement a dictionary interface. However, a future goal is to have all of
|
|
these objects be simple dictionaries.
|
|
|
|
|
|
**Related Flags**
|
|
|
|
:backend: string to lookup in the list of LazyPluggable backends.
|
|
`sqlalchemy` is the only supported backend right now.
|
|
|
|
:connection: string specifying the sqlalchemy connection to use, like:
|
|
`sqlite:///var/lib/manila/manila.sqlite`.
|
|
|
|
:enable_new_services: when adding a new service to the database, is it in the
|
|
pool of available hardware (Default: True)
|
|
|
|
"""
|
|
from oslo_config import cfg
|
|
from oslo_db import api as db_api
|
|
|
|
db_opts = [
|
|
cfg.StrOpt('db_backend',
|
|
default='sqlalchemy',
|
|
help='The backend to use for database.'),
|
|
cfg.BoolOpt('enable_new_services',
|
|
default=True,
|
|
help='Services to be added to the available pool on create.'),
|
|
cfg.StrOpt('share_name_template',
|
|
default='share-%s',
|
|
help='Template string to be used to generate share names.'),
|
|
cfg.StrOpt('share_snapshot_name_template',
|
|
default='share-snapshot-%s',
|
|
help='Template string to be used to generate share snapshot '
|
|
'names.'),
|
|
]
|
|
|
|
CONF = cfg.CONF
|
|
CONF.register_opts(db_opts)
|
|
|
|
_BACKEND_MAPPING = {'sqlalchemy': 'manila.db.sqlalchemy.api'}
|
|
IMPL = db_api.DBAPI.from_config(cfg.CONF, backend_mapping=_BACKEND_MAPPING,
|
|
lazy=True)
|
|
|
|
|
|
def authorize_project_context(context, project_id):
|
|
"""Ensures a request has permission to access the given project."""
|
|
return IMPL.authorize_project_context(context, project_id)
|
|
|
|
|
|
def authorize_quota_class_context(context, class_name):
|
|
"""Ensures a request has permission to access the given quota class."""
|
|
return IMPL.authorize_quota_class_context(context, class_name)
|
|
|
|
|
|
###################
|
|
|
|
|
|
def service_destroy(context, service_id):
|
|
"""Destroy the service or raise if it does not exist."""
|
|
return IMPL.service_destroy(context, service_id)
|
|
|
|
|
|
def service_get(context, service_id):
|
|
"""Get a service or raise if it does not exist."""
|
|
return IMPL.service_get(context, service_id)
|
|
|
|
|
|
def service_get_by_host_and_topic(context, host, topic):
|
|
"""Get a service by host it's on and topic it listens to."""
|
|
return IMPL.service_get_by_host_and_topic(context, host, topic)
|
|
|
|
|
|
def service_get_all(context, disabled=None):
|
|
"""Get all services."""
|
|
return IMPL.service_get_all(context, disabled)
|
|
|
|
|
|
def service_get_all_by_topic(context, topic):
|
|
"""Get all services for a given topic."""
|
|
return IMPL.service_get_all_by_topic(context, topic)
|
|
|
|
|
|
def service_get_all_share_sorted(context):
|
|
"""Get all share services sorted by share count.
|
|
|
|
:returns: a list of (Service, share_count) tuples.
|
|
|
|
"""
|
|
return IMPL.service_get_all_share_sorted(context)
|
|
|
|
|
|
def service_get_by_args(context, host, binary):
|
|
"""Get the state of an service by node name and binary."""
|
|
return IMPL.service_get_by_args(context, host, binary)
|
|
|
|
|
|
def service_create(context, values):
|
|
"""Create a service from the values dictionary."""
|
|
return IMPL.service_create(context, values)
|
|
|
|
|
|
def service_update(context, service_id, values):
|
|
"""Set the given properties on an service and update it.
|
|
|
|
Raises NotFound if service does not exist.
|
|
|
|
"""
|
|
return IMPL.service_update(context, service_id, values)
|
|
|
|
|
|
####################
|
|
|
|
|
|
def quota_create(context, project_id, resource, limit, user_id=None):
|
|
"""Create a quota for the given project and resource."""
|
|
return IMPL.quota_create(context, project_id, resource, limit,
|
|
user_id=user_id)
|
|
|
|
|
|
def quota_get(context, project_id, resource, user_id=None):
|
|
"""Retrieve a quota or raise if it does not exist."""
|
|
return IMPL.quota_get(context, project_id, resource, user_id=user_id)
|
|
|
|
|
|
def quota_get_all_by_project_and_user(context, project_id, user_id):
|
|
"""Retrieve all quotas associated with a given project and user."""
|
|
return IMPL.quota_get_all_by_project_and_user(context, project_id, user_id)
|
|
|
|
|
|
def quota_get_all_by_project(context, project_id):
|
|
"""Retrieve all quotas associated with a given project."""
|
|
return IMPL.quota_get_all_by_project(context, project_id)
|
|
|
|
|
|
def quota_get_all(context, project_id):
|
|
"""Retrieve all user quotas associated with a given project."""
|
|
return IMPL.quota_get_all(context, project_id)
|
|
|
|
|
|
def quota_update(context, project_id, resource, limit, user_id=None):
|
|
"""Update a quota or raise if it does not exist."""
|
|
return IMPL.quota_update(context, project_id, resource, limit,
|
|
user_id=user_id)
|
|
|
|
|
|
###################
|
|
|
|
|
|
def quota_class_create(context, class_name, resource, limit):
|
|
"""Create a quota class for the given name and resource."""
|
|
return IMPL.quota_class_create(context, class_name, resource, limit)
|
|
|
|
|
|
def quota_class_get(context, class_name, resource):
|
|
"""Retrieve a quota class or raise if it does not exist."""
|
|
return IMPL.quota_class_get(context, class_name, resource)
|
|
|
|
|
|
def quota_class_get_default(context):
|
|
"""Retrieve all default quotas."""
|
|
return IMPL.quota_class_get_default(context)
|
|
|
|
|
|
def quota_class_get_all_by_name(context, class_name):
|
|
"""Retrieve all quotas associated with a given quota class."""
|
|
return IMPL.quota_class_get_all_by_name(context, class_name)
|
|
|
|
|
|
def quota_class_update(context, class_name, resource, limit):
|
|
"""Update a quota class or raise if it does not exist."""
|
|
return IMPL.quota_class_update(context, class_name, resource, limit)
|
|
|
|
|
|
###################
|
|
|
|
|
|
def quota_usage_get(context, project_id, resource, user_id=None):
|
|
"""Retrieve a quota usage or raise if it does not exist."""
|
|
return IMPL.quota_usage_get(context, project_id, resource, user_id=user_id)
|
|
|
|
|
|
def quota_usage_get_all_by_project_and_user(context, project_id, user_id):
|
|
"""Retrieve all usage associated with a given resource."""
|
|
return IMPL.quota_usage_get_all_by_project_and_user(context,
|
|
project_id, user_id)
|
|
|
|
|
|
def quota_usage_get_all_by_project(context, project_id):
|
|
"""Retrieve all usage associated with a given resource."""
|
|
return IMPL.quota_usage_get_all_by_project(context, project_id)
|
|
|
|
|
|
def quota_usage_create(context, project_id, user_id, resource, in_use,
|
|
reserved=0, until_refresh=None):
|
|
"""Create a quota usage."""
|
|
return IMPL.quota_usage_create(context, project_id, user_id, resource,
|
|
in_use, reserved, until_refresh)
|
|
|
|
|
|
def quota_usage_update(context, project_id, user_id, resource, **kwargs):
|
|
"""Update a quota usage or raise if it does not exist."""
|
|
return IMPL.quota_usage_update(context, project_id, user_id, resource,
|
|
**kwargs)
|
|
|
|
|
|
###################
|
|
|
|
|
|
def quota_reserve(context, resources, quotas, user_quotas, deltas, expire,
|
|
until_refresh, max_age, project_id=None, user_id=None):
|
|
"""Check quotas and create appropriate reservations."""
|
|
return IMPL.quota_reserve(context, resources, quotas, user_quotas, deltas,
|
|
expire, until_refresh, max_age,
|
|
project_id=project_id, user_id=user_id)
|
|
|
|
|
|
def reservation_commit(context, reservations, project_id=None, user_id=None):
|
|
"""Commit quota reservations."""
|
|
return IMPL.reservation_commit(context, reservations,
|
|
project_id=project_id,
|
|
user_id=user_id)
|
|
|
|
|
|
def reservation_rollback(context, reservations, project_id=None, user_id=None):
|
|
"""Roll back quota reservations."""
|
|
return IMPL.reservation_rollback(context, reservations,
|
|
project_id=project_id,
|
|
user_id=user_id)
|
|
|
|
|
|
def quota_destroy_all_by_project_and_user(context, project_id, user_id):
|
|
"""Destroy all quotas associated with a given project and user."""
|
|
return IMPL.quota_destroy_all_by_project_and_user(context,
|
|
project_id, user_id)
|
|
|
|
|
|
def quota_destroy_all_by_project(context, project_id):
|
|
"""Destroy all quotas associated with a given project."""
|
|
return IMPL.quota_destroy_all_by_project(context, project_id)
|
|
|
|
|
|
def reservation_expire(context):
|
|
"""Roll back any expired reservations."""
|
|
return IMPL.reservation_expire(context)
|
|
|
|
|
|
###################
|
|
|
|
|
|
def share_instance_get(context, instance_id, with_share_data=False):
|
|
"""Get share instance by id."""
|
|
return IMPL.share_instance_get(context, instance_id,
|
|
with_share_data=with_share_data)
|
|
|
|
|
|
def share_instance_create(context, share_id, values):
|
|
"""Create new share instance."""
|
|
return IMPL.share_instance_create(context, share_id, values)
|
|
|
|
|
|
def share_instance_delete(context, instance_id):
|
|
"""Delete share instance."""
|
|
return IMPL.share_instance_delete(context, instance_id)
|
|
|
|
|
|
def share_instance_update(context, instance_id, values, with_share_data=False):
|
|
"""Update share instance fields."""
|
|
return IMPL.share_instance_update(context, instance_id, values,
|
|
with_share_data=with_share_data)
|
|
|
|
|
|
def share_instances_get_all(context):
|
|
"""Returns all share instances."""
|
|
return IMPL.share_instances_get_all(context)
|
|
|
|
|
|
def share_instances_get_all_by_share_server(context, share_server_id):
|
|
"""Returns all share instances with given share_server_id."""
|
|
return IMPL.share_instances_get_all_by_share_server(context,
|
|
share_server_id)
|
|
|
|
|
|
def share_instances_get_all_by_host(context, host):
|
|
"""Returns all share instances with given host."""
|
|
return IMPL.share_instances_get_all_by_host(context, host)
|
|
|
|
|
|
def share_instances_get_all_by_share_network(context, share_network_id):
|
|
"""Returns list of shares that belong to given share network."""
|
|
return IMPL.share_instances_get_all_by_share_network(context,
|
|
share_network_id)
|
|
|
|
|
|
def share_instances_get_all_by_share(context, share_id):
|
|
"""Returns list of shares that belong to given share."""
|
|
return IMPL.share_instances_get_all_by_share(context, share_id)
|
|
|
|
|
|
def share_instances_get_all_by_consistency_group_id(context, cg_id):
|
|
"""Returns list of share instances that belong to given cg."""
|
|
return IMPL.share_instances_get_all_by_consistency_group_id(context, cg_id)
|
|
|
|
###################
|
|
|
|
|
|
def share_create(context, share_values, create_share_instance=True):
|
|
"""Create new share."""
|
|
return IMPL.share_create(context, share_values,
|
|
create_share_instance=create_share_instance)
|
|
|
|
|
|
def share_update(context, share_id, values):
|
|
"""Update share fields."""
|
|
return IMPL.share_update(context, share_id, values)
|
|
|
|
|
|
def share_get(context, share_id):
|
|
"""Get share by id."""
|
|
return IMPL.share_get(context, share_id)
|
|
|
|
|
|
def share_get_all(context, filters=None, sort_key=None, sort_dir=None):
|
|
"""Get all shares."""
|
|
return IMPL.share_get_all(
|
|
context, filters=filters, sort_key=sort_key, sort_dir=sort_dir,
|
|
)
|
|
|
|
|
|
def share_get_all_by_project(context, project_id, filters=None,
|
|
is_public=False, sort_key=None, sort_dir=None):
|
|
"""Returns all shares with given project ID."""
|
|
return IMPL.share_get_all_by_project(
|
|
context, project_id, filters=filters, is_public=is_public,
|
|
sort_key=sort_key, sort_dir=sort_dir,
|
|
)
|
|
|
|
|
|
def share_get_all_by_consistency_group_id(context, cg_id,
|
|
filters=None, sort_key=None,
|
|
sort_dir=None):
|
|
"""Returns all shares with given project ID and CG id."""
|
|
return IMPL.share_get_all_by_consistency_group_id(
|
|
context, cg_id, filters=filters,
|
|
sort_key=sort_key, sort_dir=sort_dir)
|
|
|
|
|
|
def share_get_all_by_share_server(context, share_server_id, filters=None,
|
|
sort_key=None, sort_dir=None):
|
|
"""Returns all shares with given share server ID."""
|
|
return IMPL.share_get_all_by_share_server(
|
|
context, share_server_id, filters=filters, sort_key=sort_key,
|
|
sort_dir=sort_dir,
|
|
)
|
|
|
|
|
|
def share_delete(context, share_id):
|
|
"""Delete share."""
|
|
return IMPL.share_delete(context, share_id)
|
|
|
|
|
|
###################
|
|
|
|
|
|
def share_access_create(context, values):
|
|
"""Allow access to share."""
|
|
return IMPL.share_access_create(context, values)
|
|
|
|
|
|
def share_instance_access_copy(context, share_id, instance_id):
|
|
"""Maps the existing access rules for the share to the instance in the DB.
|
|
|
|
Adds the instance mapping to the share's access rules and
|
|
returns the share's access rules.
|
|
"""
|
|
return IMPL.share_instance_access_copy(context, share_id, instance_id)
|
|
|
|
|
|
def share_access_get(context, access_id):
|
|
"""Get share access rule."""
|
|
return IMPL.share_access_get(context, access_id)
|
|
|
|
|
|
def share_instance_access_get(context, access_id, instance_id):
|
|
"""Get access rule mapping for share instance."""
|
|
return IMPL.share_instance_access_get(context, access_id, instance_id)
|
|
|
|
|
|
def share_access_get_all_for_share(context, share_id):
|
|
"""Get all access rules for given share."""
|
|
return IMPL.share_access_get_all_for_share(context, share_id)
|
|
|
|
|
|
def share_access_get_all_for_instance(context, instance_id, session=None):
|
|
"""Get all access rules related to a certain share instance."""
|
|
return IMPL.share_access_get_all_for_instance(
|
|
context, instance_id, session=None)
|
|
|
|
|
|
def share_access_get_all_by_type_and_access(context, share_id, access_type,
|
|
access):
|
|
"""Returns share access by given type and access."""
|
|
return IMPL.share_access_get_all_by_type_and_access(
|
|
context, share_id, access_type, access)
|
|
|
|
|
|
def share_access_delete(context, access_id):
|
|
"""Deny access to share."""
|
|
return IMPL.share_access_delete(context, access_id)
|
|
|
|
|
|
def share_instance_access_delete(context, mapping_id):
|
|
"""Deny access to share instance."""
|
|
return IMPL.share_instance_access_delete(context, mapping_id)
|
|
|
|
|
|
def share_instance_update_access_status(context, share_instance_id, status):
|
|
"""Update access rules status of share instance."""
|
|
return IMPL.share_instance_update_access_status(context, share_instance_id,
|
|
status)
|
|
|
|
|
|
####################
|
|
|
|
|
|
def share_snapshot_instance_update(context, instance_id, values):
|
|
"""Set the given properties on a share snapshot instance and update it.
|
|
|
|
Raises NotFound if snapshot instance does not exist.
|
|
"""
|
|
return IMPL.share_snapshot_instance_update(context, instance_id, values)
|
|
|
|
|
|
def share_snapshot_instance_create(context, snapshot_id, values):
|
|
"""Create a share snapshot instance for an existing snapshot."""
|
|
return IMPL.share_snapshot_instance_create(
|
|
context, snapshot_id, values)
|
|
|
|
|
|
def share_snapshot_instance_get(context, instance_id, with_share_data=False):
|
|
"""Get a snapshot instance or raise a NotFound exception."""
|
|
return IMPL.share_snapshot_instance_get(
|
|
context, instance_id, with_share_data=with_share_data)
|
|
|
|
|
|
def share_snapshot_instance_get_all_with_filters(context, filters,
|
|
with_share_data=False):
|
|
"""Get all snapshot instances satisfying provided filters."""
|
|
return IMPL.share_snapshot_instance_get_all_with_filters(
|
|
context, filters, with_share_data=with_share_data)
|
|
|
|
|
|
def share_snapshot_instance_delete(context, snapshot_instance_id):
|
|
"""Delete a share snapshot instance."""
|
|
return IMPL.share_snapshot_instance_delete(context, snapshot_instance_id)
|
|
|
|
|
|
####################
|
|
|
|
|
|
def share_snapshot_create(context, values):
|
|
"""Create a snapshot from the values dictionary."""
|
|
return IMPL.share_snapshot_create(context, values)
|
|
|
|
|
|
def share_snapshot_get(context, snapshot_id):
|
|
"""Get a snapshot or raise if it does not exist."""
|
|
return IMPL.share_snapshot_get(context, snapshot_id)
|
|
|
|
|
|
def share_snapshot_get_all(context, filters=None, sort_key=None,
|
|
sort_dir=None):
|
|
"""Get all snapshots."""
|
|
return IMPL.share_snapshot_get_all(
|
|
context, filters=filters, sort_key=sort_key, sort_dir=sort_dir,
|
|
)
|
|
|
|
|
|
def share_snapshot_get_all_by_project(context, project_id, filters=None,
|
|
sort_key=None, sort_dir=None):
|
|
"""Get all snapshots belonging to a project."""
|
|
return IMPL.share_snapshot_get_all_by_project(
|
|
context, project_id, filters=filters, sort_key=sort_key,
|
|
sort_dir=sort_dir,
|
|
)
|
|
|
|
|
|
def share_snapshot_get_all_for_share(context, share_id, filters=None,
|
|
sort_key=None, sort_dir=None):
|
|
"""Get all snapshots for a share."""
|
|
return IMPL.share_snapshot_get_all_for_share(
|
|
context, share_id, filters=filters, sort_key=sort_key,
|
|
sort_dir=sort_dir,
|
|
)
|
|
|
|
|
|
def share_snapshot_update(context, snapshot_id, values):
|
|
"""Set the given properties on an snapshot and update it.
|
|
|
|
Raises NotFound if snapshot does not exist.
|
|
"""
|
|
return IMPL.share_snapshot_update(context, snapshot_id, values)
|
|
|
|
|
|
###################
|
|
def security_service_create(context, values):
|
|
"""Create security service DB record."""
|
|
return IMPL.security_service_create(context, values)
|
|
|
|
|
|
def security_service_delete(context, id):
|
|
"""Delete security service DB record."""
|
|
return IMPL.security_service_delete(context, id)
|
|
|
|
|
|
def security_service_update(context, id, values):
|
|
"""Update security service DB record."""
|
|
return IMPL.security_service_update(context, id, values)
|
|
|
|
|
|
def security_service_get(context, id):
|
|
"""Get security service DB record."""
|
|
return IMPL.security_service_get(context, id)
|
|
|
|
|
|
def security_service_get_all(context):
|
|
"""Get all security service DB records."""
|
|
return IMPL.security_service_get_all(context)
|
|
|
|
|
|
def security_service_get_all_by_project(context, project_id):
|
|
"""Get all security service DB records for the given project."""
|
|
return IMPL.security_service_get_all_by_project(context, project_id)
|
|
|
|
|
|
####################
|
|
|
|
|
|
def share_metadata_get(context, share_id):
|
|
"""Get all metadata for a share."""
|
|
return IMPL.share_metadata_get(context, share_id)
|
|
|
|
|
|
def share_metadata_delete(context, share_id, key):
|
|
"""Delete the given metadata item."""
|
|
IMPL.share_metadata_delete(context, share_id, key)
|
|
|
|
|
|
def share_metadata_update(context, share, metadata, delete):
|
|
"""Update metadata if it exists, otherwise create it."""
|
|
IMPL.share_metadata_update(context, share, metadata, delete)
|
|
|
|
|
|
###################
|
|
|
|
def share_export_location_get_by_uuid(context, export_location_uuid):
|
|
"""Get specific export location of a share."""
|
|
return IMPL.share_export_location_get_by_uuid(
|
|
context, export_location_uuid)
|
|
|
|
|
|
def share_export_locations_get(context, share_id):
|
|
"""Get all export locations of a share."""
|
|
return IMPL.share_export_locations_get(context, share_id)
|
|
|
|
|
|
def share_export_locations_get_by_share_id(context, share_id,
|
|
include_admin_only=True):
|
|
"""Get all export locations of a share by its ID."""
|
|
return IMPL.share_export_locations_get_by_share_id(
|
|
context, share_id, include_admin_only=include_admin_only)
|
|
|
|
|
|
def share_export_locations_get_by_share_instance_id(context,
|
|
share_instance_id):
|
|
"""Get all export locations of a share instance by its ID."""
|
|
return IMPL.share_export_locations_get_by_share_instance_id(
|
|
context, share_instance_id)
|
|
|
|
|
|
def share_export_locations_update(context, share_instance_id, export_locations,
|
|
delete=True):
|
|
"""Update export locations of a share instance."""
|
|
return IMPL.share_export_locations_update(
|
|
context, share_instance_id, export_locations, delete)
|
|
|
|
|
|
####################
|
|
|
|
def export_location_metadata_get(context, export_location_uuid, session=None):
|
|
"""Get all metadata of an export location."""
|
|
return IMPL.export_location_metadata_get(
|
|
context, export_location_uuid, session=session)
|
|
|
|
|
|
def export_location_metadata_delete(context, export_location_uuid, keys,
|
|
session=None):
|
|
"""Delete metadata of an export location."""
|
|
return IMPL.export_location_metadata_delete(
|
|
context, export_location_uuid, keys, session=session)
|
|
|
|
|
|
def export_location_metadata_update(context, export_location_uuid, metadata,
|
|
delete, session=None):
|
|
"""Update metadata of an export location."""
|
|
return IMPL.export_location_metadata_update(
|
|
context, export_location_uuid, metadata, delete, session=session)
|
|
|
|
####################
|
|
|
|
|
|
def share_network_create(context, values):
|
|
"""Create a share network DB record."""
|
|
return IMPL.share_network_create(context, values)
|
|
|
|
|
|
def share_network_delete(context, id):
|
|
"""Delete a share network DB record."""
|
|
return IMPL.share_network_delete(context, id)
|
|
|
|
|
|
def share_network_update(context, id, values):
|
|
"""Update a share network DB record."""
|
|
return IMPL.share_network_update(context, id, values)
|
|
|
|
|
|
def share_network_get(context, id):
|
|
"""Get requested share network DB record."""
|
|
return IMPL.share_network_get(context, id)
|
|
|
|
|
|
def share_network_get_all(context):
|
|
"""Get all share network DB records."""
|
|
return IMPL.share_network_get_all(context)
|
|
|
|
|
|
def share_network_get_all_by_project(context, project_id):
|
|
"""Get all share network DB records for the given project."""
|
|
return IMPL.share_network_get_all_by_project(context, project_id)
|
|
|
|
|
|
def share_network_get_all_by_security_service(context, security_service_id):
|
|
"""Get all share network DB records for the given project."""
|
|
return IMPL.share_network_get_all_by_security_service(
|
|
context, security_service_id)
|
|
|
|
|
|
def share_network_add_security_service(context, id, security_service_id):
|
|
return IMPL.share_network_add_security_service(context,
|
|
id,
|
|
security_service_id)
|
|
|
|
|
|
def share_network_remove_security_service(context, id, security_service_id):
|
|
return IMPL.share_network_remove_security_service(context,
|
|
id,
|
|
security_service_id)
|
|
|
|
|
|
##################
|
|
|
|
|
|
def network_allocation_create(context, values):
|
|
"""Create a network allocation DB record."""
|
|
return IMPL.network_allocation_create(context, values)
|
|
|
|
|
|
def network_allocation_delete(context, id):
|
|
"""Delete a network allocation DB record."""
|
|
return IMPL.network_allocation_delete(context, id)
|
|
|
|
|
|
def network_allocation_update(context, id, values):
|
|
"""Update a network allocation DB record."""
|
|
return IMPL.network_allocation_update(context, id, values)
|
|
|
|
|
|
def network_allocations_get_for_share_server(context, share_server_id,
|
|
session=None, label=None):
|
|
"""Get network allocations for share server."""
|
|
return IMPL.network_allocations_get_for_share_server(
|
|
context, share_server_id, label=label, session=session)
|
|
|
|
|
|
def network_allocations_get_by_ip_address(context, ip_address):
|
|
"""Get network allocations by IP address."""
|
|
return IMPL.network_allocations_get_by_ip_address(context, ip_address)
|
|
|
|
|
|
##################
|
|
|
|
|
|
def share_server_create(context, values):
|
|
"""Create share server DB record."""
|
|
return IMPL.share_server_create(context, values)
|
|
|
|
|
|
def share_server_delete(context, id):
|
|
"""Delete share server DB record."""
|
|
return IMPL.share_server_delete(context, id)
|
|
|
|
|
|
def share_server_update(context, id, values):
|
|
"""Update share server DB record."""
|
|
return IMPL.share_server_update(context, id, values)
|
|
|
|
|
|
def share_server_get(context, id, session=None):
|
|
"""Get share server DB record by ID."""
|
|
return IMPL.share_server_get(context, id, session=session)
|
|
|
|
|
|
def share_server_get_all_by_host_and_share_net_valid(context, host,
|
|
share_net_id,
|
|
session=None):
|
|
"""Get share server DB records by host and share net not error."""
|
|
return IMPL.share_server_get_all_by_host_and_share_net_valid(
|
|
context, host, share_net_id, session=session)
|
|
|
|
|
|
def share_server_get_all(context):
|
|
"""Get all share server DB records."""
|
|
return IMPL.share_server_get_all(context)
|
|
|
|
|
|
def share_server_get_all_by_host(context, host):
|
|
"""Get all share servers related to particular host."""
|
|
return IMPL.share_server_get_all_by_host(context, host)
|
|
|
|
|
|
def share_server_get_all_unused_deletable(context, host, updated_before):
|
|
"""Get all free share servers DB records."""
|
|
return IMPL.share_server_get_all_unused_deletable(context, host,
|
|
updated_before)
|
|
|
|
|
|
def share_server_backend_details_set(context, share_server_id, server_details):
|
|
"""Create DB record with backend details."""
|
|
return IMPL.share_server_backend_details_set(context, share_server_id,
|
|
server_details)
|
|
|
|
|
|
##################
|
|
|
|
|
|
def share_type_create(context, values, projects=None):
|
|
"""Create a new share type."""
|
|
return IMPL.share_type_create(context, values, projects)
|
|
|
|
|
|
def share_type_get_all(context, inactive=False, filters=None):
|
|
"""Get all share types.
|
|
|
|
:param context: context to query under
|
|
:param inactive: Include inactive share types to the result set
|
|
:param filters: Filters for the query in the form of key/value.
|
|
:is_public: Filter share types based on visibility:
|
|
|
|
* **True**: List public share types only
|
|
* **False**: List private share types only
|
|
* **None**: List both public and private share types
|
|
|
|
:returns: list of matching share types
|
|
"""
|
|
return IMPL.share_type_get_all(context, inactive, filters)
|
|
|
|
|
|
def share_type_get(context, type_id, inactive=False, expected_fields=None):
|
|
"""Get share type by id.
|
|
|
|
:param context: context to query under
|
|
:param type_id: share type id to get.
|
|
:param inactive: Consider inactive share types when searching
|
|
:param expected_fields: Return those additional fields.
|
|
Supported fields are: projects.
|
|
:returns: share type
|
|
"""
|
|
return IMPL.share_type_get(context, type_id, inactive, expected_fields)
|
|
|
|
|
|
def share_type_get_by_name(context, name):
|
|
"""Get share type by name."""
|
|
return IMPL.share_type_get_by_name(context, name)
|
|
|
|
|
|
def share_type_access_get_all(context, type_id):
|
|
"""Get all share type access of a share type."""
|
|
return IMPL.share_type_access_get_all(context, type_id)
|
|
|
|
|
|
def share_type_access_add(context, type_id, project_id):
|
|
"""Add share type access for project."""
|
|
return IMPL.share_type_access_add(context, type_id, project_id)
|
|
|
|
|
|
def share_type_access_remove(context, type_id, project_id):
|
|
"""Remove share type access for project."""
|
|
return IMPL.share_type_access_remove(context, type_id, project_id)
|
|
|
|
|
|
def share_type_destroy(context, id):
|
|
"""Delete a share type."""
|
|
return IMPL.share_type_destroy(context, id)
|
|
|
|
|
|
####################
|
|
|
|
|
|
def share_type_extra_specs_get(context, share_type_id):
|
|
"""Get all extra specs for a share type."""
|
|
return IMPL.share_type_extra_specs_get(context, share_type_id)
|
|
|
|
|
|
def share_type_extra_specs_delete(context, share_type_id, key):
|
|
"""Delete the given extra specs item."""
|
|
return IMPL.share_type_extra_specs_delete(context, share_type_id, key)
|
|
|
|
|
|
def share_type_extra_specs_update_or_create(context, share_type_id,
|
|
extra_specs):
|
|
"""Create or update share type extra specs.
|
|
|
|
This adds or modifies the key/value pairs specified in the extra
|
|
specs dict argument.
|
|
"""
|
|
return IMPL.share_type_extra_specs_update_or_create(context,
|
|
share_type_id,
|
|
extra_specs)
|
|
|
|
|
|
def driver_private_data_get(context, entity_id, key=None, default=None):
|
|
"""Get one, list or all key-value pairs for given entity_id."""
|
|
return IMPL.driver_private_data_get(context, entity_id, key, default)
|
|
|
|
|
|
def driver_private_data_update(context, entity_id, details,
|
|
delete_existing=False):
|
|
"""Update key-value pairs for given entity_id."""
|
|
return IMPL.driver_private_data_update(context, entity_id, details,
|
|
delete_existing)
|
|
|
|
|
|
def driver_private_data_delete(context, entity_id, key=None):
|
|
"""Remove one, list or all key-value pairs for given entity_id."""
|
|
return IMPL.driver_private_data_delete(context, entity_id, key)
|
|
|
|
|
|
####################
|
|
|
|
def availability_zone_get(context, id_or_name):
|
|
"""Get availability zone by name or id."""
|
|
return IMPL.availability_zone_get(context, id_or_name)
|
|
|
|
|
|
def availability_zone_get_all(context):
|
|
"""Get all active availability zones."""
|
|
return IMPL.availability_zone_get_all(context)
|
|
|
|
|
|
####################
|
|
|
|
def consistency_group_get(context, consistency_group_id):
|
|
"""Get a consistency group or raise if it does not exist."""
|
|
return IMPL.consistency_group_get(context, consistency_group_id)
|
|
|
|
|
|
def consistency_group_get_all(context, detailed=True):
|
|
"""Get all consistency groups."""
|
|
return IMPL.consistency_group_get_all(context, detailed=detailed)
|
|
|
|
|
|
def consistency_group_create(context, values):
|
|
"""Create a consistency group from the values dictionary."""
|
|
return IMPL.consistency_group_create(context, values)
|
|
|
|
|
|
def consistency_group_get_all_by_share_server(context, share_server_id):
|
|
"""Get all consistency groups associated with a share server."""
|
|
return IMPL.consistency_group_get_all_by_share_server(context,
|
|
share_server_id)
|
|
|
|
|
|
def consistency_group_get_all_by_project(context, project_id, detailed=True):
|
|
"""Get all consistency groups belonging to a project."""
|
|
return IMPL.consistency_group_get_all_by_project(context, project_id,
|
|
detailed=detailed)
|
|
|
|
|
|
def consistency_group_update(context, consistency_group_id, values):
|
|
"""Set the given properties on a consistency group and update it.
|
|
|
|
Raises NotFound if consistency group does not exist.
|
|
"""
|
|
return IMPL.consistency_group_update(context, consistency_group_id, values)
|
|
|
|
|
|
def consistency_group_destroy(context, consistency_group_id):
|
|
"""Destroy the consistency group or raise if it does not exist."""
|
|
return IMPL.consistency_group_destroy(context, consistency_group_id)
|
|
|
|
|
|
def count_shares_in_consistency_group(context, consistency_group_id):
|
|
"""Returns the number of undeleted shares with the specified cg."""
|
|
return IMPL.count_shares_in_consistency_group(context,
|
|
consistency_group_id)
|
|
|
|
|
|
def count_cgsnapshots_in_consistency_group(context, consistency_group_id):
|
|
"""Returns the number of undeleted cgsnapshots with the specified cg."""
|
|
return IMPL.count_cgsnapshots_in_consistency_group(context,
|
|
consistency_group_id)
|
|
|
|
|
|
def count_consistency_groups_in_share_network(context, share_network_id,
|
|
session=None):
|
|
"""Returns the number of undeleted cgs with the specified share network."""
|
|
return IMPL.count_consistency_groups_in_share_network(context,
|
|
share_network_id)
|
|
|
|
|
|
def count_cgsnapshot_members_in_share(context, share_id, session=None):
|
|
"""Returns the number of cgsnapshot members linked to the share."""
|
|
return IMPL.count_cgsnapshot_members_in_share(context, share_id)
|
|
|
|
|
|
def cgsnapshot_get(context, cgsnapshot_id):
|
|
"""Get a cgsnapshot."""
|
|
return IMPL.cgsnapshot_get(context, cgsnapshot_id)
|
|
|
|
|
|
def cgsnapshot_get_all(context, detailed=True):
|
|
"""Get all cgsnapshots."""
|
|
return IMPL.cgsnapshot_get_all(context, detailed=detailed)
|
|
|
|
|
|
def cgsnapshot_get_all_by_project(context, project_id, detailed=True):
|
|
"""Get all cgsnapshots belonging to a project."""
|
|
return IMPL.cgsnapshot_get_all_by_project(context, project_id,
|
|
detailed=detailed)
|
|
|
|
|
|
def cgsnapshot_create(context, values):
|
|
"""Create a cgsnapshot from the values dictionary."""
|
|
return IMPL.cgsnapshot_create(context, values)
|
|
|
|
|
|
def cgsnapshot_update(context, cgsnapshot_id, values):
|
|
"""Set the given properties on a cgsnapshot and update it.
|
|
|
|
Raises NotFound if cgsnapshot does not exist.
|
|
"""
|
|
return IMPL.cgsnapshot_update(context, cgsnapshot_id, values)
|
|
|
|
|
|
def cgsnapshot_destroy(context, cgsnapshot_id):
|
|
"""Destroy the cgsnapshot or raise if it does not exist."""
|
|
return IMPL.cgsnapshot_destroy(context, cgsnapshot_id)
|
|
|
|
|
|
def cgsnapshot_members_get_all(context, cgsnapshot_id):
|
|
"""Return the members of a cgsnapshot."""
|
|
return IMPL.cgsnapshot_members_get_all(context, cgsnapshot_id)
|
|
|
|
|
|
def cgsnapshot_member_create(context, values):
|
|
"""Create a cgsnapshot member from the values dictionary."""
|
|
return IMPL.cgsnapshot_member_create(context, values)
|
|
|
|
|
|
def cgsnapshot_member_update(context, member_id, values):
|
|
"""Set the given properties on a cgsnapshot member and update it.
|
|
|
|
Raises NotFound if cgsnapshot member does not exist.
|
|
"""
|
|
return IMPL.cgsnapshot_member_update(context, member_id, values)
|
|
|
|
|
|
####################
|
|
|
|
def share_replicas_get_all(context, with_share_server=False,
|
|
with_share_data=False):
|
|
"""Returns all share replicas regardless of share."""
|
|
return IMPL.share_replicas_get_all(
|
|
context, with_share_server=with_share_server,
|
|
with_share_data=with_share_data)
|
|
|
|
|
|
def share_replicas_get_all_by_share(context, share_id, with_share_server=False,
|
|
with_share_data=False):
|
|
"""Returns all share replicas for a given share."""
|
|
return IMPL.share_replicas_get_all_by_share(
|
|
context, share_id, with_share_server=with_share_server,
|
|
with_share_data=with_share_data)
|
|
|
|
|
|
def share_replicas_get_available_active_replica(context, share_id,
|
|
with_share_server=False,
|
|
with_share_data=False):
|
|
"""Returns an active replica for a given share."""
|
|
return IMPL.share_replicas_get_available_active_replica(
|
|
context, share_id, with_share_server=with_share_server,
|
|
with_share_data=with_share_data)
|
|
|
|
|
|
def share_replica_get(context, replica_id, with_share_server=False,
|
|
with_share_data=False):
|
|
"""Get share replica by id."""
|
|
return IMPL.share_replica_get(
|
|
context, replica_id, with_share_server=with_share_server,
|
|
with_share_data=with_share_data)
|
|
|
|
|
|
def share_replica_update(context, share_replica_id, values,
|
|
with_share_data=False):
|
|
"""Updates a share replica with given values."""
|
|
return IMPL.share_replica_update(context, share_replica_id, values,
|
|
with_share_data=with_share_data)
|
|
|
|
|
|
def share_replica_delete(context, share_replica_id):
|
|
"""Deletes a share replica."""
|
|
return IMPL.share_replica_delete(context, share_replica_id)
|