django.db.backends.mysql.schema.DatabaseSchemaEditor

class documentation

class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):

Known subclasses: django.contrib.gis.db.backends.mysql.schema.MySQLGISSchemaEditor

View In Hierarchy

Undocumented

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 ​_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 ​_delete​_composed​_index No summary
Method ​_field​_should​_be​_indexed Undocumented
Method ​_is​_limited​_data​_type Undocumented
Method ​_rename​_field​_sql Undocumented
Method ​_set​_field​_new​_type​_null​_status Keep the null property of the old field. If it has changed, it will be handled separately.
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 quote​_value No summary
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.
Class Variable sql​_alter​_column​_collate Undocumented
Class Variable sql​_alter​_column​_no​_default​_null 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​_create​_column​_inline​_fk Undocumented
Class Variable sql​_create​_index Undocumented
Class Variable sql​_create​_pk Undocumented
Class Variable sql​_delete​_column Undocumented
Class Variable sql​_delete​_fk Undocumented
Class Variable sql​_delete​_index Undocumented
Class Variable sql​_delete​_pk Undocumented
Class Variable sql​_delete​_unique Undocumented
Class Variable sql​_rename​_table Undocumented
Property ​_supports​_limited​_data​_type​_defaults Undocumented
Property sql​_delete​_check Undocumented
Property sql​_rename​_column Undocumented

Inherited from BaseDatabaseSchemaEditor:

Method add​_constraint Add a constraint to a model.
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​_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 ​_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​_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 ​_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 ​_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 remove​_procedure Undocumented
Method table​_sql Take a model and return its table definition.
Class Variable sql​_alter​_column Undocumented
Class Variable sql​_alter​_column​_default Undocumented
Class Variable sql​_alter​_column​_no​_default 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​_fk Undocumented
Class Variable sql​_create​_inline​_fk Undocumented
Class Variable sql​_create​_table Undocumented
Class Variable sql​_create​_unique Undocumented
Class Variable sql​_create​_unique​_index Undocumented
Class Variable sql​_delete​_constraint Undocumented
Class Variable sql​_delete​_procedure Undocumented
Class Variable sql​_delete​_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 _alter_column_type_sql(self, model, old_field, new_field, new_type):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor._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).

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 _column_default_sql(self, field):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor._column_default_sql
Return the SQL to use in a DEFAULT clause. The resulting string should contain a '%s' placeholder for a default value.
def _delete_composed_index(self, model, fields, *args):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor._delete_composed_index
MySQL can remove an implicit FK index on a field when that field is covered by another index like a unique_together. "covered" here means that the more complex index starts like the simpler one. http://bugs.mysql.com/bug.php?id=37910 / Django ticket #24757 We check here before removing the [unique|index]_together if we have to recreate a FK index.
def _field_should_be_indexed(self, model, field):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor._field_should_be_indexed

Undocumented

def _is_limited_data_type(self, field):

Undocumented

def _rename_field_sql(self, table, old_field, new_field, new_type):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor._rename_field_sql

Undocumented

def _set_field_new_type_null_status(self, field, new_type):
Keep the null property of the old field. If it has changed, it will be handled separately.
def add_field(self, model, field):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.add_field
overridden in django.contrib.gis.db.backends.mysql.schema.MySQLGISSchemaEditor
Create a field on a model. Usually involves adding a column, but may involve adding a table instead (for M2M fields).
def quote_value(self, value):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.quote_value
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 skip_default(self, field):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.skip_default
overridden in django.contrib.gis.db.backends.mysql.schema.MySQLGISSchemaEditor
Some backends don't accept default values for certain columns types (i.e. MySQL longtext and longblob).
def skip_default_on_alter(self, field):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.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.
sql_alter_column_collate: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_alter_column_collate

Undocumented

sql_alter_column_no_default_null: str =

Undocumented

sql_alter_column_not_null: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_alter_column_not_null

Undocumented

sql_alter_column_null: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_alter_column_null

Undocumented

sql_alter_column_type: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_alter_column_type

Undocumented

sql_create_column_inline_fk: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_create_column_inline_fk

Undocumented

sql_create_index: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_create_index

Undocumented

sql_create_pk: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_create_pk

Undocumented

sql_delete_column: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_delete_column

Undocumented

sql_delete_fk: str =

Undocumented

sql_delete_index: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_delete_index

Undocumented

sql_delete_pk: str =

Undocumented

sql_delete_unique: str =

Undocumented

sql_rename_table: str =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_rename_table

Undocumented

@property
_supports_limited_data_type_defaults =

Undocumented

@property
sql_delete_check =

Undocumented

@property
sql_rename_column =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_rename_column

Undocumented