django.db.backends.postgresql.base.DatabaseWrapper

class documentation

class DatabaseWrapper(BaseDatabaseWrapper):

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

View In Hierarchy

Undocumented

Method ​_nodb​_cursor No summary
Method ​_set​_autocommit Backend-specific implementation to enable or disable autocommit.
Method check​_constraints Check constraints by setting them to immediate. Return them to deferred afterward.
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 create​_cursor Create a cursor. Assume that a connection is established.
Method ensure​_timezone Ensure the connection's timezone is set to self.timezone_name and return whether it changed or not.
Method get​_connection​_params Return a dict of parameters suitable for get_new_connection.
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.
Method make​_debug​_cursor Create a cursor that logs all queries in self.queries_log.
Method tzinfo​_factory Undocumented
Class Variable ​_named​_cursor​_idx Undocumented
Class Variable data​_type​_check​_constraints Undocumented
Class Variable data​_types Undocumented
Class Variable display​_name Undocumented
Class Variable operators Undocumented
Class Variable pattern​_esc Undocumented
Class Variable pattern​_ops Undocumented
Class Variable vendor Undocumented
Instance Variable isolation​_level Undocumented
Property pg​_version Undocumented

Inherited from BaseDatabaseWrapper:

Method __init__ Undocumented
Method ​_close Undocumented
Method ​_commit Undocumented
Method ​_cursor Undocumented
Method ​_prepare​_cursor Validate the connection is usable and perform database cursor wrapping.
Method ​_rollback Undocumented
Method ​_savepoint Undocumented
Method ​_savepoint​_allowed Undocumented
Method ​_savepoint​_commit Undocumented
Method ​_savepoint​_rollback Undocumented
Method check​_settings Undocumented
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​_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 disable​_constraint​_checking Backends can implement as needed to temporarily disable foreign key constraint checking. Should return True if the constraints were disabled and will need to be reenabled.
Method enable​_constraint​_checking Backends can implement as needed to re-enable foreign key constraint checking.
Method ensure​_connection Guarantee that a connection to the database is established.
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 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 No summary
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 ​Schema​Editor​Class Undocumented
Instance Variable ​_thread​_ident Undocumented
Instance Variable ​_thread​_sharing​_count Undocumented
Instance Variable ​_thread​_sharing​_lock Undocumented
Instance Variable alias 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 in​_atomic​_block Undocumented
Instance Variable introspection Undocumented
Instance Variable needs​_rollback 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.
@contextmanager
def _nodb_cursor(self):
overrides django.db.backends.base.base.BaseDatabaseWrapper._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. Refs #10868, #17786, #16969.
def _set_autocommit(self, autocommit):
overrides django.db.backends.base.base.BaseDatabaseWrapper._set_autocommit
Backend-specific implementation to enable or disable autocommit.
def check_constraints(self, table_names=None):
overrides django.db.backends.base.base.BaseDatabaseWrapper.check_constraints
Check constraints by setting them to immediate. Return them to deferred afterward.
@async_unsafe
def chunked_cursor(self):
overrides django.db.backends.base.base.BaseDatabaseWrapper.chunked_cursor
Return a cursor that tries to avoid caching in the database (if supported by the database), otherwise return a regular cursor.
@async_unsafe
def create_cursor(self, name=None):
overrides django.db.backends.base.base.BaseDatabaseWrapper.create_cursor
Create a cursor. Assume that a connection is established.
def ensure_timezone(self):
overrides django.db.backends.base.base.BaseDatabaseWrapper.ensure_timezone
Ensure the connection's timezone is set to self.timezone_name and return whether it changed or not.
def get_connection_params(self):
overrides django.db.backends.base.base.BaseDatabaseWrapper.get_connection_params
Return a dict of parameters suitable for get_new_connection.
@async_unsafe
def get_new_connection(self, conn_params):
overrides django.db.backends.base.base.BaseDatabaseWrapper.get_new_connection
Open a connection to the database.
def init_connection_state(self):
overrides django.db.backends.base.base.BaseDatabaseWrapper.init_connection_state
Initialize the database connection settings.
def is_usable(self):
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.

def make_debug_cursor(self, cursor):
overrides django.db.backends.base.base.BaseDatabaseWrapper.make_debug_cursor
Create a cursor that logs all queries in self.queries_log.
def tzinfo_factory(self, offset):

Undocumented

_named_cursor_idx: int =

Undocumented

data_type_check_constraints: dict[str, str] =
overrides django.db.backends.base.base.BaseDatabaseWrapper.data_type_check_constraints

Undocumented

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

Undocumented

display_name: str =
overrides django.db.backends.base.base.BaseDatabaseWrapper.display_name

Undocumented

operators: dict[str, str] =

Undocumented

pattern_esc: str =

Undocumented

pattern_ops: dict[str, str] =

Undocumented

vendor: str =
overrides django.db.backends.base.base.BaseDatabaseWrapper.vendor

Undocumented

isolation_level =

Undocumented

@cached_property
pg_version =

Undocumented