keystone.common.sql package

Subpackages

Submodules

keystone.common.sql.core module

SQL backends for the various services.

Before using this module, call initialize(). This has to be done before CONF() because it sets up configuration options.

class keystone.common.sql.core.DictBase[source]

Bases: oslo_db.sqlalchemy.models.ModelBase

attributes = []
classmethod from_dict(d)[source]
to_dict(include_extra_dict=False)[source]

Return the model’s attributes as a dictionary.

If include_extra_dict is True, ‘extra’ attributes are literally included in the resulting dictionary twice, for backwards-compatibility with a broken implementation.

class keystone.common.sql.core.JsonBlob(*args, **kwargs)[source]

Bases: sqlalchemy.sql.type_api.TypeDecorator

impl

alias of Text

process_bind_param(value, dialect)[source]
process_result_value(value, dialect)[source]
class keystone.common.sql.core.ModelDictMixin[source]

Bases: object

classmethod from_dict(d)[source]

Return a model instance from a dictionary.

to_dict()[source]

Return the model’s attributes as a dictionary.

keystone.common.sql.core.cleanup()[source]
keystone.common.sql.core.filter_limit_query(model, query, hints)[source]

Apply filtering and limit to a query.

Parameters:
  • model – table model
  • query – query to apply filters to
  • hints – contains the list of filters and limit details. This may be None, indicating that there are no filters or limits to be applied. If it’s not None, then any filters satisfied here will be removed so that the caller will know if any filters remain.
Returns:

updated query
keystone.common.sql.core.handle_conflicts(conflict_type='object')[source]

Convert select sqlalchemy exceptions into HTTP 409 Conflict.

keystone.common.sql.core.initialize()[source]

Initialize the module.

keystone.common.sql.core.initialize_decorator(init)[source]

Ensure that the length of string field do not exceed the limit.

This decorator check the initialize arguments, to make sure the length of string field do not exceed the length limit, or raise a ‘StringLengthExceeded’ exception.

Use decorator instead of inheritance, because the metaclass will check the __tablename__, primary key columns, etc. at the class definition.

keystone.common.sql.core.session_for_read()[source]
keystone.common.sql.core.session_for_write()[source]
keystone.common.sql.core.truncated(f)[source]

keystone.common.sql.upgrades module

class keystone.common.sql.upgrades.Repository(engine, repo_name)[source]

Bases: object

upgrade(version=None, current_schema=None)[source]
version
keystone.common.sql.upgrades.add_constraints(constraints)[source]
keystone.common.sql.upgrades.contract_schema()[source]

Contract the database.

This is run manually by the keystone-manage command once the keystone nodes have been upgraded to the latest release and will remove any old tables/columns that are no longer required.

keystone.common.sql.upgrades.expand_schema()[source]

Expand the database schema ahead of data migration.

This is run manually by the keystone-manage command before the first keystone node is migrated to the latest release.

keystone.common.sql.upgrades.find_repo(repo_name)[source]

Return the absolute path to the named repository.

keystone.common.sql.upgrades.get_constraints_names(table, column_name)[source]
keystone.common.sql.upgrades.get_db_version()[source]
keystone.common.sql.upgrades.get_init_version(abs_path=None)[source]

Get the initial version of a migrate repository.

Parameters:abs_path – Absolute path to migrate repository.
Returns:initial version number or None, if DB is empty.
keystone.common.sql.upgrades.migrate_data()[source]

Migrate data to match the new schema.

This is run manually by the keystone-manage command once the keystone schema has been expanded for the new release.

keystone.common.sql.upgrades.offline_sync_database_to_version(version=None)[source]

Perform and off-line sync of the database.

Migrate the database up to the latest version, doing the equivalent of the cycle of –expand, –migrate and –contract, for when an offline upgrade is being performed.

If a version is specified then only migrate the database up to that version. Downgrading is not supported. If version is specified, then only the main database migration is carried out - and the expand, migration and contract phases will NOT be run.

keystone.common.sql.upgrades.remove_constraints(constraints)[source]
keystone.common.sql.upgrades.rename_tables_with_constraints(renames, constraints, engine)[source]

Rename tables with foreign key constraints.

Tables are renamed after first removing constraints. The constraints are replaced after the rename is complete.

This works on databases that don’t support renaming tables that have constraints on them (DB2).

renames is a dict, mapping {‘to_table_name’: from_table, ...}

Module contents