django.db.backends.base.schema.BaseDatabaseSchemaEditor

class documentation

class BaseDatabaseSchemaEditor:

Known subclasses: django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.postgresql.schema.DatabaseSchemaEditor, django.db.backends.sqlite3.schema.DatabaseSchemaEditor

View In Hierarchy

This class and its subclasses are responsible for emitting schema-changing statements to the databases - model creation/removal/alteration, field renaming, index fiddling, and so on.

Method	`add_constraint`	Add a constraint to a model.
Method	`add_field`	Create a field on a model. Usually involves adding a column, but may involve adding a table instead (for M2M fields).
Method	`add_index`	Add an index on a model.
Method	`alter_db_table`	Rename the table a model points to.
Method	`alter_db_tablespace`	Move a model's table between tablespaces.
Method	`alter_field`	No summary
Method	`alter_index_together`	Deal with a model changing its index_together. The input index_togethers must be doubly-nested, not the single-nested ["foo", "bar"] format.
Method	`alter_unique_together`	Deal with a model changing its unique_together. The input unique_togethers must be doubly-nested, not the single-nested ["foo", "bar"] format.
Method	`create_model`	Create a table and any accompanying indexes or unique constraints for the given `model`.
Method	`delete_model`	Delete a model from the database.
Method	`execute`	Execute the given SQL statement, with optional parameters.
Method	`remove_constraint`	Remove a constraint from a model.
Method	`remove_field`	Remove a field from a model. Usually involves deleting a column, but for M2Ms may involve deleting a table.
Method	`remove_index`	Remove an index from a model.
Static Method	`_effective_default`	Undocumented
Method	`__enter__`	Undocumented
Method	`__exit__`	Undocumented
Method	`__init__`	Undocumented
Method	`_alter_column_collation_sql`	Undocumented
Method	`_alter_column_default_sql`	Hook to specialize column default alteration.
Method	`_alter_column_null_sql`	Hook to specialize column null alteration.
Method	`_alter_column_type_sql`	Hook to specialize column type alteration for different backends, for cases when a creation type is different to an alteration type (e.g. SERIAL in PostgreSQL, PostGIS fields).
Method	`_alter_field`	Perform a "physical" (non-ManyToMany) field update.
Method	`_alter_many_to_many`	Alter M2Ms to repoint their to= endpoints.
Method	`_check_sql`	Undocumented
Method	`_collate_sql`	Undocumented
Method	`_column_default_sql`	Return the SQL to use in a DEFAULT clause. The resulting string should contain a '%s' placeholder for a default value.
Method	`_constraint_names`	Return all constraint names matching the columns and conditions.
Method	`_create_check_sql`	Undocumented
Method	`_create_fk_sql`	Undocumented
Method	`_create_index_name`	Generate a unique name for an index/unique constraint.
Method	`_create_index_sql`	Return the SQL statement to create the index for one or several fields or expressions. `sql` can be specified if the syntax differs from the standard (GIS indexes, ...).
Method	`_create_primary_key_sql`	Undocumented
Method	`_create_unique_sql`	Undocumented
Method	`_deferrable_constraint_sql`	Undocumented
Method	`_delete_check_sql`	Undocumented
Method	`_delete_composed_index`	Undocumented
Method	`_delete_constraint_sql`	Undocumented
Method	`_delete_fk_sql`	Undocumented
Method	`_delete_index_sql`	Undocumented
Method	`_delete_primary_key`	Undocumented
Method	`_delete_primary_key_sql`	Undocumented
Method	`_delete_unique_sql`	Undocumented
Method	`_field_became_primary_key`	Undocumented
Method	`_field_indexes_sql`	Return a list of all index SQL statements for the specified field.
Method	`_field_should_be_altered`	Undocumented
Method	`_field_should_be_indexed`	Undocumented
Method	`_fk_constraint_name`	Undocumented
Method	`_get_index_tablespace_sql`	Undocumented
Method	`_index_columns`	Undocumented
Method	`_index_condition_sql`	Undocumented
Method	`_index_include_sql`	Undocumented
Method	`_iter_column_sql`	Undocumented
Method	`_model_indexes_sql`	Return a list of all index SQL statements (field indexes, index_together, Meta.indexes) for the specified model.
Method	`_rename_field_sql`	Undocumented
Method	`_unique_should_be_added`	Undocumented
Method	`_unique_sql`	Undocumented
Method	`column_sql`	Return the column definition for a field. The field must already have had set_attributes_from_name() called.
Method	`effective_default`	Return a field's effective database default value.
Method	`prepare_default`	Only used for backends which have requires_literal_defaults feature
Method	`quote_name`	Undocumented
Method	`quote_value`	No summary
Method	`remove_procedure`	Undocumented
Method	`skip_default`	Some backends don't accept default values for certain columns types (i.e. MySQL longtext and longblob).
Method	`skip_default_on_alter`	Some backends don't accept default values for certain columns types (i.e. MySQL longtext and longblob) in the ALTER COLUMN statement.
Method	`table_sql`	Take a model and return its table definition.
Class Variable	`sql_alter_column`	Undocumented
Class Variable	`sql_alter_column_collate`	Undocumented
Class Variable	`sql_alter_column_default`	Undocumented
Class Variable	`sql_alter_column_no_default`	Undocumented
Class Variable	`sql_alter_column_not_null`	Undocumented
Class Variable	`sql_alter_column_null`	Undocumented
Class Variable	`sql_alter_column_type`	Undocumented
Class Variable	`sql_check_constraint`	Undocumented
Class Variable	`sql_constraint`	Undocumented
Class Variable	`sql_create_check`	Undocumented
Class Variable	`sql_create_column`	Undocumented
Class Variable	`sql_create_column_inline_fk`	Undocumented
Class Variable	`sql_create_fk`	Undocumented
Class Variable	`sql_create_index`	Undocumented
Class Variable	`sql_create_inline_fk`	Undocumented
Class Variable	`sql_create_pk`	Undocumented
Class Variable	`sql_create_table`	Undocumented
Class Variable	`sql_create_unique`	Undocumented
Class Variable	`sql_create_unique_index`	Undocumented
Class Variable	`sql_delete_column`	Undocumented
Class Variable	`sql_delete_constraint`	Undocumented
Class Variable	`sql_delete_index`	Undocumented
Class Variable	`sql_delete_procedure`	Undocumented
Class Variable	`sql_delete_table`	Undocumented
Class Variable	`sql_rename_column`	Undocumented
Class Variable	`sql_rename_table`	Undocumented
Class Variable	`sql_retablespace_table`	Undocumented
Class Variable	`sql_unique_constraint`	Undocumented
Class Variable	`sql_update_with_default`	Undocumented
Instance Variable	`atomic`	Undocumented
Instance Variable	`atomic_migration`	Undocumented
Instance Variable	`collect_sql`	Undocumented
Instance Variable	`collected_sql`	Undocumented
Instance Variable	`connection`	Undocumented
Instance Variable	`deferred_sql`	Undocumented

def add_constraint(self, model, constraint):

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Add a constraint to a model.

def add_field(self, model, field):

overridden in django.contrib.gis.db.backends.oracle.schema.OracleGISSchemaEditor, django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Create a field on a model. Usually involves adding a column, but may involve adding a table instead (for M2M fields).

def add_index(self, model, index):

overridden in django.db.backends.postgresql.schema.DatabaseSchemaEditor

Add an index on a model.

def alter_db_table(self, model, old_db_table, new_db_table):

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Rename the table a model points to.

def alter_db_tablespace(self, model, old_db_tablespace, new_db_tablespace):

Move a model's table between tablespaces.

def alter_field(self, model, old_field, new_field, strict=False):

overridden in django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Allow a field's type, uniqueness, nullability, default, column, constraints, etc. to be modified. old_field is required to compute the necessary changes. If strict is True, raise errors if the old column does not match old_field precisely.

def alter_index_together(self, model, old_index_together, new_index_together):

Deal with a model changing its index_together. The input index_togethers must be doubly-nested, not the single-nested ["foo", "bar"] format.

def alter_unique_together(self, model, old_unique_together, new_unique_together):

Deal with a model changing its unique_together. The input unique_togethers must be doubly-nested, not the single-nested ["foo", "bar"] format.

def create_model(self, model):

overridden in django.contrib.gis.db.backends.mysql.schema.MySQLGISSchemaEditor, django.contrib.gis.db.backends.oracle.schema.OracleGISSchemaEditor, django.contrib.gis.db.backends.spatialite.schema.SpatialiteSchemaEditor

Create a table and any accompanying indexes or unique constraints for the given model.

def delete_model(self, model):

overridden in django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Delete a model from the database.

def execute(self, sql, params=()):

Execute the given SQL statement, with optional parameters.

def remove_constraint(self, model, constraint):

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Remove a constraint from a model.

def remove_field(self, model, field):

overridden in django.contrib.gis.db.backends.mysql.schema.MySQLGISSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Remove a field from a model. Usually involves deleting a column, but for M2Ms may involve deleting a table.

def remove_index(self, model, index):

overridden in django.db.backends.postgresql.schema.DatabaseSchemaEditor

Remove an index from a model.

@staticmethod
def _effective_default(field):

Undocumented

def __enter__(self):

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Undocumented

def __exit__(self, exc_type, exc_value, traceback):

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Undocumented

def __init__(self, connection, collect_sql=False, atomic=True):

Undocumented

def _alter_column_collation_sql(self, model, new_field, new_type, new_collation):

overridden in django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

def _alter_column_default_sql(self, model, old_field, new_field, drop=False):

Hook to specialize column default alteration.

Return a (sql, params) fragment to add or drop (depending on the drop argument) a default to new_field's column.

def _alter_column_null_sql(self, model, old_field, new_field):

Hook to specialize column null alteration.

Return a (sql, params) fragment to set a column to null or non-null as required by new_field, or None if no changes are required.

def _alter_column_type_sql(self, model, old_field, new_field, new_type):

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.postgresql.schema.DatabaseSchemaEditor

Hook to specialize column type alteration for different backends, for cases when a creation type is different to an alteration type (e.g. SERIAL in PostgreSQL, PostGIS fields).

Return a two-tuple of: an SQL fragment of (sql, params) to insert into an ALTER TABLE statement and a list of extra (sql, params) tuples to run once the field is altered.

def _alter_field(self, model, old_field, new_field, old_type, new_type, old_db_params, new_db_params, strict=False):

overridden in django.db.backends.postgresql.schema.DatabaseSchemaEditor, django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Perform a "physical" (non-ManyToMany) field update.

def _alter_many_to_many(self, model, old_field, new_field, strict):

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Alter M2Ms to repoint their to= endpoints.

def _check_sql(self, name, check):

Undocumented

def _collate_sql(self, collation):

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Undocumented

def _column_default_sql(self, field):

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor

Return the SQL to use in a DEFAULT clause. The resulting string should contain a '%s' placeholder for a default value.

def _constraint_names(self, model, column_names=None, unique=None, primary_key=None, index=None, foreign_key=None, check=None, type_=None, exclude=None):

Return all constraint names matching the columns and conditions.

def _create_check_sql(self, model, name, check):

Undocumented

def _create_fk_sql(self, model, field, suffix):

Undocumented

def _create_index_name(self, table_name, column_names, suffix=''):

Generate a unique name for an index/unique constraint.

The name is divided into 3 parts: the table name, the column names, and a unique digest and suffix.

def _create_index_sql(self, model, *, fields=None, name=None, suffix='', using='', db_tablespace=None, col_suffixes=(), sql=None, opclasses=(), condition=None, include=None, expressions=None):

overridden in django.db.backends.postgresql.schema.DatabaseSchemaEditor

Return the SQL statement to create the index for one or several fields or expressions. sql can be specified if the syntax differs from the standard (GIS indexes, ...).

def _create_primary_key_sql(self, model, field):

Undocumented

def _create_unique_sql(self, model, fields, name=None, condition=None, deferrable=None, include=None, opclasses=None, expressions=None):

Undocumented

def _deferrable_constraint_sql(self, deferrable):

Undocumented

def _delete_check_sql(self, model, name):

Undocumented

def _delete_composed_index(self, model, fields, constraint_kwargs, sql):

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor

Undocumented

def _delete_constraint_sql(self, template, model, name):

Undocumented

def _delete_fk_sql(self, model, name):

Undocumented

def _delete_index_sql(self, model, name, sql=None):

overridden in django.db.backends.postgresql.schema.DatabaseSchemaEditor

Undocumented

def _delete_primary_key(self, model, strict=False):

Undocumented

def _delete_primary_key_sql(self, model, name):

Undocumented

def _delete_unique_sql(self, model, name, condition=None, deferrable=None, include=None, opclasses=None, expressions=None):

Undocumented

def _field_became_primary_key(self, old_field, new_field):

Undocumented

def _field_indexes_sql(self, model, field):

overridden in django.db.backends.postgresql.schema.DatabaseSchemaEditor

Return a list of all index SQL statements for the specified field.

def _field_should_be_altered(self, old_field, new_field):

Undocumented

def _field_should_be_indexed(self, model, field):

overridden in django.contrib.gis.db.backends.postgis.schema.PostGISSchemaEditor, django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

def _fk_constraint_name(self, model, field, suffix):

Undocumented

def _get_index_tablespace_sql(self, model, fields, db_tablespace=None):

Undocumented

def _index_columns(self, table, columns, col_suffixes, opclasses):

overridden in django.db.backends.postgresql.schema.DatabaseSchemaEditor

Undocumented

def _index_condition_sql(self, condition):

Undocumented

def _index_include_sql(self, model, columns):

Undocumented

def _iter_column_sql(self, column_db_type, params, model, field, include_default):

Undocumented

def _model_indexes_sql(self, model):

Return a list of all index SQL statements (field indexes, index_together, Meta.indexes) for the specified model.

def _rename_field_sql(self, table, old_field, new_field, new_type):

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor

Undocumented

def _unique_should_be_added(self, old_field, new_field):

overridden in django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

def _unique_sql(self, model, fields, name, condition=None, deferrable=None, include=None, opclasses=None, expressions=None):

Undocumented

def column_sql(self, model, field, include_default=False):

Return the column definition for a field. The field must already have had set_attributes_from_name() called.

def effective_default(self, field):

Return a field's effective database default value.

def prepare_default(self, value):

overridden in django.db.backends.oracle.schema.DatabaseSchemaEditor

Only used for backends which have requires_literal_defaults feature

def quote_name(self, name):

Undocumented

def quote_value(self, value):

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.postgresql.schema.DatabaseSchemaEditor, django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Return a quoted version of the value so it's safe to use in an SQL string. This is not safe against injection from user code; it is intended only for use in making SQL scripts or preparing default values for particularly tricky backends (defaults are not user-defined, though, so this is safe).

def remove_procedure(self, procedure_name, param_types=()):

Undocumented

def skip_default(self, field):

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor

Some backends don't accept default values for certain columns types (i.e. MySQL longtext and longblob).

def skip_default_on_alter(self, field):

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor

Some backends don't accept default values for certain columns types (i.e. MySQL longtext and longblob) in the ALTER COLUMN statement.

def table_sql(self, model):

Take a model and return its table definition.

sql_alter_column: str =

Undocumented

sql_alter_column_collate: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

sql_alter_column_default: str =

overridden in django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

sql_alter_column_no_default: str =

overridden in django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

sql_alter_column_not_null: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

sql_alter_column_null: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

sql_alter_column_type: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.postgresql.schema.DatabaseSchemaEditor

Undocumented

sql_check_constraint: str =

Undocumented

sql_constraint: str =

Undocumented

sql_create_check: str =

Undocumented

sql_create_column: str =

overridden in django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

sql_create_column_inline_fk =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.postgresql.schema.DatabaseSchemaEditor

Undocumented

sql_create_fk: str =

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Undocumented

sql_create_index: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.postgresql.schema.DatabaseSchemaEditor

Undocumented

sql_create_inline_fk =

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Undocumented

sql_create_pk: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor

Undocumented

sql_create_table: str =

Undocumented

sql_create_unique: str =

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Undocumented

sql_create_unique_index: str =

Undocumented

sql_delete_column: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.oracle.schema.DatabaseSchemaEditor

Undocumented

sql_delete_constraint: str =

Undocumented

sql_delete_index: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor, django.db.backends.postgresql.schema.DatabaseSchemaEditor

Undocumented

sql_delete_procedure: str =

overridden in django.db.backends.postgresql.schema.DatabaseSchemaEditor

Undocumented

sql_delete_table: str =

overridden in django.db.backends.oracle.schema.DatabaseSchemaEditor, django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Undocumented

sql_rename_column: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor

Undocumented

sql_rename_table: str =

overridden in django.db.backends.mysql.schema.DatabaseSchemaEditor

Undocumented

sql_retablespace_table: str =

Undocumented

sql_unique_constraint: str =

Undocumented

sql_update_with_default: str =

Undocumented

atomic =

Undocumented

atomic_migration =

Undocumented

collect_sql =

Undocumented

collected_sql: list =

Undocumented

connection =

Undocumented

deferred_sql: list =

overridden in django.db.backends.sqlite3.schema.DatabaseSchemaEditor

Undocumented