django.db.backends.sqlite3.schema.DatabaseSchemaEditor

class documentation

class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):

Known subclasses: django.contrib.gis.db.backends.spatialite.schema.SpatialiteSchemaEditor

View In Hierarchy

Undocumented

Method __enter__ Undocumented
Method __exit__ Undocumented
Method ​_alter​_field Perform a "physical" (non-ManyToMany) field update.
Method ​_alter​_many​_to​_many Alter M2Ms to repoint their to= endpoints.
Method ​_collate​_sql Undocumented
Method ​_is​_referenced​_by​_fk​_constraint No summary
Method ​_remake​_table Shortcut to transform a model from old_model into new_model
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 alter​_db​_table Rename the table a model points to.
Method alter​_field No summary
Method delete​_model Delete a model from the database.
Method quote​_value No summary
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.
Class Variable sql​_create​_fk Undocumented
Class Variable sql​_create​_inline​_fk Undocumented
Class Variable sql​_create​_unique Undocumented
Class Variable sql​_delete​_table Undocumented
Class Variable sql​_delete​_unique Undocumented
Instance Variable deferred​_sql Undocumented

Inherited from BaseDatabaseSchemaEditor:

Method add​_index Add an index on a model.
Method alter​_db​_tablespace Move a model's table between tablespaces.
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 execute Execute the given SQL statement, with optional parameters.
Method remove​_index Remove an index from a model.
Static Method ​_effective​_default 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 ​_check​_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 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​_index Undocumented
Class Variable sql​_create​_pk Undocumented
Class Variable sql​_create​_table 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​_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
def __enter__(self):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.__enter__

Undocumented

def __exit__(self, exc_type, exc_value, traceback):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.__exit__

Undocumented

def _alter_field(self, model, old_field, new_field, old_type, new_type, old_db_params, new_db_params, strict=False):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor._alter_field
Perform a "physical" (non-ManyToMany) field update.
def _alter_many_to_many(self, model, old_field, new_field, strict):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor._alter_many_to_many
Alter M2Ms to repoint their to= endpoints.
def _collate_sql(self, collation):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor._collate_sql

Undocumented

def _is_referenced_by_fk_constraint(self, table_name, column_name=None, ignore_self=False):
Return whether or not the provided table name is referenced by another one. If column_name is specified, only references pointing to that column are considered. If ignore_self is True, self-referential constraints are ignored.
def _remake_table(self, model, create_field=None, delete_field=None, alter_field=None):

Shortcut to transform a model from old_model into new_model

This follows the correct procedure to perform non-rename or column addition operations based on SQLite's documentation

https://www.sqlite.org/lang_altertable.html#caution

The essential steps are:
  1. Create a table with the updated definition called "new__app_model"
  2. Copy the data from the existing "app_model" table to the new table
  3. Drop the "app_model" table
  4. Rename the "new__app_model" table to "app_model"
  5. Restore any index of the previous "app_model" table.
def add_constraint(self, model, constraint):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.add_constraint
Add a constraint to a model.
def add_field(self, model, field):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.add_field
overridden in django.contrib.gis.db.backends.spatialite.schema.SpatialiteSchemaEditor
Create a field on a model. Usually involves adding a column, but may involve adding a table instead (for M2M fields).
def alter_db_table(self, model, old_db_table, new_db_table, disable_constraints=True):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.alter_db_table
overridden in django.contrib.gis.db.backends.spatialite.schema.SpatialiteSchemaEditor
Rename the table a model points to.
def alter_field(self, model, old_field, new_field, strict=False):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.alter_field
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 delete_model(self, model, handle_autom2m=True):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.delete_model
overridden in django.contrib.gis.db.backends.spatialite.schema.SpatialiteSchemaEditor
Delete a model from the database.
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 remove_constraint(self, model, constraint):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.remove_constraint
Remove a constraint from a model.
def remove_field(self, model, field):
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.remove_field
overridden in django.contrib.gis.db.backends.spatialite.schema.SpatialiteSchemaEditor
Remove a field from a model. Usually involves deleting a column, but for M2Ms may involve deleting a table.
sql_create_fk =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.sql_create_fk

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

sql_delete_unique: str =

Undocumented

deferred_sql: list =
overrides django.db.backends.base.schema.BaseDatabaseSchemaEditor.deferred_sql

Undocumented