class documentation

class DatabaseIntrospection(BaseDatabaseIntrospection):

Known subclasses: django.contrib.gis.db.backends.postgis.introspection.PostGISIntrospection

View In Hierarchy

Undocumented

Method get​_constraints Retrieve any constraints or keys (unique, pk, fk, check, index) across one or more columns. Also retrieve the definition of expression-based indexes.
Method get​_field​_type Hook for a database backend to use the cursor description to match a Django field type to a database column.
Method get​_key​_columns Backends can override this to return a list of: (column_name, referenced_table_name, referenced_column_name) for all key columns in given table.
Method get​_relations Return a dictionary of {field_name: (field_name_other_table, other_table)} representing all relationships to the given table.
Method get​_sequences Return a list of introspected sequences for table_name. Each sequence is a dict: {'table': <table_name>, 'column': <column_name>}. An optional 'name' key can be added if the backend supports named sequences.
Method get​_table​_description Return a description of the table with the DB-API cursor.description interface.
Method get​_table​_list Return a list of table and view names in the current database.
Class Variable data​_types​_reverse Undocumented
Class Variable ignored​_tables Undocumented
Class Variable index​_default​_access​_method Undocumented

Inherited from BaseDatabaseIntrospection:

Method __init__ Undocumented
Method django​_table​_names Return a list of all table names that have associated Django models and are in INSTALLED_APPS.
Method get​_migratable​_models Undocumented
Method get​_primary​_key​_column Return the name of the primary key column for the given table.
Method identifier​_converter Apply a conversion to the identifier for the purposes of comparison.
Method installed​_models Return a set of all models represented by the provided list of table names.
Method sequence​_list Return a list of information about all DB sequences for all models in all apps.
Method table​_names No summary
Instance Variable connection Undocumented
def get_constraints(self, cursor, table_name):
Retrieve any constraints or keys (unique, pk, fk, check, index) across one or more columns. Also retrieve the definition of expression-based indexes.
def get_field_type(self, data_type, description):

Hook for a database backend to use the cursor description to match a Django field type to a database column.

For Oracle, the column data_type on its own is insufficient to distinguish between a FloatField and IntegerField, for example.

def get_key_columns(self, cursor, table_name):
Backends can override this to return a list of:
(column_name, referenced_table_name, referenced_column_name)

for all key columns in given table.

def get_relations(self, cursor, table_name):
Return a dictionary of {field_name: (field_name_other_table, other_table)} representing all relationships to the given table.
def get_sequences(self, cursor, table_name, table_fields=()):
Return a list of introspected sequences for table_name. Each sequence is a dict: {'table': <table_name>, 'column': <column_name>}. An optional 'name' key can be added if the backend supports named sequences.
def get_table_description(self, cursor, table_name):
Return a description of the table with the DB-API cursor.description interface.
def get_table_list(self, cursor):
Return a list of table and view names in the current database.
data_types_reverse: dict[int, str] =
ignored_tables: list =
index_default_access_method: str =

Undocumented