rattail.db.config

Database Configuration

rattail.db.config.configure_session(config, session)

Configure a session factory or instance. Currently all this does is install the hook to record changes, if config so dictates.

rattail.db.config.configure_versioning(config, force=False, manager=None, plugins=None, **kwargs)

Configure Continuum versioning.

rattail.db.config.get_default_engine(config, section='rattail.db')

Fetch the default database engine defined in the given config object for a given section.

Parameters:

• config – A ConfigParser instance containing app configuration.

• section (string) – Optional section name within which the configuration options are defined. If not specified, 'rattail.db' is assumed.

Returns:

A SQLAlchemy engine instance, or None.

Note

This function calls get_engines() for the heavy lifting; see that function for more details on how the engine configuration is read.

rattail.db.config.get_engines(config, section='rattail.db')

Fetch all database engines defined within a given config section.

This is a compatibility wrapper around wuttjamaican.db.conf.get_engines(). New code should use that instead; this will eventually be removed.