957cadc2f3
This patch adds two features to our current sqlalchemy driver: - option to configure connection URI for driver - Skeleton of ControlDriver written With the ControlDriver, the expected methods were stubbed out. Small fix: all controller methods not yet implemented now raise NotImplementedError. Change-Id: I1cd4a4d75cbbee7f0ff574c5be4d11660359ab7e Partially-Implements: blueprint: sql-storage-driver
103 lines
3.2 KiB
Python
103 lines
3.2 KiB
Python
# Copyright (c) 2013 Red Hat, Inc.
|
|
#
|
|
# 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.
|
|
|
|
import sqlalchemy as sa
|
|
|
|
from oslo.config import cfg
|
|
|
|
from marconi.common import decorators
|
|
from marconi.queues import storage
|
|
from marconi.queues.storage.sqlalchemy import tables
|
|
|
|
|
|
_SQLALCHEMY_OPTIONS = [
|
|
cfg.StrOpt('uri', default='sqlite:///:memory:',
|
|
help='An sqlalchemy URL')
|
|
]
|
|
|
|
_SQLALCHEMY_GROUP = 'drivers:storage:sqlalchemy'
|
|
|
|
|
|
class DataDriver(storage.DataDriverBase):
|
|
|
|
def __init__(self, conf, cache):
|
|
super(DataDriver, self).__init__(conf, cache)
|
|
|
|
self.conf.register_opts(_SQLALCHEMY_OPTIONS,
|
|
group=_SQLALCHEMY_GROUP)
|
|
self.sqlalchemy_conf = self.conf[_SQLALCHEMY_GROUP]
|
|
|
|
@decorators.lazy_property(write=False)
|
|
def engine(self, *args, **kwargs):
|
|
engine = sa.create_engine(self.sqlalchemy_conf.uri, **kwargs)
|
|
tables.metadata.create_all(engine, checkfirst=True)
|
|
return engine
|
|
|
|
# TODO(cpp-cabrera): expose connect/close as a context manager
|
|
# that acquires the connection to the DB for the desired scope and
|
|
# closes it once the operations are completed
|
|
@decorators.lazy_property(write=False)
|
|
def connection(self):
|
|
return self.engine.connect()
|
|
|
|
def close_connection(self):
|
|
self.connection.close()
|
|
|
|
@decorators.lazy_property(write=False)
|
|
def queue_controller(self):
|
|
raise NotImplementedError()
|
|
|
|
@decorators.lazy_property(write=False)
|
|
def message_controller(self):
|
|
raise NotImplementedError()
|
|
|
|
@decorators.lazy_property(write=False)
|
|
def claim_controller(self):
|
|
raise NotImplementedError()
|
|
|
|
|
|
class ControlDriver(storage.ControlDriverBase):
|
|
|
|
def __init__(self, conf, cache):
|
|
super(ControlDriver, self).__init__(conf, cache)
|
|
self.conf.register_opts(_SQLALCHEMY_OPTIONS,
|
|
group=_SQLALCHEMY_GROUP)
|
|
self.sqlalchemy_conf = self.conf[_SQLALCHEMY_GROUP]
|
|
|
|
@decorators.lazy_property(write=False)
|
|
def engine(self, *args, **kwargs):
|
|
engine = sa.create_engine(self.sqlalchemy_conf.uri, **kwargs)
|
|
tables.metadata.create_all(engine, checkfirst=True)
|
|
return engine
|
|
|
|
# TODO(cpp-cabrera): expose connect/close as a context manager
|
|
# that acquires the connection to the DB for the desired scope and
|
|
# closes it once the operations are completed
|
|
@decorators.lazy_property(write=False)
|
|
def connection(self):
|
|
return self.engine.connect()
|
|
|
|
def close_connection(self):
|
|
self.connection.close()
|
|
|
|
@property
|
|
def shards_controller(self):
|
|
raise NotImplementedError()
|
|
|
|
@property
|
|
def catalogue_controller(self):
|
|
raise NotImplementedError()
|