o "h0 @sdZddlmZddlmZddlmZddlmZddlm Z ddlm Z ddlm Z dd lm Z dd lm Z dd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlm Z ddlm!Z!ddl"m#Z#ddl"m#Z#ddl"m$Z$ddl"m$Z$ddlm%Z%dd l&m'Z'dd!l(m)Z)dd"l(m*Z*dd#l(m+Z+dd$l(m,Z,ergd%d&l-m.Z.d%d'l-m/Z/d%d(l0m1Z1d%d)l2m3Z3dd*lm4Z4dd+lm5Z5dd,l6m7Z7dd-l8m9Z9dd.l"m:Z:dd/l"m;Z;dd0l"mZ>dd3l"m?Z?dd4l@mAZAdd5l@mBZBdd6lCmDZDdd7lCmEZEdd8lCmFZFddlCmZGdd9lHmIZIdd:lJmKZKdd;lJmLZLeeeMeeMeffZNedZOGd?d@d@eZPGdAdBdBeZQGdCdDdDe+ZRGdEdFdFe+ZSGdGdHdHe+ZTeeMefZUeeMefZVeeUZWeeWeUfZXeeeeUfZYeeeeeWfZZeeZeYfZ[eeeMdFee\ee\ee\ee\ee]fZ^eYZ_eZZ`e[ZaeedIfZbeeeMeeMfZce%eMefZde)dJZeeeeMedKfZfe)dLZgGdMdNdNe,dOdPZhe%eMefZieeheeMeffZjGdQdRdRe,ZkGdSdTdTe,ZlGdUdVdVe,ZmGdWdXdXe,ZnGdYdZdZenZoGd[d\d\enZpGd]d^d^enZqGd_d`d`enZrGdadbdbe,ZsGdcdddde,ZtGdedfdfeZueee\eMfdgfZveeeMeMfZwGdhdidieZxGdjdkdkZyGdldmdmZzGdndodoeZ{e{Z|GdpdqdqZ}GdrdsdsZ~dtS)uz1Define core interfaces used by the engine system.) annotations)Enum) ModuleType)Any) Awaitable)Callable)ClassVar) Collection)Dict)Iterable)Iterator)List)Mapping)MutableMapping)Optional)Sequence)Set)Tuple)Type) TYPE_CHECKING)TypeVar)Union)util) EventTarget)Pool)PoolProxiedConnection)Compiled) TypeCompiler) immutabledict) await_only)Literal) NotRequired)Protocol) TypedDict) Connection)Engine) CursorResult)URL)_ListenerFnType) dispatcher)StatementError) Executable)_InsertManyValuesBatch) DDLCompiler)IdentifierPreparer)InsertmanyvaluesSentinelOpts)Linting) SQLCompiler) BindParameter) ClauseElement)Column)DefaultGenerator) SchemaItem)Integer) _TypeMemoDict) TypeEngine_Tr)boundc@s eZdZdZdZdZdZdZdS) CacheStatsrr%rN)__name__ __module__ __qualname__ CACHE_HIT CACHE_MISSCACHING_DISABLED NO_CACHE_KEYNO_DIALECT_SUPPORTrIrIq/var/www/project2/testadmin.ninositsolution.com/venv/lib/python3.10/site-packages/sqlalchemy/engine/interfaces.pyr>Os r>c@ eZdZdZdZ dZ dZdS) ExecuteStylezVindicates the :term:`DBAPI` cursor method that will be used to invoke a statement.rr%rN)rArBrC__doc__EXECUTE EXECUTEMANYINSERTMANYVALUESrIrIrIrJrLWsrLc@sBeZdZUdZdddZdddZdd d ZdddZded<dS)DBAPIConnectionzprotocol representing a :pep:`249` database connection. .. versionadded:: 2.0 .. seealso:: `Connection Objects `_ - in :pep:`249` returnNonecCdSNrIselfrIrIrJcloseyzDBAPIConnection.closecCrTrUrIrVrIrIrJcommit{rYzDBAPIConnection.commitargsrkwargs DBAPICursorcOrTrUrI)rWr[r\rIrIrJcursor}rYzDBAPIConnection.cursorcCrTrUrIrVrIrIrJrollbackrYzDBAPIConnection.rollbackbool autocommitNrRrS)r[rr\rrRr]) rArBrCrMrXrZr^r___annotations__rIrIrIrJrQms     rQc@seZdZdZdS) DBAPITypezprotocol representing a :pep:`249` database type. .. versionadded:: 2.0 .. seealso:: `Type Objects `_ - in :pep:`249` N)rArBrCrMrIrIrIrJrdsrdc@seZdZUdZed2ddZed3ddZded <ded <d4d d Z d5d6ddZ d7ddZ d8ddZ d9d:ddZ d;d d!Z dd*d+Zd?d-d.Zd@d0d1ZdS)Ar]zprotocol representing a :pep:`249` database cursor. .. versionadded:: 2.0 .. seealso:: `Cursor Objects `_ - in :pep:`249` rR_DBAPICursorDescriptioncCdS)zThe description attribute of the Cursor. .. seealso:: `cursor.description `_ - in :pep:`249` NrIrVrIrIrJ descriptions zDBAPICursor.descriptionintcCrTrUrIrVrIrIrJrowcountszDBAPICursor.rowcount arraysize lastrowidrScCrTrUrIrVrIrIrJrXrYzDBAPICursor.closeN operationr parameters#Optional[_DBAPISingleExecuteParams]cCrTrUrIrWrlrmrIrIrJexecutezDBAPICursor.execute_DBAPIMultiExecuteParamscCrTrUrIrorIrIrJ executemanyrqzDBAPICursor.executemany Optional[Any]cCrTrUrIrVrIrIrJfetchonerYzDBAPICursor.fetchone.size Sequence[Any]cCrTrUrI)rWrvrIrIrJ fetchmanyrYzDBAPICursor.fetchmanycCrTrUrIrVrIrIrJfetchallrYzDBAPICursor.fetchallsizescCrTrUrI)rWrzrIrIrJ setinputsizesrYzDBAPICursor.setinputsizescolumncCrTrUrI)rWrvr|rIrIrJ setoutputsizerYzDBAPICursor.setoutputsizeprocnamestrcCrTrUrI)rWr~rmrIrIrJcallprocszDBAPICursor.callprocOptional[bool]cCrTrUrIrVrIrIrJnextsetrYzDBAPICursor.nextsetkeycCrTrUrI)rWrrIrIrJ __getattr__rYzDBAPICursor.__getattr__)rRre)rRrhrbrU)rlrrmrnrRr)rlrrmrrrRr)rRrt).)rvrhrRrw)rRrw)rzrwrRrS)rvrr|rrRrS)r~rrmrwrRr)rRr)rrrRr)rArBrCrMpropertyrgrircrXrprsrurxryr{r}rrrrIrIrIrJr]s*           r]r)qmarknumericnamedformatpyformatnumeric_dollarTypeEngine[Any]) SERIALIZABLEzREPEATABLE READzREAD COMMITTEDzREAD UNCOMMITTED AUTOCOMMITc@s^eZdZUded<ded<ded<ded<ded <d ed <d ed <d ed <ded<ded<dS)_CoreKnownExecutionOptionszOptional[CompiledCacheType]compiled_cacher logging_tokenIsolationLevelisolation_levelr` no_parametersstream_resultsrhmax_row_buffer yield_perinsertmanyvalues_page_sizez Optional[SchemaTranslateMapType]schema_translate_mappreserve_rowcountN)rArBrCrcrIrIrIrJrs  rF)totalc@s~eZdZUdZded< ded< ded< ded< ded< ded < ded < ded < ded < d ed< ded<dS)ReflectedIdentitya&represent the reflected IDENTITY structure of a column, corresponding to the :class:`_schema.Identity` construct. The :class:`.ReflectedIdentity` structure is part of the :class:`.ReflectedColumn` structure, which is returned by the :meth:`.Inspector.get_columns` method. r`alwayson_nullrhstart incrementminvaluemaxvalue nominvalue nomaxvaluecycle Optional[int]cacheorderNrArBrCrMrcrIrIrIrJrs0  rc@$eZdZUdZded< ded<dS)ReflectedComputeda%Represent the reflected elements of a computed column, corresponding to the :class:`_schema.Computed` construct. The :class:`.ReflectedComputed` structure is part of the :class:`.ReflectedColumn` structure, which is returned by the :meth:`.Inspector.get_columns` method. rsqltextNotRequired[bool] persistedNrrIrIrIrJrHs  rc@sjeZdZUdZded< ded< ded< ded < d ed < d ed < ded< ded< ded<dS)ReflectedColumnzDictionary representing the reflected elements corresponding to a :class:`_schema.Column` object. The :class:`.ReflectedColumn` structure is returned by the :class:`.Inspector.get_columns` method. rnamertyper`nullable Optional[str]defaultr autoincrementNotRequired[Optional[str]]commentzNotRequired[ReflectedComputed]computedzNotRequired[ReflectedIdentity]identityNotRequired[Dict[str, Any]]dialect_optionsNrrIrIrIrJrZs(  rc@r)ReflectedConstraintzDictionary representing the reflected elements corresponding to :class:`.Constraint` A base class for all constraints rrrrNrrIrIrIrJrs rc@r)ReflectedCheckConstraintzDictionary representing the reflected elements corresponding to :class:`.CheckConstraint`. The :class:`.ReflectedCheckConstraint` structure is returned by the :meth:`.Inspector.get_check_constraints` method. rrrrNrrIrIrIrJr rc@s.eZdZUdZded< ded< ded<dS) ReflectedUniqueConstraintzDictionary representing the reflected elements corresponding to :class:`.UniqueConstraint`. The :class:`.ReflectedUniqueConstraint` structure is returned by the :meth:`.Inspector.get_unique_constraints` method. List[str] column_namesrduplicates_indexrrNrrIrIrIrJrs rc@r)ReflectedPrimaryKeyConstraintzDictionary representing the reflected elements corresponding to :class:`.PrimaryKeyConstraint`. The :class:`.ReflectedPrimaryKeyConstraint` structure is returned by the :meth:`.Inspector.get_pk_constraint` method. rconstrained_columnsrrNrrIrIrIrJrrrc@sBeZdZUdZded< ded< ded< ded< d ed <d S) ReflectedForeignKeyConstraintzDictionary representing the reflected elements corresponding to :class:`.ForeignKeyConstraint`. The :class:`.ReflectedForeignKeyConstraint` structure is returned by the :meth:`.Inspector.get_foreign_keys` method. rrrreferred_schemarreferred_tablereferred_columnsroptionsNrrIrIrIrJrs rc@s`eZdZUdZded< ded< ded< ded < d ed < ded < d ed< ded<dS)ReflectedIndexzDictionary representing the reflected elements corresponding to :class:`.Index`. The :class:`.ReflectedIndex` structure is returned by the :meth:`.Inspector.get_indexes` method. rrzList[Optional[str]]rzNotRequired[List[str]] expressionsr`uniquerduplicates_constraintinclude_columnsz"NotRequired[Dict[str, Tuple[str]]]column_sortingrrNrrIrIrIrJrs$  rc@eZdZUdZded<dS)ReflectedTableCommentzDictionary representing the reflected comment corresponding to the :attr:`_schema.Table.comment` attribute. The :class:`.ReflectedTableComment` structure is returned by the :meth:`.Inspector.get_table_comment` method. rtextNrrIrIrIrJr&s rc@rK) BindTypingzDefine different methods of passing typing information for bound parameters in a statement to the database driver. .. versionadded:: 2.0 r%rr?N)rArBrCrMNONE SETINPUTSIZES RENDER_CASTSrIrIrIrJr3sr.c@seZdZUdZejZejZejZejZej Z de d<de d< de d< de d<de d < e j d^d d Z de d< de d< de d<de d< de d< de d< de d< de d< de d< de d < d!e d"< d#e d$< d%e d&< d%e d'<d(e d)< d*e d+< de d,< d-e d.< d/e d0< d/e d1< de d2< de d3< de d4< de d5< de d6< de d7< de d8< d9Zde d:< de d;< de d<< de d=< de d>< de d?< de d@< de dA< dBe dC< d-e dD< d-e dE< de dF< de dG< de dH< de dI< de dJ< de dK< de dL< de dM< de dN< dOe dP< de dQ< de dR< d-e dS< de dT< de dU< de dV< de dW< de dX< dYZdZe d[< d\Zd]e d^< e jZd_e d`< de da< de db< de dc< ddZdeZde df< de dg< ejZ de dh< de di< dje dk< d/e dl< dme dn< dme do< de dp< de dq< de dr< de ds<dte du<d_dwdxZd`d|d}Zed^d~dZdaddZdbddZerdcddZ YdddeddZ dYdYddfddZ! YdddgddZ"dYdYddhddZ# YdddiddZ$dYdYddjddZ% YdddkddZ& YdddkddZ' YdddkddZ( YdddkddZ) YdddkddZ* YdddkddZ+dlddZ, YdddmddZ- YdddnddZ.dYdYddoddZ/ YdddpddZ0dYdYddqddZ1 YdddrddĄZ2dYdYddsddDŽZ3 YdddtddʄZ4dYdYddudd̈́Z5 YdddvddЄZ6dYdYddwddӄZ7dxddՄZ8dxddׄZ9 YdddyddلZ: Ydddzdd܄Z; Yddd{dd߄Z<d|ddZ=d}ddZ>d~ddZ?dddZ@dddZAdddZBdddZCdddZDdddZEdddZFdddZGdddZHdddZIdddZJdddZKdd d ZLdd d ZM e dddddZN e dddddZOdddZPdddZQ Yddddd ZR Ydddd"d#ZS Ydddd$d%ZTdd*d+ZUdd.d/ZVdd1d2ZWdd3d4ZXdd5d6ZYdd9d:ZZdd;d<Z[dd>d?Z\ddAdBZ]ddCdDZ^eddFdGZ_eddHdIZ`eddJdKZaeddNdOZbddPdQZcddTdUZdddVdWZeddYdZZfdd\d]ZgdYS(DialectaeDefine the behavior of a specific database and DB-API combination. Any aspect of metadata definition, SQL query generation, execution, result-set handling, or anything else which varies between databases is defined under the general category of the Dialect. The Dialect acts as a factory for other database-specific object implementations including ExecutionContext, Compiled, DefaultGenerator, and TypeEngine. .. note:: Third party dialects should not subclass :class:`.Dialect` directly. Instead, subclass :class:`.default.DefaultDialect` or descendant class. zdispatcher[Dialect]dispatchrrdriverdialect_descriptionzOptional[ModuleType]dbapirRrcCt)zsame as .dbapi, but is never None; will raise an error if no DBAPI was set up. .. versionadded:: 2.0 NotImplementedErrorrVrIrIrJ loaded_dbapizDialect.loaded_dbapir` positional paramstyler2compiler_lintingzType[SQLCompiler]statement_compilerzType[DDLCompiler] ddl_compilerzClassVar[Type[TypeCompiler]]type_compiler_clsrtype_compiler_instancer type_compilerzType[IdentifierPreparer]preparerr0identifier_preparerzOptional[Tuple[Any, ...]]server_version_infordefault_schema_namezOptional[IsolationLevel]default_isolation_level_on_connect_isolation_levelzType[ExecutionContext]execution_ctx_clsz4Union[Type[Tuple[Any, ...]], Type[Tuple[List[Any]]]]execute_sequence_formatsupports_alterrhmax_identifier_lengthrmax_index_name_lengthmax_constraint_name_lengthsupports_server_side_cursorsserver_side_cursorssupports_sane_rowcountsupports_sane_multi_rowcountsupports_empty_insertsupports_default_valuessupports_default_metavalueDEFAULTdefault_metavalue_tokensupports_multivalues_insertinsert_executemany_returning4insert_executemany_returning_sort_by_parameter_orderupdate_executemany_returningdelete_executemany_returninguse_insertmanyvalues!use_insertmanyvalues_wo_returningr1"insertmanyvalues_implicit_sentinelrinsertmanyvalues_max_parameters"preexecute_autoincrement_sequencesinsert_returningupdate_returningupdate_returning_multifromdelete_returningdelete_returning_multifromfavor_returning_over_lastrowidsupports_identity_columnscte_follows_insertzIterable[Tuple[TableKey, List[ReflectedForeignKeyConstraint]]]cKr)aReturn information about foreign_keys in all tables in the given ``schema``. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_multi_foreign_keys`. .. note:: The :class:`_engine.DefaultDialect` provides a default implementation that will call the single table method for each object returned by :meth:`Dialect.get_table_names`, :meth:`Dialect.get_view_names` or :meth:`Dialect.get_materialized_view_names` depending on the provided ``kind``. Dialects that want to support a faster implementation should implement this method. .. versionadded:: 2.0 rrKrIrIrJget_multi_foreign_keysrMzDialect.get_multi_foreign_keysrcKr)zReturn a list of table names for ``schema``. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_table_names`. rrWr<rBrCrIrIrJget_table_names zDialect.get_table_namescKr)zReturn a list of temporary table names on the given connection, if supported by the underlying backend. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_temp_table_names`. rrWrIrIrJget_temp_table_names zDialect.get_temp_table_namescKr)aReturn a list of all non-materialized view names available in the database. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_view_names`. :param schema: schema name to query, if not the default schema. rrWrIrIrJget_view_names zDialect.get_view_namescKr)aFReturn a list of all materialized view names available in the database. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_materialized_view_names`. :param schema: schema name to query, if not the default schema. .. versionadded:: 2.0 rrWrIrIrJget_materialized_view_namesz#Dialect.get_materialized_view_namescKr)a*Return a list of all sequence names available in the database. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_sequence_names`. :param schema: schema name to query, if not the default schema. .. versionadded:: 1.4 rrWrIrIrJget_sequence_namesr]zDialect.get_sequence_namescKr)zReturn a list of temporary view names on the given connection, if supported by the underlying backend. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_temp_view_names`. rrWrIrIrJget_temp_view_namesr[zDialect.get_temp_view_namescKr)zReturn a list of all schema names available in the database. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_schema_names`. r)rWr<rCrIrIrJget_schema_nameszDialect.get_schema_names view_namecKr)aGReturn plain or materialized view definition. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_view_definition`. Given a :class:`_engine.Connection`, a string ``view_name``, and an optional string ``schema``, return the view definition. r)rWr<rdrBrCrIrIrJget_view_definitionzDialect.get_view_definitionList[ReflectedIndex]cKr)aReturn information about indexes in ``table_name``. Given a :class:`_engine.Connection`, a string ``table_name`` and an optional string ``schema``, return index information as a list of dictionaries corresponding to the :class:`.ReflectedIndex` dictionary. This is an internal dialect method. Applications should use :meth:`.Inspector.get_indexes`. rrErIrIrJ get_indexesrTzDialect.get_indexes/Iterable[Tuple[TableKey, List[ReflectedIndex]]]cKr)aReturn information about indexes in in all tables in the given ``schema``. This is an internal dialect method. Applications should use :meth:`.Inspector.get_multi_indexes`. .. note:: The :class:`_engine.DefaultDialect` provides a default implementation that will call the single table method for each object returned by :meth:`Dialect.get_table_names`, :meth:`Dialect.get_view_names` or :meth:`Dialect.get_materialized_view_names` depending on the provided ``kind``. Dialects that want to support a faster implementation should implement this method. .. versionadded:: 2.0 rrKrIrIrJget_multi_indexes$rMzDialect.get_multi_indexesList[ReflectedUniqueConstraint]cKr)aReturn information about unique constraints in ``table_name``. Given a string ``table_name`` and an optional string ``schema``, return unique constraint information as a list of dicts corresponding to the :class:`.ReflectedUniqueConstraint` dictionary. This is an internal dialect method. Applications should use :meth:`.Inspector.get_unique_constraints`. rrErIrIrJget_unique_constraints@rfzDialect.get_unique_constraints:Iterable[Tuple[TableKey, List[ReflectedUniqueConstraint]]]cKr)aReturn information about unique constraints in all tables in the given ``schema``. This is an internal dialect method. Applications should use :meth:`.Inspector.get_multi_unique_constraints`. .. note:: The :class:`_engine.DefaultDialect` provides a default implementation that will call the single table method for each object returned by :meth:`Dialect.get_table_names`, :meth:`Dialect.get_view_names` or :meth:`Dialect.get_materialized_view_names` depending on the provided ``kind``. Dialects that want to support a faster implementation should implement this method. .. versionadded:: 2.0 rrKrIrIrJget_multi_unique_constraintsSrMz$Dialect.get_multi_unique_constraintsList[ReflectedCheckConstraint]cKr)aReturn information about check constraints in ``table_name``. Given a string ``table_name`` and an optional string ``schema``, return check constraint information as a list of dicts corresponding to the :class:`.ReflectedCheckConstraint` dictionary. This is an internal dialect method. Applications should use :meth:`.Inspector.get_check_constraints`. rrErIrIrJget_check_constraintsorTzDialect.get_check_constraints9Iterable[Tuple[TableKey, List[ReflectedCheckConstraint]]]cKr)aReturn information about check constraints in all tables in the given ``schema``. This is an internal dialect method. Applications should use :meth:`.Inspector.get_multi_check_constraints`. .. note:: The :class:`_engine.DefaultDialect` provides a default implementation that will call the single table method for each object returned by :meth:`Dialect.get_table_names`, :meth:`Dialect.get_view_names` or :meth:`Dialect.get_materialized_view_names` depending on the provided ``kind``. Dialects that want to support a faster implementation should implement this method. .. versionadded:: 2.0 rrKrIrIrJget_multi_check_constraintsrMz#Dialect.get_multi_check_constraintsDict[str, Any]cKr)zReturn a dictionary of options specified when ``table_name`` was created. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_table_options`. rrErIrIrJget_table_optionsr]zDialect.get_table_options)Iterable[Tuple[TableKey, Dict[str, Any]]]cKr)aReturn a dictionary of options specified when the tables in the given schema were created. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_multi_table_options`. .. note:: The :class:`_engine.DefaultDialect` provides a default implementation that will call the single table method for each object returned by :meth:`Dialect.get_table_names`, :meth:`Dialect.get_view_names` or :meth:`Dialect.get_materialized_view_names` depending on the provided ``kind``. Dialects that want to support a faster implementation should implement this method. .. versionadded:: 2.0 rrKrIrIrJget_multi_table_optionsrQzDialect.get_multi_table_optionsrcKr)aReturn the "comment" for the table identified by ``table_name``. Given a string ``table_name`` and an optional string ``schema``, return table comment information as a dictionary corresponding to the :class:`.ReflectedTableComment` dictionary. This is an internal dialect method. Applications should use :meth:`.Inspector.get_table_comment`. :raise: ``NotImplementedError`` for dialects that don't support comments. .. versionadded:: 1.2 rrErIrIrJget_table_commentszDialect.get_table_comment0Iterable[Tuple[TableKey, ReflectedTableComment]]cKr)aReturn information about the table comment in all tables in the given ``schema``. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_multi_table_comment`. .. note:: The :class:`_engine.DefaultDialect` provides a default implementation that will call the single table method for each object returned by :meth:`Dialect.get_table_names`, :meth:`Dialect.get_view_names` or :meth:`Dialect.get_materialized_view_names` depending on the provided ``kind``. Dialects that want to support a faster implementation should implement this method. .. versionadded:: 2.0 rrKrIrIrJget_multi_table_commentrMzDialect.get_multi_table_commentcCr)zconvert the given name to lowercase if it is detected as case insensitive. This method is only used if the dialect defines requires_name_normalize=True. rrWrrIrIrJnormalize_namerzDialect.normalize_namecCr)zconvert the given name to a case insensitive identifier for the backend if it is an all-lowercase name. This method is only used if the dialect defines requires_name_normalize=True. rrzrIrIrJdenormalize_namerzDialect.denormalize_namecKr)aFor internal dialect use, check the existence of a particular table or view in the database. Given a :class:`_engine.Connection` object, a string table_name and optional schema name, return True if the given table exists in the database, False otherwise. This method serves as the underlying implementation of the public facing :meth:`.Inspector.has_table` method, and is also used internally to implement the "checkfirst" behavior for methods like :meth:`_schema.Table.create` and :meth:`_schema.MetaData.create_all`. .. note:: This method is used internally by SQLAlchemy, and is published so that third-party dialects may provide an implementation. It is **not** the public API for checking for table presence. Please use the :meth:`.Inspector.has_table` method. .. versionchanged:: 2.0:: :meth:`_engine.Dialect.has_table` now formally supports checking for additional table-like objects: * any type of views (plain or materialized) * temporary tables of any kind Previously, these two checks were not formally specified and different dialects would vary in their behavior. The dialect testing suite now includes tests for all of these object types, and dialects to the degree that the backing database supports views or temporary tables should seek to support locating these objects for full compliance. rrErIrIrJ has_tables'zDialect.has_table index_namecKr)aCheck the existence of a particular index name in the database. Given a :class:`_engine.Connection` object, a string ``table_name`` and string index name, return ``True`` if an index of the given name on the given table exists, ``False`` otherwise. The :class:`.DefaultDialect` implements this in terms of the :meth:`.Dialect.has_table` and :meth:`.Dialect.get_indexes` methods, however dialects can implement a more performant version. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.has_index`. .. versionadded:: 1.4 r)rWr<rAr~rBrCrIrIrJ has_index;rQzDialect.has_index sequence_namecKr)apCheck the existence of a particular sequence in the database. Given a :class:`_engine.Connection` object and a string `sequence_name`, return ``True`` if the given sequence exists in the database, ``False`` otherwise. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.has_sequence`. r)rWr<rrBrCrIrIrJ has_sequenceVrfzDialect.has_sequence schema_namecKr)avCheck the existence of a particular schema name in the database. Given a :class:`_engine.Connection` object, a string ``schema_name``, return ``True`` if a schema of the given exists, ``False`` otherwise. The :class:`.DefaultDialect` implements this by checking the presence of ``schema_name`` among the schemas returned by :meth:`.Dialect.get_schema_names`, however dialects can implement a more performant version. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.has_schema`. .. versionadded:: 2.0 r)rWr<rrCrIrIrJ has_schemaiszDialect.has_schemacCr)zRetrieve the server version info from the given connection. This is used by the default implementation to populate the "server_version_info" attribute and is called exactly once upon first connect. rr=rIrIrJ_get_server_version_info z Dialect._get_server_version_infocCr)aReturn the string name of the currently selected schema from the given connection. This is used by the default implementation to populate the "default_schema_name" attribute and is called exactly once upon first connect. rr=rIrIrJ_get_default_schema_namerYz Dialect._get_default_schema_namedbapi_connectionrcCr)aProvide an implementation of ``connection.begin()``, given a DB-API connection. The DBAPI has no dedicated "begin" method and it is expected that transactions are implicit. This hook is provided for those DBAPIs that might need additional help in this area. :param dbapi_connection: a DBAPI connection, typically proxied within a :class:`.ConnectionFairy`. rrWrrIrIrJdo_beginr]zDialect.do_begincCr)zProvide an implementation of ``connection.rollback()``, given a DB-API connection. :param dbapi_connection: a DBAPI connection, typically proxied within a :class:`.ConnectionFairy`. rrrIrIrJ do_rollbackrzDialect.do_rollbackcCr)zProvide an implementation of ``connection.commit()``, given a DB-API connection. :param dbapi_connection: a DBAPI connection, typically proxied within a :class:`.ConnectionFairy`. rrrIrIrJ do_commitrzDialect.do_commitrQcCr)aProvide an implementation of ``connection.close()`` that tries as much as possible to not block, given a DBAPI connection. In the vast majority of cases this just calls .close(), however for some asyncio dialects may call upon different API features. This hook is called by the :class:`_pool.Pool` when a connection is being recycled or has been invalidated. .. versionadded:: 1.4.41 rrrIrIrJ do_terminater_zDialect.do_terminatecCr)a Provide an implementation of ``connection.close()``, given a DBAPI connection. This hook is called by the :class:`_pool.Pool` when a connection has been detached from the pool, or is being returned beyond the normal capacity of the pool. rrrIrIrJdo_closer[zDialect.do_closecCrrUrrrIrIrJ_do_ping_w_eventr/zDialect._do_ping_w_eventcCr)zNping the DBAPI connection and return True if the connection is usable.rrrIrIrJdo_pingzDialect.do_pingr^r]list_of_tuples_GenericSetInputSizesTypecontextExecutionContextcCr)aJinvoke the cursor.setinputsizes() method with appropriate arguments This hook is called if the :attr:`.Dialect.bind_typing` attribute is set to the :attr:`.BindTyping.SETINPUTSIZES` value. Parameter data is passed in a list of tuples (paramname, dbtype, sqltype), where ``paramname`` is the key of the parameter in the statement, ``dbtype`` is the DBAPI datatype and ``sqltype`` is the SQLAlchemy type. The order of tuples is in the correct parameter order. .. versionadded:: 1.4 .. versionchanged:: 2.0 - setinputsizes mode is now enabled by setting :attr:`.Dialect.bind_typing` to :attr:`.BindTyping.SETINPUTSIZES`. Dialects which accept a ``use_setinputsizes`` parameter should set this value appropriately. r)rWr^rrrIrIrJdo_set_input_sizesrMzDialect.do_set_input_sizescCr)zCreate a two-phase transaction ID. This id will be passed to do_begin_twophase(), do_rollback_twophase(), do_commit_twophase(). Its format is unspecified. rrVrIrIrJ create_xidrzDialect.create_xidcCr)zCreate a savepoint with the given name. :param connection: a :class:`_engine.Connection`. :param name: savepoint name. rrWr<rrIrIrJ do_savepointrzDialect.do_savepointcCr)zRollback a connection to the named savepoint. :param connection: a :class:`_engine.Connection`. :param name: savepoint name. rrrIrIrJdo_rollback_to_savepointrYz Dialect.do_rollback_to_savepointcCr)zRelease the named savepoint on a connection. :param connection: a :class:`_engine.Connection`. :param name: savepoint name. rrrIrIrJdo_release_savepointszDialect.do_release_savepointxidcCr)zBegin a two phase transaction on the given connection. :param connection: a :class:`_engine.Connection`. :param xid: xid rrWr<rrIrIrJdo_begin_twophase'rzDialect.do_begin_twophasecCr)zPrepare a two phase transaction on the given connection. :param connection: a :class:`_engine.Connection`. :param xid: xid rrrIrIrJdo_prepare_twophase1rzDialect.do_prepare_twophase is_preparedrecovercCr)a3Rollback a two phase transaction on the given connection. :param connection: a :class:`_engine.Connection`. :param xid: xid :param is_prepared: whether or not :meth:`.TwoPhaseTransaction.prepare` was called. :param recover: if the recover flag was passed. rrWr<rrrrIrIrJdo_rollback_twophase;rfzDialect.do_rollback_twophasecCr)a2Commit a two phase transaction on the given connection. :param connection: a :class:`_engine.Connection`. :param xid: xid :param is_prepared: whether or not :meth:`.TwoPhaseTransaction.prepare` was called. :param recover: if the recover flag was passed. rrrIrIrJdo_commit_twophaseNrTzDialect.do_commit_twophase List[Any]cCr)zRecover list of uncommitted prepared two phase transaction identifiers on the given connection. :param connection: a :class:`_engine.Connection`. rr=rIrIrJdo_recover_twophasebrzDialect.do_recover_twophase statementrmrrgeneric_setinputsizes#Optional[_GenericSetInputSizesType] Iterator[_InsertManyValuesBatch]cCr)zconvert executemany parameters for an INSERT into an iterator of statement/single execute values, used by the insertmanyvalues feature. r)rWr<r^rrmrrrIrIrJ!_deliver_insertmanyvalues_batcheslsz)Dialect._deliver_insertmanyvalues_batchesOptional[ExecutionContext]cCr)zSProvide an implementation of ``cursor.executemany(statement, parameters)``.rrWr^rrmrrIrIrJdo_executemany|rYzDialect.do_executemanyrncCr)zOProvide an implementation of ``cursor.execute(statement, parameters)``.rrrIrIrJ do_executerYzDialect.do_executecCr)z{Provide an implementation of ``cursor.execute(statement)``. The parameter collection should not be sent. r)rWr^rrrIrIrJdo_execute_no_paramsr;zDialect.do_execute_no_paramse Exception7Optional[Union[PoolProxiedConnection, DBAPIConnection]]Optional[DBAPICursor]cCr)zMReturn True if the given DB-API error indicates an invalid connectionr)rWrr<r^rIrIrJ is_disconnectrzDialect.is_disconnectcargscparamscOr)aEstablish a connection using this dialect's DBAPI. The default implementation of this method is:: def connect(self, *cargs, **cparams): return self.dbapi.connect(*cargs, **cparams) The ``*cargs, **cparams`` parameters are generated directly from this dialect's :meth:`.Dialect.create_connect_args` method. This method may be used for dialects that need to perform programmatic per-connection steps when a new connection is procured from the DBAPI. :param \*cargs: positional parameters returned from the :meth:`.Dialect.create_connect_args` method :param \*\*cparams: keyword parameters returned from the :meth:`.Dialect.create_connect_args` method. :return: a DBAPI connection, typically from the :pep:`249` module level ``.connect()`` function. .. seealso:: :meth:`.Dialect.create_connect_args` :meth:`.Dialect.on_connect` r)rWrrrIrIrJconnect zDialect.connectOptional[Callable[[Any], Any]]cCs|S)a& return a callable which sets up a newly created DBAPI connection. This method is a new hook that supersedes the :meth:`_engine.Dialect.on_connect` method when implemented by a dialect. When not implemented by a dialect, it invokes the :meth:`_engine.Dialect.on_connect` method directly to maintain compatibility with existing dialects. There is no deprecation for :meth:`_engine.Dialect.on_connect` expected. The callable should accept a single argument "conn" which is the DBAPI connection itself. The inner callable has no return value. E.g.:: class MyDialect(default.DefaultDialect): # ... def on_connect_url(self, url): def do_on_connect(connection): connection.execute("SET SPECIAL FLAGS etc") return do_on_connect This is used to set dialect-wide per-connection options such as isolation modes, Unicode modes, etc. This method differs from :meth:`_engine.Dialect.on_connect` in that it is passed the :class:`_engine.URL` object that's relevant to the connect args. Normally the only way to get this is from the :meth:`_engine.Dialect.on_connect` hook is to look on the :class:`_engine.Engine` itself, however this URL object may have been replaced by plugins. .. note:: The default implementation of :meth:`_engine.Dialect.on_connect_url` is to invoke the :meth:`_engine.Dialect.on_connect` method. Therefore if a dialect implements this method, the :meth:`_engine.Dialect.on_connect` method **will not be called** unless the overriding dialect calls it directly from here. .. versionadded:: 1.4.3 added :meth:`_engine.Dialect.on_connect_url` which normally calls into :meth:`_engine.Dialect.on_connect`. :param url: a :class:`_engine.URL` object representing the :class:`_engine.URL` that was passed to the :meth:`_engine.Dialect.create_connect_args` method. :return: a callable that accepts a single DBAPI connection as an argument, or None. .. seealso:: :meth:`_engine.Dialect.on_connect` ) on_connectr2rIrIrJon_connect_urls;zDialect.on_connect_urlcCrf)areturn a callable which sets up a newly created DBAPI connection. The callable should accept a single argument "conn" which is the DBAPI connection itself. The inner callable has no return value. E.g.:: class MyDialect(default.DefaultDialect): # ... def on_connect(self): def do_on_connect(connection): connection.execute("SET SPECIAL FLAGS etc") return do_on_connect This is used to set dialect-wide per-connection options such as isolation modes, Unicode modes, etc. The "do_on_connect" callable is invoked by using the :meth:`_events.PoolEvents.connect` event hook, then unwrapping the DBAPI connection and passing it into the callable. .. versionchanged:: 1.4 the on_connect hook is no longer called twice for the first connection of a dialect. The on_connect hook is still called before the :meth:`_engine.Dialect.initialize` method however. .. versionchanged:: 1.4.3 the on_connect hook is invoked from a new method on_connect_url that passes the URL that was used to create the connect args. Dialects can implement on_connect_url instead of on_connect if they need the URL object that was used for the connection in order to get additional context. If None is returned, no event listener is generated. :return: a callable that accepts a single DBAPI connection as an argument, or None. .. seealso:: :meth:`.Dialect.connect` - allows the DBAPI ``connect()`` sequence itself to be controlled. :meth:`.Dialect.on_connect_url` - supersedes :meth:`.Dialect.on_connect` to also receive the :class:`_engine.URL` object in context. NrIrVrIrIrJr s3zDialect.on_connectcCr)a2Given a DBAPI connection, revert its isolation to the default. Note that this is a dialect-level method which is used as part of the implementation of the :class:`_engine.Connection` and :class:`_engine.Engine` isolation level facilities; these APIs should be preferred for most typical use cases. .. seealso:: :meth:`_engine.Connection.get_isolation_level` - view current level :attr:`_engine.Connection.default_isolation_level` - view default level :paramref:`.Connection.execution_options.isolation_level` - set per :class:`_engine.Connection` isolation level :paramref:`_sa.create_engine.isolation_level` - set per :class:`_engine.Engine` isolation level rrrIrIrJreset_isolation_levelA rQzDialect.reset_isolation_levellevelrcCr)a2Given a DBAPI connection, set its isolation level. Note that this is a dialect-level method which is used as part of the implementation of the :class:`_engine.Connection` and :class:`_engine.Engine` isolation level facilities; these APIs should be preferred for most typical use cases. If the dialect also implements the :meth:`.Dialect.get_isolation_level_values` method, then the given level is guaranteed to be one of the string names within that sequence, and the method will not need to anticipate a lookup failure. .. seealso:: :meth:`_engine.Connection.get_isolation_level` - view current level :attr:`_engine.Connection.default_isolation_level` - view default level :paramref:`.Connection.execution_options.isolation_level` - set per :class:`_engine.Connection` isolation level :paramref:`_sa.create_engine.isolation_level` - set per :class:`_engine.Engine` isolation level r)rWrrrIrIrJset_isolation_level\ rzDialect.set_isolation_levelcCr)aGiven a DBAPI connection, return its isolation level. When working with a :class:`_engine.Connection` object, the corresponding DBAPI connection may be procured using the :attr:`_engine.Connection.connection` accessor. Note that this is a dialect-level method which is used as part of the implementation of the :class:`_engine.Connection` and :class:`_engine.Engine` isolation level facilities; these APIs should be preferred for most typical use cases. .. seealso:: :meth:`_engine.Connection.get_isolation_level` - view current level :attr:`_engine.Connection.default_isolation_level` - view default level :paramref:`.Connection.execution_options.isolation_level` - set per :class:`_engine.Connection` isolation level :paramref:`_sa.create_engine.isolation_level` - set per :class:`_engine.Engine` isolation level rrrIrIrJget_isolation_level~ s!zDialect.get_isolation_level dbapi_conncCr)aGiven a DBAPI connection, return its isolation level, or a default isolation level if one cannot be retrieved. This method may only raise NotImplementedError and **must not raise any other exception**, as it is used implicitly upon first connect. The method **must return a value** for a dialect that supports isolation level settings, as this level is what will be reverted towards when a per-connection isolation level change is made. The method defaults to using the :meth:`.Dialect.get_isolation_level` method unless overridden by a dialect. .. versionadded:: 1.3.22 rrWrrIrIrJget_default_isolation_level sz#Dialect.get_default_isolation_levelSequence[IsolationLevel]cCr)areturn a sequence of string isolation level names that are accepted by this dialect. The available names should use the following conventions: * use UPPERCASE names. isolation level methods will accept lowercase names but these are normalized into UPPERCASE before being passed along to the dialect. * separate words should be separated by spaces, not underscores, e.g. ``REPEATABLE READ``. isolation level names will have underscores converted to spaces before being passed along to the dialect. * The names for the four standard isolation names to the extent that they are supported by the backend should be ``READ UNCOMMITTED``, ``READ COMMITTED``, ``REPEATABLE READ``, ``SERIALIZABLE`` * if the dialect supports an autocommit option it should be provided using the isolation level name ``AUTOCOMMIT``. * Other isolation modes may also be present, provided that they are named in UPPERCASE and use spaces not underscores. This function is used so that the default dialect can check that a given isolation level parameter is valid, else raises an :class:`_exc.ArgumentError`. A DBAPI connection is passed to the method, in the unlikely event that the dialect needs to interrogate the connection itself to determine this list, however it is expected that most backends will return a hardcoded list of values. If the dialect supports "AUTOCOMMIT", that value should also be present in the sequence returned. The method raises ``NotImplementedError`` by default. If a dialect does not implement this method, then the default dialect will not perform any checking on a given isolation level value before passing it onto the :meth:`.Dialect.set_isolation_level` method. This is to allow backwards-compatibility with third party dialects that may not yet be implementing this method. .. versionadded:: 2.0 rrrIrIrJget_isolation_level_values s*z"Dialect.get_isolation_level_valuescCrrUr)rWrrrIrIrJ_assert_and_set_isolation_level rz'Dialect._assert_and_set_isolation_level Type[Dialect]cCs|S)a}Given a URL, return the :class:`.Dialect` that will be used. This is a hook that allows an external plugin to provide functionality around an existing dialect, by allowing the plugin to be loaded from the url based on an entrypoint, and then the plugin returns the actual dialect to be used. By default this just returns the cls. rIr5r0rIrIrJget_dialect_cls s zDialect.get_dialect_clscCs ||S)aGiven a URL, return the :class:`.Dialect` that will be used by an async engine. By default this is an alias of :meth:`.Dialect.get_dialect_cls` and just returns the cls. It may be used if a dialect provides both a sync and async version under the same name, like the ``psycopg`` driver. .. versionadded:: 2 .. seealso:: :meth:`.Dialect.get_dialect_cls` )rrrIrIrJget_async_dialect_cls s zDialect.get_async_dialect_clscCrf)aJset up the provision.py module for this dialect. For dialects that include a provision.py module that sets up provisioning followers, this method should initiate that process. A typical implementation would be:: @classmethod def load_provisioning(cls): __import__("mydialect.provision") The default method assumes a module named ``provision.py`` inside the owning package of the current dialect, based on the ``__module__`` attribute:: @classmethod def load_provisioning(cls): package = ".".join(cls.__module__.split(".")[0:-1]) try: __import__(package + ".provision") except ImportError: pass .. versionadded:: 1.3.14 NrIr4rIrIrJload_provisioning rYzDialect.load_provisioningenginer'cCrf)a_A convenience hook called before returning the final :class:`_engine.Engine`. If the dialect returned a different class from the :meth:`.get_dialect_cls` method, then the hook is called on both classes, first on the dialect class returned by the :meth:`.get_dialect_cls` method and then on the class on which the method was called. The hook should be used by dialects and/or wrappers to apply special events to the engine or its components. In particular, it allows a dialect-wrapping class to apply dialect-level events. NrI)r5rrIrIrJengine_created& rYzDialect.engine_createdcCr)aReturns the connection object as returned by the external driver package. For normal dialects that use a DBAPI compliant driver this call will just return the ``connection`` passed as argument. For dialects that instead adapt a non DBAPI compliant driver, like when adapting an asyncio driver, this call will return the connection-like object as returned by the driver. .. versionadded:: 1.4.24 rr=rIrIrJget_driver_connection7 r]zDialect.get_driver_connectionoptsCoreExecuteOptionsParametercCr)aaEstablish execution options for a given engine. This is implemented by :class:`.DefaultDialect` to establish event hooks for new :class:`.Connection` instances created by the given :class:`.Engine` which will then invoke the :meth:`.Dialect.set_connection_execution_options` method for that connection. r)rWrrrIrIrJset_engine_execution_optionsF r;z$Dialect.set_engine_execution_optionscCr)aEstablish execution options for a given connection. This is implemented by :class:`.DefaultDialect` in order to implement the :paramref:`_engine.Connection.execution_options.isolation_level` execution option. Dialects can intercept various execution options which may need to modify state on a particular DBAPI connection. .. versionadded:: 1.4 r)rWr<rrIrIrJ set_connection_execution_optionsT r]z(Dialect.set_connection_execution_options Type[Pool]cCr)z*return a Pool class to use for a given URLrr2rIrIrJget_dialect_pool_classc szDialect.get_dialect_pool_classidentcCrf)z=Validates an identifier name, raising an exception if invalidNrI)rWrrIrIrJvalidate_identifierg rYzDialect.validate_identifier)rRr)rRr-)r0r)rRr1)r8r9rRr9)r<r&rRrS)r?rrRr`rU) r<r&rArrBrrCrrRrD) r<r&rBrrHrIrCrrRrJ) r<r&rArrBrrCrrRr) r<r&rBrrHrIrCrrRrO) r<r&rArrBrrCrrRrR) r<r&rBrrHrIrCrrRrU)r<r&rBrrCrrRr)r<r&rCrrRr) r<r&rdrrBrrCrrRr) r<r&rArrBrrCrrRrg) r<r&rBrrHrIrCrrRri) r<r&rArrBrrCrrRrk) r<r&rBrrHrIrCrrRrm) r<r&rArrBrrCrrRro) r<r&rBrrHrIrCrrRrq) r<r&rArrBrrCrrRrs) r<r&rBrrHrIrCrrRru) r<r&rArrBrrCrrRr) r<r&rBrrHrIrCrrRrx)rrrRr) r<r&rArrBrrCrrRr`) r<r&rArr~rrBrrCrrRr`) r<r&rrrBrrCrrRr`)r<r&rrrCrrRr`)r<r&rRr)r<r&rRr)rrrRrS)rrQrRrS)rrQrRr`)r^r]rrrrrRrrRr)r<r&rrrRrS)r<r&rrrRrS)TF) r<r&rrrr`rr`rRrS)r<r&rRr)r<r&r^r]rrrmrrrrrrrRr) r^r]rrrmrrrrrRrS) r^r]rrrmrnrrrRrS)r^r]rrrrrRrS)rrr<rr^rrRr`)rrrrrRrQ)r0r)rRr)rRr)rrQrrrRrS)rrQrRr)rrQrRr)rrQrRr)rrQrrrRrS)r0r)rRrrbrr'rRrS)r<rQrRr)rr'rrrRrS)r<r&rrrRrS)r0r)rRr)rrrRrS)hrArBrCrMr>rDrErFrGrHrcrnon_memoized_propertyrrrr EMPTY_DICTr _has_eventsr rr bind_typingr.r3 classmethodr6r:r>rr@rFrLrNrPrSrVrXrZr\r^r`rarbrerhrjrlrnrprrrtrvrwryr{r|r}rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrIrIrIrJrssH              !            .             "=5"#, rc@sBeZdZdZdddZdd d ZdddZdddZdddZdS) CreateEnginePluginaA set of hooks intended to augment the construction of an :class:`_engine.Engine` object based on entrypoint names in a URL. The purpose of :class:`_engine.CreateEnginePlugin` is to allow third-party systems to apply engine, pool and dialect level event listeners without the need for the target application to be modified; instead, the plugin names can be added to the database URL. Target applications for :class:`_engine.CreateEnginePlugin` include: * connection and SQL performance tools, e.g. which use events to track number of checkouts and/or time spent with statements * connectivity plugins such as proxies A rudimentary :class:`_engine.CreateEnginePlugin` that attaches a logger to an :class:`_engine.Engine` object might look like:: import logging from sqlalchemy.engine import CreateEnginePlugin from sqlalchemy import event class LogCursorEventsPlugin(CreateEnginePlugin): def __init__(self, url, kwargs): # consume the parameter "log_cursor_logging_name" from the # URL query logging_name = url.query.get( "log_cursor_logging_name", "log_cursor" ) self.log = logging.getLogger(logging_name) def update_url(self, url): "update the URL to one that no longer includes our parameters" return url.difference_update_query(["log_cursor_logging_name"]) def engine_created(self, engine): "attach an event listener after the new Engine is constructed" event.listen(engine, "before_cursor_execute", self._log_event) def _log_event( self, conn, cursor, statement, parameters, context, executemany, ): self.log.info("Plugin logged cursor event: %s", statement) Plugins are registered using entry points in a similar way as that of dialects:: entry_points = { "sqlalchemy.plugins": [ "log_cursor_plugin = myapp.plugins:LogCursorEventsPlugin" ] } A plugin that uses the above names would be invoked from a database URL as in:: from sqlalchemy import create_engine engine = create_engine( "mysql+pymysql://scott:tiger@localhost/test?" "plugin=log_cursor_plugin&log_cursor_logging_name=mylogger" ) The ``plugin`` URL parameter supports multiple instances, so that a URL may specify multiple plugins; they are loaded in the order stated in the URL:: engine = create_engine( "mysql+pymysql://scott:tiger@localhost/test?" "plugin=plugin_one&plugin=plugin_twp&plugin=plugin_three" ) The plugin names may also be passed directly to :func:`_sa.create_engine` using the :paramref:`_sa.create_engine.plugins` argument:: engine = create_engine( "mysql+pymysql://scott:tiger@localhost/test", plugins=["myplugin"] ) .. versionadded:: 1.2.3 plugin names can also be specified to :func:`_sa.create_engine` as a list A plugin may consume plugin-specific arguments from the :class:`_engine.URL` object as well as the ``kwargs`` dictionary, which is the dictionary of arguments passed to the :func:`_sa.create_engine` call. "Consuming" these arguments includes that they must be removed when the plugin initializes, so that the arguments are not passed along to the :class:`_engine.Dialect` constructor, where they will raise an :class:`_exc.ArgumentError` because they are not known by the dialect. As of version 1.4 of SQLAlchemy, arguments should continue to be consumed from the ``kwargs`` dictionary directly, by removing the values with a method such as ``dict.pop``. Arguments from the :class:`_engine.URL` object should be consumed by implementing the :meth:`_engine.CreateEnginePlugin.update_url` method, returning a new copy of the :class:`_engine.URL` with plugin-specific parameters removed:: class MyPlugin(CreateEnginePlugin): def __init__(self, url, kwargs): self.my_argument_one = url.query["my_argument_one"] self.my_argument_two = url.query["my_argument_two"] self.my_argument_three = kwargs.pop("my_argument_three", None) def update_url(self, url): return url.difference_update_query( ["my_argument_one", "my_argument_two"] ) Arguments like those illustrated above would be consumed from a :func:`_sa.create_engine` call such as:: from sqlalchemy import create_engine engine = create_engine( "mysql+pymysql://scott:tiger@localhost/test?" "plugin=myplugin&my_argument_one=foo&my_argument_two=bar", my_argument_three="bat", ) .. versionchanged:: 1.4 The :class:`_engine.URL` object is now immutable; a :class:`_engine.CreateEnginePlugin` that needs to alter the :class:`_engine.URL` should implement the newly added :meth:`_engine.CreateEnginePlugin.update_url` method, which is invoked after the plugin is constructed. For migration, construct the plugin in the following way, checking for the existence of the :meth:`_engine.CreateEnginePlugin.update_url` method to detect which version is running:: class MyPlugin(CreateEnginePlugin): def __init__(self, url, kwargs): if hasattr(CreateEnginePlugin, "update_url"): # detect the 1.4 API self.my_argument_one = url.query["my_argument_one"] self.my_argument_two = url.query["my_argument_two"] else: # detect the 1.3 and earlier API - mutate the # URL directly self.my_argument_one = url.query.pop("my_argument_one") self.my_argument_two = url.query.pop("my_argument_two") self.my_argument_three = kwargs.pop("my_argument_three", None) def update_url(self, url): # this method is only called in the 1.4 version return url.difference_update_query( ["my_argument_one", "my_argument_two"] ) .. seealso:: :ref:`change_5526` - overview of the :class:`_engine.URL` change which also includes notes regarding :class:`_engine.CreateEnginePlugin`. When the engine creation process completes and produces the :class:`_engine.Engine` object, it is again passed to the plugin via the :meth:`_engine.CreateEnginePlugin.engine_created` hook. In this hook, additional changes can be made to the engine, most typically involving setup of events (e.g. those defined in :ref:`core_event_toplevel`). r0r)r\rscCs ||_dS)aConstruct a new :class:`.CreateEnginePlugin`. The plugin object is instantiated individually for each call to :func:`_sa.create_engine`. A single :class:`_engine. Engine` will be passed to the :meth:`.CreateEnginePlugin.engine_created` method corresponding to this URL. :param url: the :class:`_engine.URL` object. The plugin may inspect the :class:`_engine.URL` for arguments. Arguments used by the plugin should be removed, by returning an updated :class:`_engine.URL` from the :meth:`_engine.CreateEnginePlugin.update_url` method. .. versionchanged:: 1.4 The :class:`_engine.URL` object is now immutable, so a :class:`_engine.CreateEnginePlugin` that needs to alter the :class:`_engine.URL` object should implement the :meth:`_engine.CreateEnginePlugin.update_url` method. :param kwargs: The keyword arguments passed to :func:`_sa.create_engine`. N)r0)rWr0r\rIrIrJ__init__ s zCreateEnginePlugin.__init__rRcCr)aUpdate the :class:`_engine.URL`. A new :class:`_engine.URL` should be returned. This method is typically used to consume configuration arguments from the :class:`_engine.URL` which must be removed, as they will not be recognized by the dialect. The :meth:`_engine.URL.difference_update_query` method is available to remove these arguments. See the docstring at :class:`_engine.CreateEnginePlugin` for an example. .. versionadded:: 1.4 rr2rIrIrJ update_url6 r_zCreateEnginePlugin.update_url dialect_clsr dialect_argsrScCrf)zparse and modify dialect kwargsNrI)rWrrrIrIrJhandle_dialect_kwargsG rYz(CreateEnginePlugin.handle_dialect_kwargspool_clsr pool_argscCrf)zparse and modify pool kwargsNrI)rWrrrIrIrJhandle_pool_kwargsL rYz%CreateEnginePlugin.handle_pool_kwargsrr'cCrf)zReceive the :class:`_engine.Engine` object when it is fully constructed. The plugin may make additional changes to the engine, such as registering engine or connection pool events. NrI)rWrrIrIrJrQ rYz!CreateEnginePlugin.engine_createdN)r0r)r\rs)r0r)rRr))rrrrsrRrS)rrrrsrRrSr) rArBrCrMrrrrrrIrIrIrJrk s 0   rc@s|eZdZUdZded< ded< ded< ded< d ed < d ed < d ed< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< edcd$d%Zeejfddd-d.Z eded0d1Z edfd2d3Z dgd;d<Z dhd>d?Z did@dAZdjdCdDZdkdIdJZdldKdLZdmdNdOZdndSdTZdmdUdVZdodYdZZdpd[d\Zdqd^d_Zdrd`daZdbS)srzRA messenger object for a Dialect that corresponds to a single execution. r'rr&r<root_connectionrdialectr]r^zOptional[Compiled]compiledrrzOptional[Executable]invoked_statement_AnyMultiExecuteParamsrmr`risinsertisupdaterL execute_stylersz;util.generic_fn_descriptor[Optional[Sequence[Column[Any]]]] prefetch_colspostfetch_cols_ExecuteOptionsexecution_optionsrr compiled_ddlr/rRcCrrUr)r5rr<rrrrIrIrJ _init_ddl rzExecutionContext._init_ddlr3_CoreMultiExecuteParamsr-extracted_parameters&Optional[Sequence[BindParameter[Any]]] cache_hitr>c CrrUr) r5rr<rrrrmrrrrIrIrJ_init_compiled r]zExecutionContext._init_compiledrrcCrrUr)r5rr<rrrrmrIrIrJ_init_statement rYz ExecutionContext._init_statementcCrrUr)r5rr<rrrIrIrJ _init_default rzExecutionContext._init_defaultr|Optional[Column[Any]]rr7type_Optional[TypeEngine[Any]]rcCrrUr)rWr|rrrIrIrJ _exec_default rczExecutionContext._exec_default0Optional[List[Tuple[str, Any, TypeEngine[Any]]]]cCrrUrrVrIrIrJ_prepare_set_input_sizes rz)ExecutionContext._prepare_set_input_sizescCrrUrrVrIrIrJ_get_cache_stats r/z!ExecutionContext._get_cache_statsCursorResult[Any]cCrrUrrVrIrIrJ_setup_result_proxy r/z$ExecutionContext._setup_result_proxyseqSequence_SchemaItemr9rhcCr)zKgiven a :class:`.Sequence`, invoke it and return the next int valuer)rWrrrIrIrJ fire_sequence rzExecutionContext.fire_sequencecCr)zReturn a new cursor generated from this ExecutionContext's connection. Some dialects may wish to change the behavior of connection.cursor(), such as postgresql which may return a PG "server side" cursor. rrVrIrIrJ create_cursor rzExecutionContext.create_cursorrScCr)zCalled before an execution of a compiled statement. If a compiled statement was passed to this ExecutionContext, the `statement` and `parameters` datamembers must be initialized after this statement is complete. rrVrIrIrJpre_exec rzExecutionContext.pre_execout_param_namesrrwcCr)a!Return a sequence of OUT parameter values from a cursor. For dialects that support OUT parameters, this method will be called when there is a :class:`.SQLCompiler` object which has the :attr:`.SQLCompiler.has_out_parameters` flag set. This flag in turn will be set to True if the statement itself has :class:`.BindParameter` objects that have the ``.isoutparam`` flag set which are consumed by the :meth:`.SQLCompiler.visit_bindparam` method. If the dialect compiler produces :class:`.BindParameter` objects with ``.isoutparam`` set which are not handled by :meth:`.SQLCompiler.visit_bindparam`, it should set this flag explicitly. The list of names that were rendered for each bound parameter is passed to the method. The method should then return a sequence of values corresponding to the list of parameter objects. Unlike in previous SQLAlchemy versions, the values can be the **raw values** from the DBAPI; the execution context will apply the appropriate type handler based on what's present in self.compiled.binds and update the values. The processed dictionary will then be made available via the ``.out_parameters`` collection on the result object. Note that SQLAlchemy 1.4 has multiple kinds of result object as part of the 2.0 transition. .. versionadded:: 1.4 - added :meth:`.ExecutionContext.get_out_parameter_values`, which is invoked automatically by the :class:`.DefaultExecutionContext` when there are :class:`.BindParameter` objects with the ``.isoutparam`` flag set. This replaces the practice of setting out parameters within the now-removed ``get_result_proxy()`` method. r)rWr rIrIrJget_out_parameter_values s"z)ExecutionContext.get_out_parameter_valuescCr)aCalled after the execution of a compiled statement. If a compiled statement was passed to this ExecutionContext, the `last_insert_ids`, `last_inserted_params`, etc. datamembers should be available after this method completes. rrVrIrIrJ post_exec8 rzExecutionContext.post_execr BaseExceptioncCr)zQReceive a DBAPI exception which occurred upon execute, result fetch, etc.r)rWrrIrIrJhandle_dbapi_exceptionB sz'ExecutionContext.handle_dbapi_exceptioncCr)zjReturn True if the last INSERT or UPDATE row contained inlined or database-side defaults. rrVrIrIrJlastrow_has_defaultsH sz%ExecutionContext.lastrow_has_defaultsrcCr)zReturn the DBAPI ``cursor.rowcount`` value, or in some cases an interpreted value. See :attr:`_engine.CursorResult.rowcount` for details on this. rrVrIrIrJ get_rowcountO rzExecutionContext.get_rowcountcCr)aFor a RETURNING result, deliver cursor.fetchall() from the DBAPI cursor. This is a dialect-specific hook for dialects that have special considerations when calling upon the rows delivered for a "RETURNING" statement. Default implementation is ``cursor.fetchall()``. This hook is currently used only by the :term:`insertmanyvalues` feature. Dialects that don't set ``use_insertmanyvalues=True`` don't need to consider this hook. .. versionadded:: 2.0.10 r)rWr^rIrIrJfetchall_for_returningY r7z'ExecutionContext.fetchall_for_returningN) rrr<r&rrrrrr/rRr)rrr<r&rrrrrr3rmrrr-rrrr>rRr)rrr<r&rrrrrrrmrrrRr) rrr<r&rrrrrRr)r|rrr7rrrRr)rRrrRr)rRr)rrrr9rRrh)rRr]rb)r rrRrw)rr rRrS)rRr`)rRr)r^r]rRrw)rArBrCrMrcrrr>rFrrrrrrrrrrr r r rrrrIrIrIrJr[ st              $   rc@r)ConnectionEventsTargetzAn object which can accept events from :class:`.ConnectionEvents`. Includes :class:`_engine.Connection` and :class:`_engine.Engine`. .. versionadded:: 2.0 z"dispatcher[ConnectionEventsTarget]rNrrIrIrIrJrl s  rc@seZdZUdZdZded< ded< ded< d ed < d ed < d ed< ded< ded< ded< ded< ded< ded< ded<dS)ExceptionContextaEncapsulate information about an error condition in progress. This object exists solely to be passed to the :meth:`_events.DialectEvents.handle_error` event, supporting an interface that can be extended without backwards-incompatibility. rIrrzOptional[Connection]r<zOptional[Engine]rrr^rrz Optional[_DBAPIAnyExecuteParams]rmr original_exceptionzOptional[StatementError]sqlalchemy_exceptionzOptional[BaseException]chained_exceptionrexecution_contextr`rinvalidate_pool_on_disconnect is_pre_pingN)rArBrCrM __slots__rcrIrIrIrJr{ s:     rc@s@eZdZUdZdZded<edddZdd d ZdddZ dS)AdaptedConnectionzInterface of an adapted connection object to support the DBAPI protocol. Used by asyncio dialects to provide a sync-style pep-249 facade on top of the asyncio connection/cursor API provided by the driver. .. versionadded:: 1.4.24  _connectionrrrRcCs|jS)z@The connection object as returned by the driver after a connect.rrVrIrIrJdriver_connection/ rz#AdaptedConnection.driver_connectionfnCallable[[Any], Awaitable[_T]]r<cCst||jS)aARun the awaitable returned by the given function, which is passed the raw asyncio driver connection. This is used to invoke awaitable-only methods on the driver connection within the context of a "synchronous" method, like a connection pool event handler. E.g.:: engine = create_async_engine(...) @event.listens_for(engine.sync_engine, "connect") def register_custom_types( dbapi_connection, # ... ): dbapi_connection.run_async( lambda connection: connection.set_type_codec( "MyCustomType", encoder, decoder, ... ) ) .. versionadded:: 1.4.30 .. seealso:: :ref:`asyncio_events_run_async` )r r)rWrrIrIrJ run_async4 szAdaptedConnection.run_asyncrcCs d|jS)NzrrVrIrIrJ__repr__T s zAdaptedConnection.__repr__Nr)rr rRr<r) rArBrCrMrrcrrr!r"rIrIrIrJr! s     rN)rM __future__renumrtypesrtypingrrrrr r r r r rrrrrrrrrrreventrpoolrr sql.compilerrrrutil.concurrencyr util.typingr!r"r#r$baser&r'r^r(r0r)r*r+excr,sqlr-r.r/r0r1r2r3 sql.elementsr4r5 sql.schemar6r7r8r sql.sqltypesr9 sql.type_apir:r;rr1r<r>rLrQrdr]_CoreSingleExecuteParams_MutableCoreSingleExecuteParamsr_CoreAnyExecuteParams_DBAPISingleExecuteParamsrr_DBAPIAnyExecuteParamsrhr`re_AnySingleExecuteParamsr_AnyExecuteParamsCompiledCacheTypeSchemaTranslateMapType_ImmutableExecuteOptions _ParamStylerrrrrrrrrrrrrrrrVersionInfoTypeTableKeyrrrr ConnectablerrrIrIrIrJs.                                                             C     .:4 <q '