django.db.backends.mysql.base.DatabaseWrapper

class documentation

class DatabaseWrapper(BaseDatabaseWrapper): (source)

Known subclasses: django.contrib.gis.db.backends.mysql.base.DatabaseWrapper

View In Hierarchy

Undocumented

Method check_constraints Check each table name in `table_names` for rows with invalid foreign key references. This method is intended to be used in conjunction with `disable_constraint_checking()` and `enable_constraint_checking()`, to determine if rows with invalid references were entered while constraint checks were off.
Method create_cursor Create a cursor. Assume that a connection is established.
Method disable_constraint_checking Disable foreign key checks, primarily for use in adding rows with forward references. Always return True to indicate constraint checks need to be re-enabled.
Method enable_constraint_checking Re-enable foreign key checks after they have been disabled.
Method get_connection_params Return a dict of parameters suitable for get_new_connection.
Method get_database_version Return a tuple of the database's version.
Method get_new_connection Open a connection to the database.
Method init_connection_state Initialize the database connection settings.
Method is_usable Test if the database connection is usable.
Class Variable data_types Undocumented
Class Variable isolation_levels Undocumented
Class Variable operators Undocumented
Class Variable pattern_esc Undocumented
Class Variable pattern_ops Undocumented
Class Variable vendor Undocumented
Instance Variable isolation_level Undocumented
Instance Variable needs_rollback Undocumented
Property data_type_check_constraints Undocumented
Property display_name Undocumented
Property mysql_is_mariadb Undocumented
Property mysql_server_data Undocumented
Property mysql_server_info Undocumented
Property mysql_version Undocumented
Property sql_mode Undocumented
Method _rollback Undocumented
Method _set_autocommit Backend-specific implementation to enable or disable autocommit.
Class Variable _limited_data_types Undocumented

Inherited from BaseDatabaseWrapper:

Method __init__ Undocumented
Method __repr__ Undocumented
Method check_database_version_supported Raise an error if the database version isn't supported by this version of Django.
Method check_settings Undocumented
Method chunked_cursor Return a cursor that tries to avoid caching in the database (if supported by the database), otherwise return a regular cursor.
Method clean_savepoints Reset the counter used to generate unique savepoint ids in this thread.
Method close Close the connection to the database.
Method close_if_health_check_failed Close existing connection if it fails a health check.
Method close_if_unusable_or_obsolete Close the current connection if unrecoverable errors have occurred or if it outlived its maximum age.
Method commit Commit a transaction and reset the dirty flag.
Method connect Connect to the database. Assume that the connection is closed.
Method constraint_checks_disabled Disable foreign key constraint checking.
Method copy Return a copy of this connection.
Method cursor Create a cursor, opening a connection if necessary.
Method dec_thread_sharing Undocumented
Method ensure_connection Guarantee that a connection to the database is established.
Method ensure_timezone Ensure the connection's timezone is set to `self.timezone_name` and return whether it changed or not.
Method execute_wrapper Return a context manager under which the wrapper is applied to suitable database query executions.
Method get_autocommit Get the autocommit state.
Method get_rollback Get the "needs rollback" flag -- for *advanced use* only.
Method inc_thread_sharing Undocumented
Method make_cursor Create a cursor without debug logging.
Method make_debug_cursor Create a cursor that logs all queries in self.queries_log.
Method on_commit Undocumented
Method prepare_database Hook to do any database check or preparation, generally called before migrating a project or an app.
Method rollback Roll back a transaction and reset the dirty flag.
Method run_and_clear_commit_hooks Undocumented
Method savepoint Create a savepoint inside the current transaction. Return an identifier for the savepoint that will be used for the subsequent rollback or commit. Do nothing if savepoints are not supported.
Method savepoint_commit Release a savepoint. Do nothing if savepoints are not supported.
Method savepoint_rollback Roll back to a savepoint. Do nothing if savepoints are not supported.
Method schema_editor Return a new instance of this backend's SchemaEditor.
Method set_autocommit Enable or disable autocommit.
Method set_rollback Set or unset the "needs rollback" flag -- for *advanced use* only.
Method temporary_connection Context manager that ensures that a connection is established, and if it opened one, closes it to avoid leaving a dangling connection. This is useful for operations outside of the request-response cycle.
Method validate_no_atomic_block Raise an error if an atomic block is active.
Method validate_no_broken_transaction Undocumented
Method validate_thread_sharing Validate that the connection isn't accessed by another thread than the one which originally created it, unless the connection was explicitly authorized to be shared between threads (via the `inc_thread_sharing()` method)...
Class Variable client_class Undocumented
Class Variable creation_class Undocumented
Class Variable data_types_suffix Undocumented
Class Variable features_class Undocumented
Class Variable introspection_class Undocumented
Class Variable ops_class Undocumented
Class Variable queries_limit Undocumented
Class Variable SchemaEditorClass Undocumented
Instance Variable alias Undocumented
Instance Variable atomic_blocks Undocumented
Instance Variable autocommit Undocumented
Instance Variable client Undocumented
Instance Variable close_at Undocumented
Instance Variable closed_in_transaction Undocumented
Instance Variable commit_on_exit Undocumented
Instance Variable connection Undocumented
Instance Variable creation Undocumented
Instance Variable errors_occurred Undocumented
Instance Variable execute_wrappers Undocumented
Instance Variable features Undocumented
Instance Variable force_debug_cursor Undocumented
Instance Variable health_check_done Undocumented
Instance Variable health_check_enabled Undocumented
Instance Variable in_atomic_block Undocumented
Instance Variable introspection Undocumented
Instance Variable ops Undocumented
Instance Variable queries_log Undocumented
Instance Variable run_commit_hooks_on_set_autocommit_on Undocumented
Instance Variable run_on_commit Undocumented
Instance Variable savepoint_ids Undocumented
Instance Variable savepoint_state Undocumented
Instance Variable settings_dict Undocumented
Instance Variable validation Undocumented
Property allow_thread_sharing Undocumented
Property queries Undocumented
Property queries_logged Undocumented
Property timezone Return a tzinfo of the database connection time zone.
Property timezone_name Name of the time zone of the database connection.
Property wrap_database_errors Context manager and decorator that re-throws backend-specific database exceptions using Django's common wrappers.
Method _close Undocumented
Method _commit Undocumented
Method _cursor Undocumented
Method _nodb_cursor Return a cursor from an alternative connection to be used when there is no need to access the main database, specifically for test db creation/deletion. This also prevents the production database from being exposed to potential child threads while (or after) the test database is destroyed...
Method _prepare_cursor Validate the connection is usable and perform database cursor wrapping.
Method _savepoint Undocumented
Method _savepoint_allowed Undocumented
Method _savepoint_commit Undocumented
Method _savepoint_rollback Undocumented
Instance Variable _thread_ident Undocumented
Instance Variable _thread_sharing_count Undocumented
Instance Variable _thread_sharing_lock Undocumented
def check_constraints(self, table_names=None): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.check_constraints

Check each table name in `table_names` for rows with invalid foreign key references. This method is intended to be used in conjunction with `disable_constraint_checking()` and `enable_constraint_checking()`, to determine if rows with invalid references were entered while constraint checks were off.

@async_unsafe
def create_cursor(self, name=None): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.create_cursor

Create a cursor. Assume that a connection is established.

def disable_constraint_checking(self): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.disable_constraint_checking

Disable foreign key checks, primarily for use in adding rows with forward references. Always return True to indicate constraint checks need to be re-enabled.

def enable_constraint_checking(self): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.enable_constraint_checking

Re-enable foreign key checks after they have been disabled.

def get_connection_params(self): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.get_connection_params

Return a dict of parameters suitable for get_new_connection.

def get_database_version(self): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.get_database_version

Return a tuple of the database's version.

@async_unsafe
def get_new_connection(self, conn_params): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.get_new_connection

Open a connection to the database.

def init_connection_state(self): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.init_connection_state

Initialize the database connection settings.

def is_usable(self): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.is_usable

Test if the database connection is usable. This method may assume that self.connection is not None. Actual implementations should take care not to raise exceptions as that may prevent Django from recycling unusable connections.

data_types: dict[str, str] = (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.data_types

Undocumented

isolation_levels: set[str] = (source)

Undocumented

operators: dict[str, str] = (source)

Undocumented

pattern_esc: str = (source)

Undocumented

pattern_ops: dict[str, str] = (source)

Undocumented

vendor: str = (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.vendor

Undocumented

isolation_level = (source)

Undocumented

needs_rollback = (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.needs_rollback

Undocumented

@cached_property
data_type_check_constraints = (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.data_type_check_constraints

Undocumented

@cached_property
display_name = (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper.display_name

Undocumented

@cached_property
mysql_is_mariadb = (source)

Undocumented

@cached_property
mysql_server_data = (source)

Undocumented

@cached_property
mysql_server_info = (source)

Undocumented

@cached_property
mysql_version = (source)

Undocumented

@cached_property
sql_mode = (source)

Undocumented

def _rollback(self): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper._rollback

Undocumented

def _set_autocommit(self, autocommit): (source)
overrides django.db.backends.base.base.BaseDatabaseWrapper._set_autocommit

Backend-specific implementation to enable or disable autocommit.

_limited_data_types: tuple[str, ...] = (source)

Undocumented