,h0 dSrSSKJr SSKJr SSKJr SSKJr SSKJ r SSKJ r SSKJ r SS KJ r SS KJ r SS KJr SS KJr SS KJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJ r SSKJ!r! SSK"J#r# SSK"J#r# SSK"J$r$ SSK"J$r$ SSKJ%r% SS K&J'r' SS!K(J)r) SS"K(J*r* SS#K(J+r+ SS$K(J,r, \(aS%S&K-J.r. S%S'K-J/r/ S%S(K0J1r1 S%S)K2J3r3 SS*KJ4r4 SS+KJ5r5 SS,K6J7r7 SS-K8J9r9 SS.K"J:r: SS/K"J;r; SS0K"Jr> SS3K"J?r? SS4K@JArA SS5K@JBrB SS6KCJDrD SS7KCJErE SS8KCJFrF SSKCJrG SS9KHJIrI SS:KJJKrK SS;KJJLrL \\\M\\M\44rN\"S9rO"S?S@\5rP"SASB\5rQ"SCSD\+5rR"SESF\+5rS"SGSH\+5rT\\M\4rU\\M\4rV\\UrW\\W\U4rX\\\\U4rY\\\\\W4rZ\\Z\Y4r[\\\MSF\\\\\\\\\\\\\\]4r^\Yr_\Zr`\[ra\\SI4rb\\\M\\M4rc\%\M\4rd\)SJre\\\M\SK4rf\)SLrg"SMSN\,SOSP9rh\%\M\4ri\\h\\M\44rj"SQSR\,5rk"SSST\,5rl"SUSV\,5rm"SWSX\,5rn"SYSZ\n5ro"S[S\\n5rp"S]S^\n5rq"S_S`\n5rr"SaSb\,5rs"ScSd\,5rt"SeSf\5ru\\\\\M4Sg4rv\\\M\M4rw"ShSi\5rx"SjSk5ry"SlSm5rz"SnSo\5r{\{r|"SpSq5r}"SrSs5r~gt)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(\rSrSrSrSrSrSrSrSr g) CacheStatsOrr&rN) __name__ __module__ __qualname____firstlineno__ CACHE_HIT CACHE_MISSCACHING_DISABLED NO_CACHE_KEYNO_DIALECT_SUPPORT__static_attributes__rDT/var/www/auris/envauris/lib/python3.13/site-packages/sqlalchemy/engine/interfaces.pyr@r@OsIJLrOr@c(\rSrSrSrSrSrSrSrg) ExecuteStyleWzRindicates the :term:`DBAPI` cursor method that will be used to invoke a statement.rr&rrDN) rErFrGrH__doc__EXECUTE EXECUTEMANYINSERTMANYVALUESrNrDrOrPrRrRWs$G1K6rOrRcL\rSrSr%SrS SjrS SjrS SjrS SjrS\ S'S r g ) DBAPIConnectionmzprotocol representing a :pep:`249` database connection. .. versionadded:: 2.0 .. seealso:: `Connection Objects `_ - in :pep:`249` cgNrDselfs rPcloseDBAPIConnection.closeySrOcgr\rDr]s rPcommitDBAPIConnection.commit{scrOcgr\rD)r^argskwargss rPcursorDBAPIConnection.cursor}rOcgr\rDr]s rProllbackDBAPIConnection.rollbacksrObool autocommitrDNreturnNone)rfrrgrrq DBAPICursor) rErFrGrHrTr_rcrhrl__annotations__rNrDrOrPrYrYms !!C#rOrYc\rSrSrSrSrg) DBAPITypezprotocol representing a :pep:`249` database type. .. versionadded:: 2.0 .. seealso:: `Type Objects `_ - in :pep:`249` rDN)rErFrGrHrTrNrDrOrPrvrvs rOrvc\rSrSr%Sr\SSj5r\SSj5rS\S'S\S'SSjr SSS jjr SS jr SS jr SSS jjr SSjrSSjrS SjrSS!SjjrS"SjrS#SjrSrg )$rszprotocol representing a :pep:`249` database cursor. .. versionadded:: 2.0 .. seealso:: `Cursor Objects `_ - in :pep:`249` cg)zThe description attribute of the Cursor. .. seealso:: `cursor.description `_ - in :pep:`249` NrDr]s rP descriptionDBAPICursor.descriptions rOintcgr\rDr]s rProwcountDBAPICursor.rowcounts"rO arraysize lastrowidcgr\rDr]s rPr_DBAPICursor.closerarONcgr\rDr^ operation parameterss rPexecuteDBAPICursor.executerOcgr\rDrs rP executemanyDBAPICursor.executemanyrrOcgr\rDr]s rPfetchoneDBAPICursor.fetchonerOcgr\rD)r^sizes rP fetchmanyDBAPICursor.fetchmany3rOcgr\rDr]s rPfetchallDBAPICursor.fetchallrrOcgr\rD)r^sizess rP setinputsizesDBAPICursor.setinputsizesrrOcgr\rD)r^rcolumns rP setoutputsizeDBAPICursor.setoutputsizesSrOcgr\rD)r^procnamers rPcallprocDBAPICursor.callprocsrOcgr\rDr]s rPnextsetDBAPICursor.nextsetrrOcgr\rD)r^keys rP __getattr__DBAPICursor.__getattr__sCrOrD)rq_DBAPICursorDescription)rqr}rpr\)rrr#Optional[_DBAPISingleExecuteParams]rqr)rrr_DBAPIMultiExecuteParamsrqr)rqz Optional[Any]).)rr}rq Sequence[Any])rqr)rrrqrr)rrrrrqrr)rstrrrrqr)rqzOptional[bool])rrrqr)rErFrGrHrTpropertyr{rrtr_rrrrrrrrrrrNrDrOrPrsrss       ""NN ;?8  -  ->,>@:=)6 -/rOrsr)qmarknumericnamedformatpyformatnumeric_dollarTypeEngine[Any]) SERIALIZABLEzREPEATABLE READzREAD COMMITTEDzREAD UNCOMMITTED AUTOCOMMITcz\rSrSr%S\S'S\S'S\S'S\S 'S\S 'S \S 'S \S 'S \S'S\S'S\S'Srg)_CoreKnownExecutionOptionsizOptional[CompiledCacheType]compiled_cacher logging_tokenIsolationLevelisolation_levelrn no_parametersstream_resultsr}max_row_buffer yield_perinsertmanyvalues_page_sizez Optional[SchemaTranslateMapType]schema_translate_mappreserve_rowcountrDN)rErFrGrHrtrNrDrOrPrrs=//##N ##::rOrF)totalc\rSrSr%SrS\S'S\S'S\S'S\S'S\S 'S\S 'S\S 'S\S 'S\S 'S\S'S\S'Srg)ReflectedIdentityiarepresent 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. rnalwayson_nullr}start incrementminvaluemaxvalue nominvalue nomaxvaluecycle Optional[int]cacheorderrDNrErFrGrHrTrtrNrDrOrPrrsl L! M J(N)M,M,++ K% 1 K-rOrc0\rSrSr%SrS\S'S\S'Srg) ReflectedComputediHaRepresent 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] persistedrDNrrDrOrPrrHsL"! MrOrc\rSrSr%SrS\S'S\S'S\S'S \S 'S \S 'S \S'S\S'S\S'S\S'Srg)ReflectedColumniZzDictionary representing the reflected elements corresponding to a :class:`_schema.Column` object. The :class:`.ReflectedColumn` structure is returned by the :class:`.Inspector.get_columns` method. rnamertypernnullable Optional[str]defaultr autoincrementNotRequired[Optional[str]]commentzNotRequired[ReflectedComputed]computedzNotRequired[ReflectedIdentity]identityNotRequired[Dict[str, Any]]dialect_optionsrDNrrDrOrPrrZsj I EN8 3$$ ('-, -, 10rOrc0\rSrSr%SrS\S'S\S'Srg) ReflectedConstraintizwDictionary representing the reflected elements corresponding to :class:`.Constraint` A base class for all constraints rrrrrDNrrDrOrPrrs  ''0rOrc0\rSrSr%SrS\S'S\S'Srg) ReflectedCheckConstraintizDictionary representing the reflected elements corresponding to :class:`.CheckConstraint`. The :class:`.ReflectedCheckConstraint` structure is returned by the :meth:`.Inspector.get_check_constraints` method. rrrrrDNrrDrOrPrrsL/00rOrc<\rSrSr%SrS\S'S\S'S\S'S rg ) ReflectedUniqueConstraintizDictionary 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_indexrrrDNrrDrOrPrrs&;00L00rOrc0\rSrSr%SrS\S'S\S'Srg) ReflectedPrimaryKeyConstraintizDictionary representing the reflected elements corresponding to :class:`.PrimaryKeyConstraint`. The :class:`.ReflectedPrimaryKeyConstraint` structure is returned by the :meth:`.Inspector.get_pk_constraint` method. rconstrained_columnsrrrDNrrDrOrPrrs#"500KrOrcT\rSrSr%SrS\S'S\S'S\S'S\S 'S \S 'S rg )ReflectedForeignKeyConstraintizDictionary 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_columnsroptionsrDNrrDrOrPrrs6#";""1*J ((ErOrcx\rSrSr%SrS\S'S\S'S\S'S \S 'S \S 'S\S 'S\S'S\S'Srg)ReflectedIndexizDictionary 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]] expressionsrnuniquerduplicates_constraintinclude_columnsz"NotRequired[Dict[str, Tuple[str]]]column_sortingrrrDNrrDrOrPrrs` %% (' L455A++7610ErOrc$\rSrSr%SrS\S'Srg)ReflectedTableCommenti&zDictionary 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. rtextrDNrrDrOrPrr&s rOrc(\rSrSrSrSrSrSrSrg) BindTypingi3zDefine different methods of passing typing information for bound parameters in a statement to the database driver. .. versionadded:: 2.0 r&rrBrDN) rErFrGrHrTNONE SETINPUTSIZES RENDER_CASTSrNrDrOrPr r 3s+ DM LrOr .c \rSrSr%Sr\R r\Rr\Rr\Rr \Rr S\ S'S\ S'S\ S'S\ S'S \ S '\ RSS j5rS \ S 'S\ S'S\ S'S\ S'S\ S'S\ S'S\ S'S\ S'S\ S'S\ S'S\ S 'S!\ S"'S#\ S$'S#\ S%'S&\ S''S(\ S)'S \ S*'S+\ S,'S-\ S.'S-\ S/'S \ S0'S \ S1'S \ S2'S \ S3'S \ S4'S \ S5'S \ S6'S7rS\ S8'S \ S9'S \ S:'S \ S;'S \ S<'S \ S='S \ S>'S \ S?'S@\ SA'S+\ SB'S+\ SC'S \ SD'S \ SE'S \ SF'S \ SG'S \ SH'S \ SI'S \ SJ'S \ SK'S \ SL'SM\ SN'S \ SO'S \ SP'S+\ SQ'S \ SR'S \ SS'S \ ST'S \ SU'S \ SV'SWrSX\ SY'SZrS[\ S\'\ R$rS]\ S^'S \ S_'S \ S`'S \ Sa'SbrScrS \ Sd'S \ Se'\R.rS \ Sf'S \ Sg'Sh\ Si'S-\ Sj'Sk\ Sl'Sk\ Sm'S \ Sn'S \ So'S \ Sp'S \ Sq'Sr\ Ss'SStjrSSujr\SSvj5rSSwjrSSxjr\(aSSyjr SSSzjjr!SWSWS{.SS|jjr"SSS}jjr#SWSWS{.SS~jjr$SSSjjr%SWSWS{.SSjjr&SSSjjr'SSSjjr(SSSjjr)SSSjjr*SSSjjr+SSSjjr,SSjr-SSSjjr.SSSjjr/SWSWS{.SSjjr0SSSjjr1SWSWS{.SSjjr2SSSjjr3SWSWS{.SSjjr4SSSjjr5SWSWS{.SSjjr6SSSjjr7SWSWS{.SSjjr8SSjr9SSjr:SSSjjr;SSSjjr<SSSjjr=SSjr>SSjr?SSjr@SSjrASSjrBSSjrCSSjrDSSjrESSjrFSSjrGSSjrHSSjrISSjrJSSjrKSSjrLSSjrMSSjrNSSSjjrOSSSjjrPSSjrQSSjrRSSSjjrSSSSjjrTSSSjjrUSSjrVSSjrWSSjrXSSjrYSSjrZSSjr[SSjr\SSjr]SSjr^SSjr_\SSj5r`\SSj5ra\SSj5rb\SSj5rcSSjrdSSjreGSSjrfGSSjrgGSSjrhSZrigW(Dialectisa=Define 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]dbapic[5e)zgsame as .dbapi, but is never None; will raise an error if no DBAPI was set up. .. versionadded:: 2.0 NotImplementedErrorr]s rP loaded_dbapiDialect.loaded_dbapi "##rOrn positional paramstyler3compiler_lintingzType[SQLCompiler]statement_compilerzType[DDLCompiler] ddl_compilerzClassVar[Type[TypeCompiler]]type_compiler_clsrtype_compiler_instancer type_compilerzType[IdentifierPreparer]preparerr1identifier_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_alterr}max_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_returningr2"insertmanyvalues_implicit_sentinelrinsertmanyvalues_max_parameters"preexecute_autoincrement_sequencesinsert_returningupdate_returningupdate_returning_multifromdelete_returningdelete_returning_multifromfavor_returning_over_lastrowidsupports_identity_columnscte_follows_insertz"##rOc[5e)aVImport the DBAPI module that is used by this dialect. The Python module object returned here will be assigned as an instance variable to a constructed dialect under the name ``.dbapi``. .. versionchanged:: 2.0 The :meth:`.Dialect.import_dbapi` class method is renamed from the previous method ``.Dialect.dbapi()``, which would be replaced at dialect instantiation time by the DBAPI module itself, thus using the same name in two different ways. If a ``.Dialect.dbapi()`` classmethod is present on a third-party dialect, it will be used and a deprecation warning will be emitted. rclss rP import_dbapiDialect.import_dbapi "##rOc[5e)aTransform a generic type to a dialect-specific type. Dialect classes will usually use the :func:`_types.adapt_type` function in the types module to accomplish this. The returned result is cached *per dialect class* so can contain no dialect-instance state. r)r^typeobjs rPtype_descriptorDialect.type_descriptor "##rOcg)aCalled during strategized creation of the dialect with a connection. Allows dialects to configure options based on server version info or other properties. The connection passed here is a SQLAlchemy Connection object, with full capabilities. The initialize() method of the base dialect should be called via super(). .. note:: as of SQLAlchemy 1.4, this method is called **before** any :meth:`_engine.Dialect.on_connect` hooks are called. NrDr^ connections rP initializeDialect.initializerOcgr\rD)r^ method_names rP_overrides_defaultDialect._overrides_default rjrOc [5e)acReturn information about columns in ``table_name``. Given a :class:`_engine.Connection`, a string ``table_name``, and an optional string ``schema``, return column information as a list of dictionaries corresponding to the :class:`.ReflectedColumn` dictionary. This is an internal dialect method. Applications should use :meth:`.Inspector.get_columns`. rr^r| table_nameschemakws rP get_columnsDialect.get_columns &"##rO)r filter_namesc [5e)aJReturn information about columns in all tables in the given ``schema``. This is an internal dialect method. Applications should use :meth:`.Inspector.get_multi_columns`. .. 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 rr^r|rrrs rPget_multi_columnsDialect.get_multi_columns$ 4"##rOc [5e)aReturn information about the primary key constraint on table_name`. Given a :class:`_engine.Connection`, a string ``table_name``, and an optional string ``schema``, return primary key information as a dictionary corresponding to the :class:`.ReflectedPrimaryKeyConstraint` dictionary. This is an internal dialect method. Applications should use :meth:`.Inspector.get_pk_constraint`. rrs rPget_pk_constraintDialect.get_pk_constraint@rrOc [5e)a`Return information about primary key constraints in all tables in the given ``schema``. This is an internal dialect method. Applications should use :meth:`.Inspector.get_multi_pk_constraint`. .. 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 rrs rPget_multi_pk_constraintDialect.get_multi_pk_constraintU 2"##rOc [5e)aReturn information about foreign_keys in ``table_name``. Given a :class:`_engine.Connection`, a string ``table_name``, and an optional string ``schema``, return foreign key information as a list of dicts corresponding to the :class:`.ReflectedForeignKeyConstraint` dictionary. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_foreign_keys`. rrs rPget_foreign_keysDialect.get_foreign_keysp $"##rOc [5e)a[Return 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 rrs rPget_multi_foreign_keysDialect.get_multi_foreign_keysrrOc [5e)zReturn a list of table names for ``schema``. This is an internal dialect method. Applications should use :meth:`_engine.Inspector.get_table_names`. rr^r|rrs rPget_table_namesDialect.get_table_names "##rOc [5e)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`. rrs rPget_temp_table_namesDialect.get_temp_table_names "##rOc [5e)zReturn 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. rrs rPget_view_namesDialect.get_view_names "##rOc [5e)aReturn 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 rrs rPget_materialized_view_names#Dialect.get_materialized_view_names "##rOc [5e)aReturn 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 rrs rPget_sequence_namesDialect.get_sequence_namesrrOc [5e)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`. rrs rPget_temp_view_namesDialect.get_temp_view_namesrrOc [5e)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)r^r|rs rPget_schema_namesDialect.get_schema_names "##rOc [5e)aReturn 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)r^r| view_namerrs rPget_view_definitionDialect.get_view_definition ""##rOc [5e)a_Return 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`. rrs rP get_indexesDialect.get_indexesrrOc [5e)aMReturn 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 rrs rPget_multi_indexesDialect.get_multi_indexes$rrOc [5e)afReturn 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`. rrs rPget_unique_constraintsDialect.get_unique_constraints@rrOc [5e)a`Return 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 rrs rPget_multi_unique_constraints$Dialect.get_multi_unique_constraintsSrrOc [5e)acReturn 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`. rrs rPget_check_constraintsDialect.get_check_constraintsorrOc [5e)a^Return 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 rrs rPget_multi_check_constraints#Dialect.get_multi_check_constraintsrrOc [5e)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`. rrs rPget_table_optionsDialect.get_table_optionsrrOc [5e)ajReturn 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 rrs rPget_multi_table_optionsDialect.get_multi_table_optionsrrOc [5e)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 rrs rPget_table_commentDialect.get_table_comments ."##rOc [5e)aaReturn 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 rrs rPget_multi_table_commentDialect.get_multi_table_commentrrOc[5e)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. rr^rs rPnormalize_nameDialect.normalize_namerrOc[5e)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. rrs rPdenormalize_nameDialect.denormalize_namerrOc [5e)aIFor 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. rrs rP has_tableDialect.has_tablesN"##rOc [5e)a1Check 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)r^r|r index_namerrs rP has_indexDialect.has_index;rrOc [5e)a@Check 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)r^r| sequence_namerrs rP has_sequenceDialect.has_sequenceVrrOc [5e)aCheck 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)r^r| schema_namers rP has_schemaDialect.has_schemais *"##rOc[5e)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{s rP_get_server_version_info Dialect._get_server_version_info "##rOc[5e)zReturn 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{s rP_get_default_schema_name Dialect._get_default_schema_namerrOc[5e)ajProvide 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`. rr^dbapi_connections rPdo_beginDialect.do_beginrrOc[5e)zProvide an implementation of ``connection.rollback()``, given a DB-API connection. :param dbapi_connection: a DBAPI connection, typically proxied within a :class:`.ConnectionFairy`. rrs rP do_rollbackDialect.do_rollbackrrOc[5e)zProvide an implementation of ``connection.commit()``, given a DB-API connection. :param dbapi_connection: a DBAPI connection, typically proxied within a :class:`.ConnectionFairy`. rrs rP do_commitDialect.do_commitrrOc[5e)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 rrs rP do_terminateDialect.do_terminaterrOc[5e)zProvide 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. rrs rPdo_closeDialect.do_closerrOc[5er\rrs rP_do_ping_w_eventDialect._do_ping_w_eventrirOc[5e)zFping the DBAPI connection and return True if the connection is usable.rrs rPdo_pingDialect.do_ping "##rOc[5e)ainvoke 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)r^rhlist_of_tuplescontexts rPdo_set_input_sizesDialect.do_set_input_sizesrrOc[5e)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. rr]s rP create_xidDialect.create_xidrrOc[5e)zyCreate a savepoint with the given name. :param connection: a :class:`_engine.Connection`. :param name: savepoint name. rr^r|rs rP do_savepointDialect.do_savepointrrOc[5e)zRollback a connection to the named savepoint. :param connection: a :class:`_engine.Connection`. :param name: savepoint name. rrs rPdo_rollback_to_savepoint Dialect.do_rollback_to_savepointrrOc[5e)z}Release the named savepoint on a connection. :param connection: a :class:`_engine.Connection`. :param name: savepoint name. rrs rPdo_release_savepointDialect.do_release_savepoints "##rOc[5e)z{Begin a two phase transaction on the given connection. :param connection: a :class:`_engine.Connection`. :param xid: xid rr^r|xids rPdo_begin_twophaseDialect.do_begin_twophase'rrOc[5e)z}Prepare a two phase transaction on the given connection. :param connection: a :class:`_engine.Connection`. :param xid: xid rr&s rPdo_prepare_twophaseDialect.do_prepare_twophase1rrOc[5e)aRollback 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. rr^r|r' is_preparedrecovers rPdo_rollback_twophaseDialect.do_rollback_twophase;rrOc[5e)aCommit 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. rr.s rPdo_commit_twophaseDialect.do_commit_twophaseNrrOc[5e)zRecover list of uncommitted prepared two phase transaction identifiers on the given connection. :param connection: a :class:`_engine.Connection`. rr{s rPdo_recover_twophaseDialect.do_recover_twophasebrrOc[5e)zconvert executemany parameters for an INSERT into an iterator of statement/single execute values, used by the insertmanyvalues feature. r)r^r|rh statementrgeneric_setinputsizesrs rP!_deliver_insertmanyvalues_batches)Dialect._deliver_insertmanyvalues_batchesls "##rOc[5e)zKProvide an implementation of ``cursor.executemany(statement, parameters)``.rr^rhr:rrs rPdo_executemanyDialect.do_executemany|rrOc[5e)zGProvide an implementation of ``cursor.execute(statement, parameters)``.rr?s rP do_executeDialect.do_executerrOc[5e)zkProvide an implementation of ``cursor.execute(statement)``. The parameter collection should not be sent. r)r^rhr:rs rPdo_execute_no_paramsDialect.do_execute_no_paramsryrOc[5e)zEReturn True if the given DB-API error indicates an invalid connectionr)r^er|rhs rP is_disconnectDialect.is_disconnectrrOc[5e)a\Establish 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)r^cargscparamss rPconnectDialect.connect@"##rOc"UR5$)areturn 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_connectrks rPon_connect_urlDialect.on_connect_urlsv  rOcg)aqreturn 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. NrDr]s rPrSDialect.on_connect sfrOc[5e)aGiven 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 rrs rPreset_isolation_levelDialect.reset_isolation_levelA rrOc[5e)aGiven 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)r^rlevels rPset_isolation_levelDialect.set_isolation_level\ rQrOc[5e)aYGiven 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 rrs rPget_isolation_levelDialect.get_isolation_level~ sB"##rOc[5e)a@Given 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 rr^ dbapi_conns rPget_default_isolation_level#Dialect.get_default_isolation_level s ("##rOc[5e)a'return 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 rrcs rPget_isolation_level_values"Dialect.get_isolation_level_values sT"##rOc[5er\r)r^rdr\s rP_assert_and_set_isolation_level'Dialect._assert_and_set_isolation_level rrOcU$)aMGiven 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. rDrqrls rPget_dialect_clsDialect.get_dialect_cls s  rOc$URU5$)ajGiven 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` )rorns rPget_async_dialect_clsDialect.get_async_dialect_cls s"""3''rOcg)aset 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 NrDrps rPload_provisioningDialect.load_provisioning rrOcg)aA 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. NrD)rqengines rPengine_createdDialect.engine_created& rrOc[5e)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{s rPget_driver_connectionDialect.get_driver_connection7 rrOc[5e)a1Establish 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)r^rxoptss rPset_engine_execution_options$Dialect.set_engine_execution_optionsF ryrOc[5e)a]Establish 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)r^r|rs rP set_connection_execution_options(Dialect.set_connection_execution_optionsT rrOc[5e)z*return a Pool class to use for a given URLrrks rPget_dialect_pool_classDialect.get_dialect_pool_classc s !##rOcg)z=Validates an identifier name, raising an exception if invalidNrD)r^idents rPvalidate_identifierDialect.validate_identifierg rrO)rqr)rqzOptional[_ListenerFnType])rlr*rqConnectArgsType)rvTypeEngine[_T]rqr)r|r'rqrr)rrrqrnr\) r|r'rrrrrrrqzList[ReflectedColumn]) r|r'rrrOptional[Collection[str]]rrrqz0Iterable[Tuple[TableKey, List[ReflectedColumn]]]) r|r'rrrrrrrqr) r|r'rrrrrrrqz8Iterable[Tuple[TableKey, ReflectedPrimaryKeyConstraint]]) r|r'rrrrrrrqz#List[ReflectedForeignKeyConstraint]) r|r'rrrrrrrqz>Iterable[Tuple[TableKey, List[ReflectedForeignKeyConstraint]]])r|r'rrrrrqr)r|r'rrrqr) r|r'rrrrrrrqr) r|r'rrrrrrrqzList[ReflectedIndex]) r|r'rrrrrrrqz/Iterable[Tuple[TableKey, List[ReflectedIndex]]]) r|r'rrrrrrrqzList[ReflectedUniqueConstraint]) r|r'rrrrrrrqz:Iterable[Tuple[TableKey, List[ReflectedUniqueConstraint]]]) r|r'rrrrrrrqzList[ReflectedCheckConstraint]) r|r'rrrrrrrqz9Iterable[Tuple[TableKey, List[ReflectedCheckConstraint]]]) r|r'rrrrrrrqDict[str, Any]) r|r'rrrrrrrqz)Iterable[Tuple[TableKey, Dict[str, Any]]]) r|r'rrrrrrrqr) r|r'rrrrrrrqz0Iterable[Tuple[TableKey, ReflectedTableComment]])rrrqr) r|r'rrrrrrrqrn) r|r'rrrrrrrrrqrn) r|r'rrrrrrrqrn)r|r'rrrrrqrn)r|r'rqr)r|r'rqr)rrrqrr)rrYrqrr)rrYrqrn)rhrsr_GenericSetInputSizesTyperExecutionContextrqrrqr)r|r'rrrqrr)r|r'r'rrqrr)TF) r|r'r'rr/rnr0rnrqrr)r|r'rqz List[Any])r|r'rhrsr:rrrr;z#Optional[_GenericSetInputSizesType]rrrqz Iterator[_InsertManyValuesBatch]) rhrsr:rrrrOptional[ExecutionContext]rqrr) rhrsr:rrrrrrqrr)rhrsr:rrrrqrr)rI Exceptionr|z7Optional[Union[PoolProxiedConnection, DBAPIConnection]]rhOptional[DBAPICursor]rqrn)rMrrNrrqrY)rlr*rqOptional[Callable[[Any], Any]])rqr)rrYr\rrqrr)rrYrqr)rdrYrqr)rdrYrqzSequence[IsolationLevel])rdrYr\rrqrr)rlr*rq Type[Dialect]rprxr(rqrr)r|rYrqr)rxr(rCoreExecuteOptionsParameterrqrr)r|r'rrrqrr)rlr*rq Type[Pool])rrrqrr)jrErFrGrHrTr@rIrJrKrLrMrtrnon_memoized_propertyrr6rRrT EMPTY_DICTrU _has_eventsrYr r  bind_typingrgrm classmethodrrrwr}rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr r rrrrr r#r(r+r1r4r7r<r@rCrFrJrOrTrSrYr]r`rerhrkrorrruryr|rrrrrNrDrOrPrrss  $$I&&J!22**L#66!! I K2 , $ $@O))C##C33 )('&,+ 32 '&65E":9--O41((" --"#'&?! #'&  "!: $$$-S,"&% #'& ;?>#'&>"&&><(,+ )ED !$# &)( )-,  !%$  !%$ %)( $#+&KJ G  "! "!0  <)+ *:>#%6HK1#'& K%)d)" $#://KNB0+*  9//0/%)(=ML##??$$B$$" $ $C !% $$$ $  $  $2!%26 $$ $ 0 $  $ :$@!% $$$ $  $ ' $2!%26 $$ $ 0 $  $ B$>!% $$$ $  $ - $0!%26 $$ $ 0 $  $ H$:?C $$ $.; $JM $  $?C $$ $.; $JM $  $?C $$ $.; $JM $  $ ?C$$$.;$JM$ $$?C $$ $.; $JM $  $ ?C $$ $.; $JM $  $$!% $$$ $  $ $.!% $$$ $  $  $0!%26 $$ $ 0 $  $ 9$@!% $$$ $  $ ) $.!%26 $$ $ 0 $  $ D$@!% $$$ $  $ ( $0!%26 $$ $ 0 $  $ C$@!% $ $ $ $  $  $&!%26 $$ $ 0 $  $ 3$>!% $$$ $  $  $:!%26 $$ $ 0 $  $ :$8$$!% '$'$'$ '$  '$  '$\!% $$$ $  $  $ $>!% $$$ $  $  $&$$$36$>A$ $. $ $ $ $ $$" $$$ $$2$" $ $8$$ $$ $,/ $  $$$$! $$$ $  $  $.! $$$ $  $  $($$$$ $ - $ C $"$ *$*/3 $ $ $- $ , $  $"/3 $ $ $8 $ , $  $ /3 $ $ $, $  $ $  $L $& $  $ $D;!z3j$6 $ / $8F $  $D!$ /!$ !$F$)$ $,*$)*$ !*$X$)$2@$ $   (($  8  $ $ $$? $  $ $$ $,G $  $$LLrOrcb\rSrSrSrS SjrS SjrS SjrS SjrSSjr Sr g )CreateEnginePluginik aA 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`). cXlg)aqConstruct 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`. Nrl)r^rlrgs rP__init__CreateEnginePlugin.__init__ s 2rOc[5e)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 rrks rP update_urlCreateEnginePlugin.update_url6 rrOcg)zparse and modify dialect kwargsNrD)r^ dialect_cls dialect_argss rPhandle_dialect_kwargs(CreateEnginePlugin.handle_dialect_kwargsG rrOcg)zparse and modify pool kwargsNrD)r^pool_cls pool_argss rPhandle_pool_kwargs%CreateEnginePlugin.handle_pool_kwargsL rrOcg)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. NrD)r^rxs rPry!CreateEnginePlugin.engine_createdQ rrOrN)rlr*rgr)rlr*rqr*)rrrrrqrr)rrrrrqrrr) rErFrGrHrTrrrrryrNrDrOrPrrk sRm^6$".(.8F. . +"+/=+ +  rOrc\\rSrSr%SrS\S'S\S'S\S'S\S 'S \S 'S \S 'S\S'S\S'S\S'S\S'S\S'S\S'S\S'S\S'S\S'S\S'S\S'\S3S j5r\\R4S4S!jj5r \S5S"j5r \S6S#j5r S7S$jr S8S%jrS9S&jrS:S'jrS;S(jrSS+jrS=S,jrS?S-jrS@S.jrSAS/jrSBS0jrS1rg2)Cri[ zJA messenger object for a Dialect that corresponds to a single execution. r(rxr'r|root_connectionrdialectrsrhzOptional[Compiled]compiledrr:zOptional[Executable]invoked_statement_AnyMultiExecuteParamsrrnrisinsertisupdaterR execute_stylerz;util.generic_fn_descriptor[Optional[Sequence[Column[Any]]]] prefetch_colspostfetch_cols_ExecuteOptionsexecution_optionsc[5er\r)rqrr|rr compiled_ddls rP _init_ddlExecutionContext._init_ddl rrOc [5er\r) rqrr|rrrrrextracted_parameters cache_hits rP_init_compiledExecutionContext._init_compiled rrOc[5er\r)rqrr|rrr:rs rP_init_statement ExecutionContext._init_statement rrOc[5er\r)rqrr|rrs rP _init_defaultExecutionContext._init_default rrOc[5er\r)r^rrtype_s rP _exec_defaultExecutionContext._exec_default rrOc[5er\rr]s rP_prepare_set_input_sizes)ExecutionContext._prepare_set_input_sizes rrOc[5er\rr]s rP_get_cache_stats!ExecutionContext._get_cache_stats rirOc[5er\rr]s rP_setup_result_proxy$ExecutionContext._setup_result_proxy rirOc[5e)zCgiven a :class:`.Sequence`, invoke it and return the next int valuer)r^seqrs rP fire_sequenceExecutionContext.fire_sequence rrOc[5e)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. rr]s rP create_cursorExecutionContext.create_cursor rrOc[5e)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. rr]s rPpre_execExecutionContext.pre_exec rrOc[5e)aQReturn 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)r^out_param_namess rPget_out_parameter_values)ExecutionContext.get_out_parameter_values sD"##rOc[5e)zCalled 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. rr]s rP post_execExecutionContext.post_exec8 rrOc[5e)zIReceive a DBAPI exception which occurred upon execute, result fetch, etc.r)r^rIs rPhandle_dbapi_exception'ExecutionContext.handle_dbapi_exceptionB s "##rOc[5e)zZReturn True if the last INSERT or UPDATE row contained inlined or database-side defaults. rr]s rPlastrow_has_defaults%ExecutionContext.lastrow_has_defaultsH s "##rOc[5e)zReturn the DBAPI ``cursor.rowcount`` value, or in some cases an interpreted value. See :attr:`_engine.CursorResult.rowcount` for details on this. rr]s rP get_rowcountExecutionContext.get_rowcountO rrOc[5e)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)r^rhs rPfetchall_for_returning'ExecutionContext.fetchall_for_returningY rtrOrDN) rrr|r'rrrrrr0rqr)rrr|r'rrrrrr4r_CoreMultiExecuteParamsrr.rz&Optional[Sequence[BindParameter[Any]]]rr@rqr)rrr|r'rrrrr:rrrrqr) rrr|r'rrrrrqr)rzOptional[Column[Any]]rr8rzOptional[TypeEngine[Any]]rqr)rqz0Optional[List[Tuple[str, Any, TypeEngine[Any]]]]rqr)rqzCursorResult[Any])rSequence_SchemaItemrr:rqr})rqrsrp)rrSrqr)rI BaseExceptionrqrr)rqrn)rqr)rhrsrqr)rErFrGrHrTrtrrr@rKrrrrrrrrrrrrrrrrrNrDrOrPrr[ s N8  I 6 4  NC,+'&=N-N-ON9PO'&K$$$0 $ + $ " $ $$!+ ; ; $ $ $0 $ + $  $, $& $E $ $  $ $ $ $ $0 $ + $  $- $  $ $$$$0 $ + $  $$$%$"$) $ $$ 9$ $$$ $$"$,"$ "$H$$ $$$rOrc$\rSrSr%SrS\S'Srg)ConnectionEventsTargetil zAn object which can accept events from :class:`.ConnectionEvents`. Includes :class:`_engine.Connection` and :class:`_engine.Engine`. .. versionadded:: 2.0 z"dispatcher[ConnectionEventsTarget]rrDNrrDrOrPrrl s10rOrc\rSrSr%SrSrS\S'S\S'S\S 'S \S 'S \S 'S\S'S\S'S\S'S\S'S\S'S\S'S\S'S\S'Srg)ExceptionContexti{ zEncapsulate 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. rDrrzOptional[Connection]r|zOptional[Engine]rxrrhrr:z Optional[_DBAPIAnyExecuteParams]rroriginal_exceptionzOptional[StatementError]sqlalchemy_exceptionzOptional[BaseException]chained_exceptionrexecution_contextrnrJinvalidate_pool_on_disconnect is_pre_pingN)rErFrGrHrT __slots__rtrNrDrOrPrr{ sI %$   "!  10 &% 32/.21&0$(' rOrcP\rSrSr%SrSrS\S'\S Sj5rS Sjr S Sjr S r g )AdaptedConnectioni! zInterface 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  _connectionrr cUR$)z@The connection object as returned by the driver after a connect.r r]s rPdriver_connection#AdaptedConnection.driver_connection/ srOc8[U"UR55$)aRun 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 )r^fns rP run_asyncAdaptedConnection.run_async4 s<"T--.//rOc SUR-$)Nzr r]s rP__repr__AdaptedConnection.__repr__T s'$*:*:::rOrDNr)rzCallable[[Any], Awaitable[_T]]rqr=r) rErFrGrHrTr rtrrrrrNrDrOrPr r ! s1!I   0@;rOr N)rT __future__renumrtypesrtypingrrrr r r r r rrrrrrrrrrrreventrpoolrr sql.compilerrrr util.concurrencyr! util.typingr"r#r$r%baser'r(rhr)rlr*r+r,excr-sqlr.r/r0r1r2r3r4 sql.elementsr5r6 sql.schemar7r8r9r sql.sqltypesr: sql.type_apir;r<rrr=r@rRrYrvrs_CoreSingleExecuteParams_MutableCoreSingleExecuteParamsr_CoreAnyExecuteParams_DBAPISingleExecuteParamsr_DBAPIAnyExecuteParamsr}rnr_AnySingleExecuteParamsr_AnyExecuteParamsCompiledCacheTypeSchemaTranslateMapType_ImmutableExecuteOptions _ParamStylerrrrrrrrrrrrrrrr VersionInfoTypeTableKeyrrrr Connectablerr rDrOrPr7s8"! (/#7' )!%"# $'"$ 5*1;&*,,#-'<&,) ~c3h'??@ T4,h.  @0(@0F#38,"0c":"#;<55"(3-1I"IJ  Xc]4477#         41*"3 ?3 # !=>(c2G !sC1B'B!CD %  S)#S 11 +. +.\N N$7i7t 1) 12& 3( L$7 L F$7F21FY1Fh I 99xc3h,- ## $uLkuLp?m m `N$N$b 1[ 1% ccL4;4;rO