Remove db.api wrapper

The db.api module provides a useless indirection to the only
implementation we ever had, sqlalchemy. Let's use that directly instead
of the wrapper.

Change-Id: I80353cfed801b95571523515fd3228eae45c96ae
This commit is contained in:
Thomas Herve 2016-10-19 15:59:28 +02:00
parent 1190b1bead
commit 84067dba88
32 changed files with 38 additions and 569 deletions

View File

@ -26,8 +26,7 @@ from heat.common import exception
from heat.common.i18n import _
from heat.common import messaging
from heat.common import service_utils
from heat.db import api as db_api
from heat.db import utils
from heat.db.sqlalchemy import api as db_api
from heat.objects import service as service_objects
from heat.rpc import client as rpc_client
from heat import version
@ -131,10 +130,10 @@ def do_migrate():
def purge_deleted():
"""Remove database records that have been previously soft deleted."""
utils.purge_deleted(CONF.command.age,
CONF.command.granularity,
CONF.command.project_id,
CONF.command.batch_size)
db_api.purge_deleted(CONF.command.age,
CONF.command.granularity,
CONF.command.project_id,
CONF.command.batch_size)
def do_crypt_parameters_and_properties():
@ -142,10 +141,10 @@ def do_crypt_parameters_and_properties():
ctxt = context.get_admin_context()
prev_encryption_key = CONF.command.previous_encryption_key
if CONF.command.crypt_operation == "encrypt":
utils.encrypt_parameters_and_properties(
db_api.encrypt_parameters_and_properties(
ctxt, prev_encryption_key, CONF.command.verbose_update_params)
elif CONF.command.crypt_operation == "decrypt":
utils.decrypt_parameters_and_properties(
db_api.decrypt_parameters_and_properties(
ctxt, prev_encryption_key, CONF.command.verbose_update_params)

View File

@ -31,7 +31,7 @@ from heat.common import exception
from heat.common.i18n import _LE, _LW
from heat.common import policy
from heat.common import wsgi
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.engine import clients
LOG = logging.getLogger(__name__)

View File

@ -1,470 +0,0 @@
#
# 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.
"""Interface for database access.
Usage:
>>> from heat import db
>>> db.event_get(context, event_id)
# Event object received
The underlying driver is loaded. SQLAlchemy is currently the only
supported backend.
"""
from oslo_config import cfg
from oslo_db import api
CONF = cfg.CONF
_BACKEND_MAPPING = {'sqlalchemy': 'heat.db.sqlalchemy.api'}
IMPL = api.DBAPI.from_config(CONF, backend_mapping=_BACKEND_MAPPING)
def get_engine():
return IMPL.get_engine()
def get_session():
return IMPL.get_session()
def raw_template_get(context, template_id):
return IMPL.raw_template_get(context, template_id)
def raw_template_create(context, values):
return IMPL.raw_template_create(context, values)
def raw_template_update(context, template_id, values):
return IMPL.raw_template_update(context, template_id, values)
def raw_template_delete(context, template_id):
return IMPL.raw_template_delete(context, template_id)
def raw_template_files_create(context, values):
return IMPL.raw_template_files_create(context, values)
def raw_template_files_get(context, tmpl_files_id):
return IMPL.raw_template_files_get(context, tmpl_files_id)
def resource_data_get_all(context, resource_id, data=None):
return IMPL.resource_data_get_all(context, resource_id, data)
def resource_data_get(context, resource_id, key):
return IMPL.resource_data_get(context, resource_id, key)
def resource_data_set(context, resource_id, key, value, redact=False):
return IMPL.resource_data_set(context, resource_id, key, value,
redact=redact)
def resource_data_get_by_key(context, resource_id, key):
return IMPL.resource_data_get_by_key(context, resource_id, key)
def resource_data_delete(context, resource_id, key):
"""Remove a resource_data element associated to a resource."""
return IMPL.resource_data_delete(context, resource_id, key)
def stack_tags_set(context, stack_id, tags):
return IMPL.stack_tags_set(context, stack_id, tags)
def stack_tags_delete(context, stack_id):
return IMPL.stack_tags_delete(context, stack_id)
def stack_tags_get(context, stack_id):
return IMPL.stack_tags_get(context, stack_id)
def resource_get(context, resource_id, refresh=False):
return IMPL.resource_get(context, resource_id, refresh=refresh)
def resource_get_all(context):
return IMPL.resource_get_all(context)
def resource_update(context, resource_id, values, atomic_key,
expected_engine_id=None):
return IMPL.resource_update(context, resource_id, values, atomic_key,
expected_engine_id)
def resource_update_and_save(context, resource_id, values):
return IMPL.resource_update_and_save(context, resource_id, values)
def resource_create(context, values):
return IMPL.resource_create(context, values)
def resource_delete(context, resource_id):
return IMPL.resource_delete(context, resource_id)
def resource_exchange_stacks(context, resource_id1, resource_id2):
return IMPL.resource_exchange_stacks(context, resource_id1, resource_id2)
def resource_get_all_by_stack(context, stack_id, filters=None):
return IMPL.resource_get_all_by_stack(context, stack_id, filters)
def resource_get_all_active_by_stack(context, stack_id):
return IMPL.resource_get_all_active_by_stack(context, stack_id)
def resource_get_all_by_root_stack(context, stack_id, filters=None):
return IMPL.resource_get_all_by_root_stack(context, stack_id, filters)
def engine_get_all_locked_by_stack(context, stack_id):
return IMPL.engine_get_all_locked_by_stack(context, stack_id)
def resource_purge_deleted(context, stack_id):
return IMPL.resource_purge_deleted(context, stack_id)
def resource_get_by_name_and_stack(context, resource_name, stack_id):
return IMPL.resource_get_by_name_and_stack(context,
resource_name, stack_id)
def resource_get_by_physical_resource_id(context, physical_resource_id):
return IMPL.resource_get_by_physical_resource_id(context,
physical_resource_id)
def resource_get_all_by_physical_resource_id(context, physical_resource_id):
return IMPL.resource_get_all_by_physical_resource_id(context,
physical_resource_id)
def stack_get(context, stack_id, show_deleted=False, eager_load=True):
return IMPL.stack_get(context, stack_id, show_deleted=show_deleted,
eager_load=eager_load)
def stack_get_status(context, stack_id):
return IMPL.stack_get_status(context, stack_id)
def stack_get_by_name_and_owner_id(context, stack_name, owner_id):
return IMPL.stack_get_by_name_and_owner_id(context, stack_name,
owner_id=owner_id)
def stack_get_by_name(context, stack_name):
return IMPL.stack_get_by_name(context, stack_name)
def stack_get_all(context, limit=None, sort_keys=None, marker=None,
sort_dir=None, filters=None,
show_deleted=False, show_nested=False, show_hidden=False,
tags=None, tags_any=None, not_tags=None,
not_tags_any=None, eager_load=False):
return IMPL.stack_get_all(context, limit, sort_keys,
marker, sort_dir, filters,
show_deleted, show_nested, show_hidden,
tags, tags_any, not_tags, not_tags_any,
eager_load=eager_load)
def stack_get_all_by_owner_id(context, owner_id):
return IMPL.stack_get_all_by_owner_id(context, owner_id)
def stack_get_all_by_root_owner_id(context, owner_id):
return IMPL.stack_get_all_by_root_owner_id(context, owner_id)
def stack_count_all(context, filters=None,
show_deleted=False, show_nested=False, show_hidden=False,
tags=None, tags_any=None, not_tags=None,
not_tags_any=None):
return IMPL.stack_count_all(context, filters=filters,
show_deleted=show_deleted,
show_nested=show_nested,
show_hidden=show_hidden,
tags=tags,
tags_any=tags_any,
not_tags=not_tags,
not_tags_any=not_tags_any)
def stack_create(context, values):
return IMPL.stack_create(context, values)
def stack_update(context, stack_id, values, exp_trvsl=None):
return IMPL.stack_update(context, stack_id, values, exp_trvsl=exp_trvsl)
def stack_delete(context, stack_id):
return IMPL.stack_delete(context, stack_id)
def stack_lock_create(context, stack_id, engine_id):
return IMPL.stack_lock_create(context, stack_id, engine_id)
def stack_lock_get_engine_id(context, stack_id):
return IMPL.stack_lock_get_engine_id(context, stack_id)
def stack_lock_steal(context, stack_id, old_engine_id, new_engine_id):
return IMPL.stack_lock_steal(context, stack_id, old_engine_id,
new_engine_id)
def stack_lock_release(context, stack_id, engine_id):
return IMPL.stack_lock_release(context, stack_id, engine_id)
def persist_state_and_release_lock(context, stack_id, engine_id, values):
return IMPL.persist_state_and_release_lock(context, stack_id,
engine_id, values)
def stack_get_root_id(context, stack_id):
return IMPL.stack_get_root_id(context, stack_id)
def stack_count_total_resources(context, stack_id):
return IMPL.stack_count_total_resources(context, stack_id)
def user_creds_create(context):
return IMPL.user_creds_create(context)
def user_creds_delete(context, user_creds_id):
return IMPL.user_creds_delete(context, user_creds_id)
def user_creds_get(context, user_creds_id):
return IMPL.user_creds_get(context, user_creds_id)
def event_get(context, event_id):
return IMPL.event_get(context, event_id)
def event_get_all(context):
return IMPL.event_get_all(context)
def event_get_all_by_tenant(context, limit=None, marker=None,
sort_keys=None, sort_dir=None, filters=None):
return IMPL.event_get_all_by_tenant(context,
limit=limit,
marker=marker,
sort_keys=sort_keys,
sort_dir=sort_dir,
filters=filters)
def event_get_all_by_stack(context, stack_id, limit=None, marker=None,
sort_keys=None, sort_dir=None, filters=None):
return IMPL.event_get_all_by_stack(context, stack_id,
limit=limit,
marker=marker,
sort_keys=sort_keys,
sort_dir=sort_dir,
filters=filters)
def event_count_all_by_stack(context, stack_id):
return IMPL.event_count_all_by_stack(context, stack_id)
def event_create(context, values):
return IMPL.event_create(context, values)
def watch_rule_get(context, watch_rule_id):
return IMPL.watch_rule_get(context, watch_rule_id)
def watch_rule_get_by_name(context, watch_rule_name):
return IMPL.watch_rule_get_by_name(context, watch_rule_name)
def watch_rule_get_all(context):
return IMPL.watch_rule_get_all(context)
def watch_rule_get_all_by_stack(context, stack_id):
return IMPL.watch_rule_get_all_by_stack(context, stack_id)
def watch_rule_create(context, values):
return IMPL.watch_rule_create(context, values)
def watch_rule_update(context, watch_id, values):
return IMPL.watch_rule_update(context, watch_id, values)
def watch_rule_delete(context, watch_id):
return IMPL.watch_rule_delete(context, watch_id)
def watch_data_create(context, values):
return IMPL.watch_data_create(context, values)
def watch_data_get_all(context):
return IMPL.watch_data_get_all(context)
def watch_data_get_all_by_watch_rule_id(context, watch_rule_id):
return IMPL.watch_data_get_all_by_watch_rule_id(context, watch_rule_id)
def software_config_create(context, values):
return IMPL.software_config_create(context, values)
def software_config_get(context, config_id):
return IMPL.software_config_get(context, config_id)
def software_config_get_all(context, limit=None, marker=None):
return IMPL.software_config_get_all(context,
limit=limit,
marker=marker)
def software_config_delete(context, config_id):
return IMPL.software_config_delete(context, config_id)
def software_deployment_create(context, values):
return IMPL.software_deployment_create(context, values)
def software_deployment_get(context, deployment_id):
return IMPL.software_deployment_get(context, deployment_id)
def software_deployment_get_all(context, server_id=None):
return IMPL.software_deployment_get_all(context, server_id)
def software_deployment_update(context, deployment_id, values):
return IMPL.software_deployment_update(context, deployment_id, values)
def software_deployment_delete(context, deployment_id):
return IMPL.software_deployment_delete(context, deployment_id)
def snapshot_create(context, values):
return IMPL.snapshot_create(context, values)
def snapshot_get(context, snapshot_id):
return IMPL.snapshot_get(context, snapshot_id)
def snapshot_get_by_stack(context, snapshot_id, stack):
return IMPL.snapshot_get_by_stack(context, snapshot_id, stack)
def snapshot_update(context, snapshot_id, values):
return IMPL.snapshot_update(context, snapshot_id, values)
def snapshot_delete(context, snapshot_id):
return IMPL.snapshot_delete(context, snapshot_id)
def snapshot_get_all(context, stack_id):
return IMPL.snapshot_get_all(context, stack_id)
def service_create(context, values):
return IMPL.service_create(context, values)
def service_update(context, service_id, values):
return IMPL.service_update(context, service_id, values)
def service_delete(context, service_id, soft_delete=True):
return IMPL.service_delete(context, service_id, soft_delete)
def service_get(context, service_id):
return IMPL.service_get(context, service_id)
def service_get_all(context):
return IMPL.service_get_all(context)
def service_get_all_by_args(context, host, binary, hostname):
return IMPL.service_get_all_by_args(context, host, binary, hostname)
def sync_point_delete_all_by_stack_and_traversal(context, stack_id,
traversal_id):
return IMPL.sync_point_delete_all_by_stack_and_traversal(context,
stack_id,
traversal_id)
def sync_point_create(context, values):
return IMPL.sync_point_create(context, values)
def sync_point_get(context, entity_id, traversal_id, is_update):
return IMPL.sync_point_get(context, entity_id, traversal_id, is_update)
def sync_point_update_input_data(context, entity_id,
traversal_id, is_update, atomic_key,
input_data):
return IMPL.sync_point_update_input_data(context, entity_id,
traversal_id, is_update,
atomic_key, input_data)
def db_sync(engine, version=None):
"""Migrate the database to `version` or the most recent version."""
return IMPL.db_sync(engine, version=version)
def db_version(engine):
"""Display the current database version."""
return IMPL.db_version(engine)
def reset_stack_status(context, stack_id):
return IMPL.reset_stack_status(context, stack_id)

View File

@ -15,10 +15,10 @@
import datetime
import itertools
import random
import sys
from oslo_config import cfg
from oslo_db import api as oslo_db_api
from oslo_db import options
from oslo_db.sqlalchemy import enginefacade
from oslo_db.sqlalchemy import utils
from oslo_log import log as logging
@ -50,6 +50,8 @@ CONF.import_opt('hidden_stack_tags', 'heat.common.config')
CONF.import_opt('max_events_per_stack', 'heat.common.config')
CONF.import_group('profiler', 'heat.common.config')
options.set_defaults(CONF)
_facade = None
db_context = enginefacade.transaction_context()
@ -87,11 +89,6 @@ def get_session():
return get_facade().get_session()
def get_backend():
"""The backend is this module itself."""
return sys.modules[__name__]
def update_and_save(context, obj, values):
with context.session.begin(subtransactions=True):
for k, v in six.iteritems(values):

View File

@ -1,57 +0,0 @@
#
# 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.
class LazyPluggable(object):
"""A pluggable backend loaded lazily based on some value."""
def __init__(self, pivot, **backends):
self.__backends = backends
self.__pivot = pivot
self.__backend = None
def __get_backend(self):
if not self.__backend:
backend_name = 'sqlalchemy'
backend = self.__backends[backend_name]
if isinstance(backend, tuple):
name = backend[0]
fromlist = backend[1]
else:
name = backend
fromlist = backend
self.__backend = __import__(name, None, None, fromlist)
return self.__backend
def __getattr__(self, key):
backend = self.__get_backend()
return getattr(backend, key)
IMPL = LazyPluggable('backend',
sqlalchemy='heat.db.sqlalchemy.api')
def purge_deleted(age, granularity='days', project_id=None, batch_size=20):
IMPL.purge_deleted(age, granularity, project_id, batch_size)
def encrypt_parameters_and_properties(ctxt, encryption_key, verbose):
IMPL.db_encrypt_parameters_and_properties(ctxt, encryption_key,
verbose=verbose)
def decrypt_parameters_and_properties(ctxt, encryption_key, verbose):
IMPL.db_decrypt_parameters_and_properties(ctxt, encryption_key,
verbose=verbose)

View File

@ -24,7 +24,7 @@ from heat.common import crypt
from heat.common import exception
from heat.common.i18n import _
from heat.common.i18n import _LI
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.engine import api
from heat.engine import scheduler
from heat.engine import software_config_io as swc_io

View File

@ -17,7 +17,7 @@ import weakref
from heat.common import context
from heat.common.i18n import _
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import raw_template_files
_d = weakref.WeakValueDictionary()

View File

@ -25,7 +25,7 @@ from heat.common.i18n import _LE
from heat.common.i18n import _LI
from heat.common.i18n import _LW
from heat.common import messaging as rpc_messaging
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.engine import check_resource
from heat.engine import stack as parser
from heat.engine import sync_point

View File

@ -18,7 +18,7 @@ from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.common import identifier
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields

View File

@ -25,7 +25,7 @@ from oslo_versionedobjects import fields
from heat.common import crypt
from heat.common import environment_format as env_fmt
from heat.common.i18n import _LW
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields

View File

@ -16,7 +16,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields

View File

@ -26,7 +26,7 @@ import tenacity
from heat.common import crypt
from heat.common import exception
from heat.common.i18n import _
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields
from heat.objects import resource_data

View File

@ -19,7 +19,7 @@ from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.common import exception
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base

View File

@ -17,7 +17,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base

View File

@ -18,7 +18,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields

View File

@ -18,7 +18,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields

View File

@ -18,7 +18,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields
from heat.objects import software_config

View File

@ -22,7 +22,7 @@ import six
from heat.common import exception
from heat.common.i18n import _
from heat.common import identifier
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields
from heat.objects import raw_template

View File

@ -17,7 +17,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base

View File

@ -17,7 +17,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base

View File

@ -18,7 +18,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields

View File

@ -18,7 +18,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base

View File

@ -17,7 +17,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields

View File

@ -17,7 +17,7 @@
from oslo_versionedobjects import base
from oslo_versionedobjects import fields
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.objects import base as heat_base
from heat.objects import fields as heat_fields
from heat.objects import watch_data

View File

@ -13,7 +13,7 @@
import six
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.engine import service
from heat.engine import stack
from heat.tests.convergence.framework import message_processor

View File

@ -12,7 +12,7 @@
# under the License.
from heat.common import exception
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.tests import utils

View File

@ -23,7 +23,7 @@ import six
from heat.common import crypt
from heat.common import exception
from heat.common import template_format
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.engine.clients.os import swift
from heat.engine.clients.os import zaqar
from heat.engine import service

View File

@ -23,7 +23,7 @@ from heat.common import exception
from heat.common import messaging
from heat.common import service_utils
from heat.common import template_format
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.engine.clients.os import glance
from heat.engine.clients.os import nova
from heat.engine import environment

View File

@ -15,7 +15,7 @@
import mock
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.engine import check_resource
from heat.engine import stack as parser
from heat.engine import template as templatem

View File

@ -27,7 +27,7 @@ from heat.common import exception
from heat.common.i18n import _
from heat.common import short_id
from heat.common import timeutils
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.engine import attributes
from heat.engine.cfn import functions as cfn_funcs
from heat.engine import clients

View File

@ -29,7 +29,7 @@ from heat.common import context
from heat.common import exception
from heat.common import template_format
from heat.common import timeutils
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.engine.clients.os import keystone
from heat.engine.clients.os import nova
from heat.engine import environment

View File

@ -22,7 +22,7 @@ from oslo_serialization import jsonutils
import sqlalchemy
from heat.common import context
from heat.db import api as db_api
from heat.db.sqlalchemy import api as db_api
from heat.db.sqlalchemy import models
from heat.engine import environment
from heat.engine import resource