class documentation

class SpatialiteSchemaEditor(DatabaseSchemaEditor):

View In Hierarchy

Undocumented

Method __init__ Undocumented
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 column​_sql Return the column definition for a field. The field must already have had set_attributes_from_name() called.
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 geo​_quote​_name Undocumented
Method remove​_field Remove a field from a model. Usually involves deleting a column, but for M2Ms may involve deleting a table.
Method remove​_geometry​_metadata Undocumented
Class Variable geometry​_tables Undocumented
Class Variable sql​_add​_geometry​_column Undocumented
Class Variable sql​_add​_spatial​_index Undocumented
Class Variable sql​_discard​_geometry​_columns Undocumented
Class Variable sql​_drop​_spatial​_index Undocumented
Class Variable sql​_recover​_geometry​_metadata Undocumented
Class Variable sql​_remove​_geometry​_metadata Undocumented
Class Variable sql​_update​_geometry​_columns Undocumented
Instance Variable geometry​_sql Undocumented

Inherited from DatabaseSchemaEditor:

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 alter​_field No summary
Method quote​_value No summary
Method remove​_constraint Remove a constraint from a model.
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 (via DatabaseSchemaEditor):

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 execute Execute the given SQL statement, with optional parameters.
Method remove​_index Remove an index from a model.
Static Method ​_effective​_default 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 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 __init__(self, *args, **kwargs):
def add_field(self, model, field):
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):
Rename the table a model points to.
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 create_model(self, model):
Create a table and any accompanying indexes or unique constraints for the given model.
def delete_model(self, model, **kwargs):
Delete a model from the database.
def geo_quote_name(self, name):

Undocumented

def remove_field(self, model, field):
Remove a field from a model. Usually involves deleting a column, but for M2Ms may involve deleting a table.
def remove_geometry_metadata(self, model, field):

Undocumented

geometry_tables: list[str] =

Undocumented

sql_add_geometry_column: str =

Undocumented

sql_add_spatial_index: str =

Undocumented

sql_discard_geometry_columns: str =

Undocumented

sql_drop_spatial_index: str =

Undocumented

sql_recover_geometry_metadata: str =

Undocumented

sql_remove_geometry_metadata: str =

Undocumented

sql_update_geometry_columns: str =

Undocumented

geometry_sql: list =

Undocumented