Package coilmq :: Package store :: Package sa

Package sa

Queue storage module that uses SQLAlchemy to access queue information and frames in a database.

Author: "Hans Lellelid" <hans@xmpl.org>

License: 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.

Submodules
coilmq.store.sa.meta: Module to hold shared SQLAlchemy state. coilmq.store.sa.model: Definition of the datamodel required for SA storage backend.

Classes
	SAQueue A QueueStore implementation that stores messages in a database and uses SQLAlchemy to interface with the database.

Functions

make_sa()
Factory to creates a SQLAlchemy queue store, pulling config values from the CoilMQ configuration.

init_model(engine, create=True, drop=False)
Initializes the shared SQLAlchemy state in the coilmq.store.sa.model module.

Function Details

init_model(engine, create=True, drop=False)

Initializes the shared SQLAlchemy state in the coilmq.store.sa.model module.

Parameters:

engine (sqlalchemy.Engine) - The SQLAlchemy engine instance.
create (bool) - Whether to create the tables (if they do not exist).
drop (bool) - Whether to drop the tables (if they exist).