3 g`@sddlZddlZddlZddlZddlZddlmZddlmZddl Z ddl m Z ddl m Z ddlmZmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlm Z dZ!GdddZ"dS)N)deque)contextmanager)settings)ImproperlyConfigured)DEFAULT_DB_ALIAS DatabaseError)utils)BaseDatabaseValidation)connection_created)TransactionManagementError)DatabaseErrorWrapper)timezone) async_unsafe)cached_propertyZ __no_db__c@s~eZdZdZiZiZiZdZdZdZ dZ dZ dZ dZ dZdZeZdZefddZddZed d Zed d Zed dZeddZddZddZddZd|ddZe ddZ!ddZ"e ddZ#dd Z$d}d!d"Z%d#d$Z&d%d&Z'd'd(Z(e d)d*Z)e d+d,Z*e d-d.Z+e d/d0Z,d1d2Z-d3d4Z.d5d6Z/d7d8Z0e d9d:Z1e d;d<Z2e d=d>Z3e d?d@Z4dAdBZ5dCdDZ6d~dFdGZ7dHdIZ8dJdKZ9dLdMZ:dNdOZ;edTdUZ?ddVdWZ@dXdYZAdZd[ZBed\d]ZCd^d_ZDd`daZEdbdcZFdddeZGedfdgZHdhdiZIdjdkZJdldmZKeConnect to the database. Assume that the connection is closed.FZ CONN_MAX_AGEN AUTOCOMMIT)Zsenderr)check_settingsrrrrtime monotonicrrr rHrJrset_autocommitrKr send __class__r()r4Zmax_agerIr5r5r6connects  zBaseDatabaseWrapper.connectcCs(|jddk r$tj r$td|jdS)Nr9z=Connection '%s' cannot set TIME_ZONE because USE_TZ is False.)rrr:rr)r4r5r5r6rOsz"BaseDatabaseWrapper.check_settingsc Cs(|jdkr$|j|jWdQRXdS)z;Guarantee that a connection to the database is established.N)rwrap_database_errorsrU)r4r5r5r6ensure_connections z%BaseDatabaseWrapper.ensure_connectioncCs(|j|jr|j|}n |j|}|S)zY Validate the connection is usable and perform database cursor wrapping. )validate_thread_sharingr@make_debug_cursor make_cursor)r4cursorZwrapped_cursorr5r5r6_prepare_cursors   z#BaseDatabaseWrapper._prepare_cursorc Cs*|j|j|j|j|SQRXdS)N)rWrVr\rM)r4rLr5r5r6_cursorszBaseDatabaseWrapper._cursorc Cs&|jdk r"|j |jjSQRXdS)N)rrVcommit)r4r5r5r6_commits zBaseDatabaseWrapper._commitc Cs&|jdk r"|j |jjSQRXdS)N)rrVrollback)r4r5r5r6 _rollbacks zBaseDatabaseWrapper._rollbackc Cs&|jdk r"|j |jjSQRXdS)N)rrVclose)r4r5r5r6_closes zBaseDatabaseWrapper._closecCs|jS)z3Create a cursor, opening a connection if necessary.)r])r4r5r5r6r[szBaseDatabaseWrapper.cursorcCs(|j|j|jd|_d|_dS)z.Commit a transaction and reset the dirty flag.FTN)rXvalidate_no_atomic_blockr_r r))r4r5r5r6r^s zBaseDatabaseWrapper.commitcCs.|j|j|jd|_d|_g|_dS)z1Roll back a transaction and reset the dirty flag.FN)rXrdrar rr()r4r5r5r6r`s zBaseDatabaseWrapper.rollbackc CsP|jg|_|js|jdkr"dSz |jWd|jrDd|_d|_nd|_XdS)z%Close the connection to the database.NT)rXr(rrrcrr)r4r5r5r6rbs zBaseDatabaseWrapper.closec Cs*|j}|j|jj|WdQRXdS)N)r[executer2Zsavepoint_create_sql)r4sidr[r5r5r6 _savepoint0s zBaseDatabaseWrapper._savepointc Cs*|j}|j|jj|WdQRXdS)N)r[rer2Zsavepoint_rollback_sql)r4rfr[r5r5r6_savepoint_rollback4s z'BaseDatabaseWrapper._savepoint_rollbackc Cs*|j}|j|jj|WdQRXdS)N)r[rer2Zsavepoint_commit_sql)r4rfr[r5r5r6_savepoint_commit8s z%BaseDatabaseWrapper._savepoint_commitcCs|jjo|j S)N)r/Zuses_savepointsget_autocommit)r4r5r5r6_savepoint_allowed<sz&BaseDatabaseWrapper._savepoint_allowedcCsV|js dStj}t|jdd}|jd7_d||jf}|j|j||S)z 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. N-zs%s_x%d)rkr%r&strreplacerrXrg)r4Z thread_identtidrfr5r5r6 savepointBs zBaseDatabaseWrapper.savepointcs8|js dS|j|jfdd|jD|_dS)zW Roll back to a savepoint. Do nothing if savepoints are not supported. Ncs g|]\}}|kr||fqSr5r5).0sidsfunc)rfr5r6 dsz:BaseDatabaseWrapper.savepoint_rollback..)rkrXrhr()r4rfr5)rfr6savepoint_rollbackWs  z&BaseDatabaseWrapper.savepoint_rollbackcCs"|js dS|j|j|dS)zR Release a savepoint. Do nothing if savepoints are not supported. N)rkrXri)r4rfr5r5r6savepoint_commitgsz$BaseDatabaseWrapper.savepoint_commitcCs d|_dS)zY Reset the counter used to generate unique savepoint ids in this thread. rN)r)r4r5r5r6clean_savepointsrsz$BaseDatabaseWrapper.clean_savepointscCs tddS)zR Backend-specific implementation to enable or disable autocommit. zHsubclasses of BaseDatabaseWrapper may require a _set_autocommit() methodN)rG)r4rr5r5r6_set_autocommit{sz#BaseDatabaseWrapper._set_autocommitcCs|j|jS)zGet the autocommit state.)rWr)r4r5r5r6rjsz"BaseDatabaseWrapper.get_autocommitFcCs^|j|j|o"| o"t|d}|r2|jn |j|||_|rZ|jrZ|jd|_dS)a Enable or disable autocommit. The usual way to start a transaction is to turn autocommit off. SQLite does not properly start a transaction when disabling autocommit. To avoid this buggy behavior and to actually enter a new transaction, an explicit BEGIN is required. Using force_begin_transaction_with_broken_autocommit=True will issue an explicit BEGIN with SQLite. This option will be ignored for other backends. #_start_transaction_under_autocommitFN)rdrWhasattrr{rzrr)run_and_clear_commit_hooks)r4rZ.force_begin_transaction_with_broken_autocommitZ"start_transaction_under_autocommitr5r5r6rRs      z"BaseDatabaseWrapper.set_autocommitcCs|jstd|jS)z9Get the "needs rollback" flag -- for *advanced use* only.zd|_n |jdS|jdk rntj|jkrn|jdSdS)z Close the current connection if unrecoverable errors have occurred or if it outlived its maximum age. NrNF) rrjrrbr rrrPrQ)r4r5r5r6close_if_unusable_or_obsoletes z1BaseDatabaseWrapper.close_if_unusable_or_obsoletec Cs|j |jdkSQRXdS)Nr)r#r$)r4r5r5r6allow_thread_sharingsz(BaseDatabaseWrapper.allow_thread_sharingc Cs$|j|jd7_WdQRXdS)Nrn)r#r$)r4r5r5r6inc_thread_sharingsz&BaseDatabaseWrapper.inc_thread_sharingc Cs6|j&|jdkrtd|jd8_WdQRXdS)Nrz5Cannot decrement the thread sharing count below zero.rn)r#r$ RuntimeError)r4r5r5r6dec_thread_sharings z&BaseDatabaseWrapper.dec_thread_sharingcCs2|jp|jtjks.td|j|jtjfdS)a3 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). Raise an exception if the validation fails. zDatabaseWrapper objects created in a thread can only be used in that same thread. The object with alias '%s' was created in thread id %s and this is thread id %s.N)rr'r%r&rr)r4r5r5r6rX sz+BaseDatabaseWrapper.validate_thread_sharingcCsdS)z~ Hook to do any database check or preparation, generally called before migrating a project or an app. Nr5)r4r5r5r6prepare_database2sz$BaseDatabaseWrapper.prepare_databasecCst|S)z Context manager and decorator that re-throws backend-specific database exceptions using Django's common wrappers. )r )r4r5r5r6rV9sz(BaseDatabaseWrapper.wrap_database_errorscCs|jS)z Return a cursor that tries to avoid caching in the database (if supported by the database), otherwise return a regular cursor. )r[)r4r5r5r6chunked_cursorAsz"BaseDatabaseWrapper.chunked_cursorcCs tj||S)z:Create a cursor that logs all queries in self.queries_log.)rZCursorDebugWrapper)r4r[r5r5r6rYHsz%BaseDatabaseWrapper.make_debug_cursorcCs tj||S)z&Create a cursor without debug logging.)rZ CursorWrapper)r4r[r5r5r6rZLszBaseDatabaseWrapper.make_cursorccs<|jdk}z|j }|VWdQRXWd|r6|jXdS)a8 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. Provide a cursor: with self.temporary_connection() as cursor: ... N)rr[rb)r4Z must_closer[r5r5r6temporary_connectionPs  z(BaseDatabaseWrapper.temporary_connectionccsF|j|jdditd}z|j }|VWdQRXWd|jXdS)aq 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. NAMEN)r)rTr NO_DB_ALIASr[rb)r4connr[r5r5r6 _nodb_cursoras  z BaseDatabaseWrapper._nodb_cursorcOs$|jdkrtd|j|f||S)zG Return a new instance of this backend's SchemaEditor. NzFThe SchemaEditorClass attribute of this database wrapper is still None)SchemaEditorClassrG)r4argskwargsr5r5r6 schema_editorqs z!BaseDatabaseWrapper.schema_editorcCsJt|std|jr.|jjt|j|fn|js@tdn|dS)Nz*on_commit()'s callback must be a callable.z;on_commit() cannot be used in manual transaction management) callable TypeErrorrr(appendsetrrjr )r4rur5r5r6 on_commitzs zBaseDatabaseWrapper.on_commitcCs6|j|j}g|_x|r0|jd\}}|qWdS)Nr)rdr(pop)r4Zcurrent_run_on_commitrtrur5r5r6r}s z.BaseDatabaseWrapper.run_and_clear_commit_hooksc cs(|jj|z dVWd|jjXdS)z| Return a context manager under which the wrapper is applied to suitable database query executions. N)r*rr)r4wrapperr5r5r6execute_wrappers  z#BaseDatabaseWrapper.execute_wrappercCs(tj|j}|dkr|j}t|||S)zy Return a copy of this connection. For tests that require two connections to the same database. N)copydeepcopyrrtype)r4rrr5r5r6rs zBaseDatabaseWrapper.copy)N)N)F)N)N)S__name__ __module__ __qualname____doc__Z data_typesZdata_types_suffixZdata_type_check_constraintsr2vendorZ display_namerr+r-r.r0r1r r3rrr7r8rr r>propertyr@rFrHrJrKrMrrUrOrWr\r]r_rarcr[r^r`rbrgrhrirkrrrwrxryrzrjrRr~rrdrrrrrrrrrrrrXrrVrrYrZrrrrr}rrr5r5r5r6rs >                        r)#r%rr!rPrB collectionsr contextlibrr<Z django.confrZdjango.core.exceptionsrZ django.dbrrZdjango.db.backendsrZ"django.db.backends.base.validationr Zdjango.db.backends.signalsr Zdjango.db.transactionr Zdjango.db.utilsr Z django.utilsr Zdjango.utils.asynciorZdjango.utils.functionalrrrr5r5r5r6s(