django.db.backends.base.creation.BaseDatabaseCreation

class documentation

class BaseDatabaseCreation: (source)

Known subclasses: django.db.backends.dummy.base.DatabaseCreation, django.db.backends.mysql.creation.DatabaseCreation, django.db.backends.oracle.creation.DatabaseCreation, django.db.backends.postgresql.creation.DatabaseCreation, django.db.backends.sqlite3.creation.DatabaseCreation

View In Hierarchy

Encapsulate backend-specific differences pertaining to creation and destruction of the test database.

Method __init__ Undocumented
Method clone_test_db Clone a test database.
Method create_test_db Create a test database, prompting the user for confirmation if the database already exists. Return the name of the test database created.
Method deserialize_db_from_string Reload the database with data from a string generated by the serialize_db_to_string() method.
Method destroy_test_db Destroy a test database, prompting the user for confirmation if the database already exists.
Method get_test_db_clone_settings Return a modified connection settings dict for the n-th clone of a DB.
Method log Undocumented
Method mark_expected_failures_and_skips Mark tests in Django's test suite which are expected failures on this database and test which should be skipped on this database.
Method serialize_db_to_string Serialize all data in the database into a JSON string. Designed only for test runner usage; will not handle large amounts of data.
Method set_as_test_mirror Set this database up to be used in testing as a mirror of a primary database whose settings are given.
Method setup_worker_connection Undocumented
Method sql_table_creation_suffix SQL to append to the end of the test table creation statements.
Method test_db_signature Return a tuple with elements of self.connection.settings_dict (a DATABASES setting value) that uniquely identify a database accordingly to the RDBMS particularities.
Instance Variable connection Undocumented
Method _clone_test_db Internal implementation - duplicate the test db tables.
Method _create_test_db Internal implementation - create the test db tables.
Method _destroy_test_db Internal implementation - remove the test db tables.
Method _execute_create_test_db Undocumented
Method _get_database_display_str Return display string for a database for use in various actions.
Method _get_test_db_name Internal implementation - return the name of the test DB that will be created. Only useful when called from create_test_db() and _create_test_db() and when no external munging is done with the 'NAME' settings.
Method _nodb_cursor Undocumented
def __init__(self, connection): (source)

Undocumented

def clone_test_db(self, suffix, verbosity=1, autoclobber=False, keepdb=False): (source)

Clone a test database.

def create_test_db(self, verbosity=1, autoclobber=False, serialize=True, keepdb=False): (source)

Create a test database, prompting the user for confirmation if the database already exists. Return the name of the test database created.

def deserialize_db_from_string(self, data): (source)

Reload the database with data from a string generated by the serialize_db_to_string() method.

def destroy_test_db(self, old_database_name=None, verbosity=1, keepdb=False, suffix=None): (source)

Destroy a test database, prompting the user for confirmation if the database already exists.

def get_test_db_clone_settings(self, suffix): (source)
overridden in django.db.backends.sqlite3.creation.DatabaseCreation

Return a modified connection settings dict for the n-th clone of a DB.

def log(self, msg): (source)

Undocumented

def mark_expected_failures_and_skips(self): (source)

Mark tests in Django's test suite which are expected failures on this database and test which should be skipped on this database.

def serialize_db_to_string(self): (source)

Serialize all data in the database into a JSON string. Designed only for test runner usage; will not handle large amounts of data.

def set_as_test_mirror(self, primary_settings_dict): (source)
overridden in django.db.backends.oracle.creation.DatabaseCreation

Set this database up to be used in testing as a mirror of a primary database whose settings are given.

def setup_worker_connection(self, _worker_id): (source)
overridden in django.db.backends.sqlite3.creation.DatabaseCreation

Undocumented

def sql_table_creation_suffix(self): (source)
overridden in django.db.backends.mysql.creation.DatabaseCreation, django.db.backends.postgresql.creation.DatabaseCreation

SQL to append to the end of the test table creation statements.

def test_db_signature(self): (source)
overridden in django.db.backends.oracle.creation.DatabaseCreation, django.db.backends.sqlite3.creation.DatabaseCreation

Return a tuple with elements of self.connection.settings_dict (a DATABASES setting value) that uniquely identify a database accordingly to the RDBMS particularities.

connection = (source)

Undocumented

def _clone_test_db(self, suffix, verbosity, keepdb=False): (source)
overridden in django.db.backends.mysql.creation.DatabaseCreation, django.db.backends.postgresql.creation.DatabaseCreation, django.db.backends.sqlite3.creation.DatabaseCreation

Internal implementation - duplicate the test db tables.

def _create_test_db(self, verbosity, autoclobber, keepdb=False): (source)
overridden in django.db.backends.oracle.creation.DatabaseCreation, django.db.backends.sqlite3.creation.DatabaseCreation

Internal implementation - create the test db tables.

def _destroy_test_db(self, test_database_name, verbosity): (source)
overridden in django.db.backends.oracle.creation.DatabaseCreation, django.db.backends.sqlite3.creation.DatabaseCreation

Internal implementation - remove the test db tables.

def _execute_create_test_db(self, cursor, parameters, keepdb=False): (source)
overridden in django.db.backends.mysql.creation.DatabaseCreation, django.db.backends.postgresql.creation.DatabaseCreation

Undocumented

def _get_database_display_str(self, verbosity, database_name): (source)

Return display string for a database for use in various actions.

def _get_test_db_name(self): (source)
overridden in django.db.backends.oracle.creation.DatabaseCreation, django.db.backends.sqlite3.creation.DatabaseCreation

Internal implementation - return the name of the test DB that will be created. Only useful when called from create_test_db() and _create_test_db() and when no external munging is done with the 'NAME' settings.

def _nodb_cursor(self): (source)

Undocumented