관리-도구
편집 파일: interfaces.cpython-311.pyc
� �܋fk� � � � d Z ddlmZ ddlmZ ddlmZ G d� de� � Z G d� de� � Z G d � d e� � Z G d � d e� � Z G d � de� � Z dS )z1Define core interfaces used by the engine system.� )�util)�Compiled)� TypeCompilerc �� � e Zd ZdZdZd� Zed� � � Zd� Zd� Z d8d�Z e j d d � � d8d �� � Z d8d �Zd8d �Zd8d�Zd8d�Zd8d�Zd8d�Zd8d�Zd8d�Z d8d�Zd8d�Zd8d�Zd� Zd� Zd8d�Zd8d�Z d� Z d � Z d � Z d � Z d � Z!d � Z"d!� Z#d"� Z$d#� Z%d$� Z&d%� Z'd&� Z( d9d(�Z) d9d)�Z*d*� Z+d8d+�Z,d8d,�Z- d8d-�Z.d.� Z/d/� Z0d0� Z1d1� Z2d2� Z3d3� Z4d4� Z5ed5� � � Z6ed6� � � Z7ed7� � � Z8dS ):�Dialecta� 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. All dialects include the following attributes. There are many other attributes that may be supported as well: ``name`` identifying name for the dialect from a DBAPI-neutral point of view (i.e. 'sqlite') ``driver`` identifying name for the dialect's DBAPI ``positional`` True if the paramstyle for this Dialect is positional. ``paramstyle`` the paramstyle to be used (some DB-APIs support multiple paramstyles). ``encoding`` type of encoding to use for unicode, usually defaults to 'utf-8'. ``statement_compiler`` a :class:`.Compiled` class used to compile SQL statements ``ddl_compiler`` a :class:`.Compiled` class used to compile DDL statements ``server_version_info`` a tuple containing a version number for the DB backend in use. This value is only available for supporting dialects, and is typically populated during the initial connection to the database. ``default_schema_name`` the name of the default schema. This value is only available for supporting dialects, and is typically populated during the initial connection to the database. ``execution_ctx_cls`` a :class:`.ExecutionContext` class used to handle statement execution ``execute_sequence_format`` either the 'tuple' or 'list' type, depending on what cursor.execute() accepts for the second argument (they vary). ``preparer`` a :class:`~sqlalchemy.sql.compiler.IdentifierPreparer` class used to quote identifiers. ``supports_alter`` ``True`` if the database supports ``ALTER TABLE`` - used only for generating foreign key constraints in certain circumstances ``max_identifier_length`` The maximum length of identifier names. ``supports_sane_rowcount`` Indicate whether the dialect properly implements rowcount for ``UPDATE`` and ``DELETE`` statements. ``supports_sane_multi_rowcount`` Indicate whether the dialect properly implements rowcount for ``UPDATE`` and ``DELETE`` statements when executed via executemany. ``preexecute_autoincrement_sequences`` True if 'implicit' primary key functions must be executed separately in order to get their value. This is currently oriented towards PostgreSQL. ``implicit_returning`` use RETURNING or equivalent during INSERT execution in order to load newly generated primary keys and other column defaults in one execution, which are then available via inserted_primary_key. If an insert statement has returning() specified explicitly, the "implicit" functionality is not used and inserted_primary_key will not be available. ``colspecs`` A dictionary of TypeEngine classes from sqlalchemy.types mapped to subclasses that are specific to the dialect class. This dictionary is class-level only and is not accessed from the dialect instance itself. ``supports_default_values`` Indicates if the construct ``INSERT INTO tablename DEFAULT VALUES`` is supported ``supports_sequences`` Indicates if the dialect supports CREATE SEQUENCE or similar. ``sequences_optional`` If True, indicates if the "optional" flag on the Sequence() construct should signal to not generate a CREATE SEQUENCE. Applies only to dialects that support sequences. Currently used only to allow PostgreSQL SERIAL to be used on a column that specifies Sequence() for usage on other backends. ``supports_native_enum`` Indicates if the dialect supports a native ENUM construct. This will prevent types.Enum from generating a CHECK constraint when that type is used. ``supports_native_boolean`` Indicates if the dialect supports a native boolean construct. This will prevent types.Boolean from generating a CHECK constraint when that type is used. ``dbapi_exception_translation_map`` A dictionary of names that will contain as values the names of pep-249 exceptions ("IntegrityError", "OperationalError", etc) keyed to alternate class names, to support the case where a DBAPI has exception classes that aren't named as they are referred to (e.g. IntegrityError = MyException). In the vast majority of cases this dictionary is empty. .. versionadded:: 1.0.5 Fc � � t � � �)a� Build DB-API compatible connection arguments. Given a :class:`.URL` object, returns a tuple consisting of a ``(*args, **kwargs)`` suitable to send directly to the dbapi's connect function. The arguments are sent to the :meth:`.Dialect.connect` method which then runs the DBAPI-level ``connect()`` function. The method typically makes use of the :meth:`.URL.translate_connect_args` method in order to generate a dictionary of options. The default implementation is:: def create_connect_args(self, url): opts = url.translate_connect_args() opts.update(url.query) return [[], opts] :param url: a :class:`.URL` object :return: a tuple of ``(*args, **kwargs)`` which will be passed to the :meth:`.Dialect.connect` method. .. seealso:: :meth:`.URL.translate_connect_args` ��NotImplementedError)�self�urls �S/opt/cloudlinux/venv/lib64/python3.11/site-packages/sqlalchemy/engine/interfaces.py�create_connect_argszDialect.create_connect_args� � � �> "�#�#�#� c � � t � � �)a4 Transform 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 )�cls�typeobjs r �type_descriptorzDialect.type_descriptor� � � � "�#�#�#r c � � dS )a� Called 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(). N� �r � connections r � initializezDialect.initialize� s � � �r c � � t � � �)a� Load table description from the database. Given a :class:`_engine.Connection` and a :class:`~sqlalchemy.schema.Table` object, reflect its columns and properties from the database. The implementation of this method is provided by :meth:`.DefaultDialect.reflecttable`, which makes use of :class:`_reflection.Inspector` to retrieve column information. Dialects should **not** seek to implement this method, and should instead implement individual schema inspection operations such as :meth:`.Dialect.get_columns`, :meth:`.Dialect.get_pk_constraint`, etc. r )r r �table�include_columns�exclude_columns� resolve_fkss r � reflecttablezDialect.reflecttable� � � �( "�#�#�#r Nc � � t � � �)a7 Return 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 with these keys: * ``name`` - the column's name * ``type`` - [sqlalchemy.types#TypeEngine] * ``nullable`` - boolean * ``default`` - the column's default value * ``autoincrement`` - boolean * ``sequence`` - a dictionary of the form {'name' : str, 'start' :int, 'increment': int, 'minvalue': int, 'maxvalue': int, 'nominvalue': bool, 'nomaxvalue': bool, 'cycle': bool, 'cache': int, 'order': bool} Additional column attributes may be present. r �r r � table_name�schema�kws r � get_columnszDialect.get_columns� s � �@ "�#�#�#r z0.8z�The :meth:`.Dialect.get_primary_keys` method is deprecated and will be removed in a future release. Please refer to the :meth:`.Dialect.get_pk_constraint` method. c � � t � � �)z6Return information about primary keys in `table_name`.r r# s r �get_primary_keyszDialect.get_primary_keys � � � "�#�#�#r c � � t � � �)a� Return 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 with these keys: * ``constrained_columns`` - a list of column names that make up the primary key * ``name`` - optional name of the primary key constraint. r r# s r �get_pk_constraintzDialect.get_pk_constraint s � � "�#�#�#r c � � t � � �)a� Return 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 with these keys: * ``name`` - the constraint's name * ``constrained_columns`` - a list of column names that make up the foreign key * ``referred_schema`` - the name of the referred schema * ``referred_table`` - the name of the referred table * ``referred_columns`` - a list of column names in the referred table that correspond to constrained_columns r r# s r �get_foreign_keyszDialect.get_foreign_keys+ s � �0 "�#�#�#r c � � t � � �)z*Return a list of table names for `schema`.r �r r r% r& s r �get_table_nameszDialect.get_table_namesE s � � "�#�#�#r c � � t � � �)zyReturn a list of temporary table names on the given connection, if supported by the underlying backend. r r0 s r �get_temp_table_namesz Dialect.get_temp_table_namesJ � � � "�#�#�#r c � � t � � �)z�Return a list of all view names available in the database. :param schema: Optional, retrieve names from a non-default schema. r r0 s r �get_view_nameszDialect.get_view_namesR � � � "�#�#�#r c � � t � � �)zxReturn a list of temporary view names on the given connection, if supported by the underlying backend. r r0 s r �get_temp_view_nameszDialect.get_temp_view_names[ r4 r c � � t � � �)z�Return view definition. Given a :class:`_engine.Connection`, a string `view_name`, and an optional string `schema`, return the view definition. r )r r � view_namer% r& s r �get_view_definitionzDialect.get_view_definitionc � � � "�#�#�#r c � � t � � �)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 with these keys: * ``name`` - the index's name * ``column_names`` - list of column names in order * ``unique`` - boolean r r# s r � get_indexeszDialect.get_indexesm � � �$ "�#�#�#r c � � t � � �)a� Return 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 with these keys: * ``name`` - the unique constraint's name * ``column_names`` - list of column names in order * ``**kw`` - other options passed to the dialect's get_unique_constraints() method. .. versionadded:: 0.9.0 r r# s r �get_unique_constraintsz Dialect.get_unique_constraints� � � �, "�#�#�#r c � � t � � �)a� Return 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 with these keys: * ``name`` - the check constraint's name * ``sqltext`` - the check constraint's SQL expression * ``**kw`` - other options passed to the dialect's get_check_constraints() method. .. versionadded:: 1.1.0 r r# s r �get_check_constraintsz Dialect.get_check_constraints� r! r c � � t � � �)a| Return 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 with this key: text text of the comment Raises ``NotImplementedError`` for dialects that don't support comments. .. versionadded:: 1.2 r r# s r �get_table_commentzDialect.get_table_comment� s � � "�#�#�#r c � � t � � �)z�convert 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. r �r �names r �normalize_namezDialect.normalize_name� r= r c � � t � � �)z�convert 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. r rI s r �denormalize_namezDialect.denormalize_name� r= r c � � t � � �)a Check the existence of a particular table in the database. Given a :class:`_engine.Connection` object and a string `table_name`, return True if the given table (possibly within the specified `schema`) exists in the database, False otherwise. r )r r r$ r% s r � has_tablezDialect.has_table� � � � "�#�#�#r c � � t � � �)z�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. r )r r � sequence_namer% s r � has_sequencezDialect.has_sequence� r* r c � � t � � �)z�Retrieve 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. r r s r �_get_server_version_infoz Dialect._get_server_version_info� r* r c � � t � � �)a Return 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. r r s r �_get_default_schema_namez Dialect._get_default_schema_name� rP r c � � t � � �)a= Provide 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. Note that :meth:`.Dialect.do_begin` is not called unless a :class:`.Transaction` object is in use. The :meth:`.Dialect.do_autocommit` hook is provided for DBAPIs that need some extra commands emitted after a commit in order to enter the next transaction, when the SQLAlchemy :class:`_engine.Connection` is used in its default "autocommit" mode. :param dbapi_connection: a DBAPI connection, typically proxied within a :class:`.ConnectionFairy`. r �r �dbapi_connections r �do_beginzDialect.do_begin rC r c � � t � � �)z�Provide an implementation of ``connection.rollback()``, given a DB-API connection. :param dbapi_connection: a DBAPI connection, typically proxied within a :class:`.ConnectionFairy`. r rY s r � do_rollbackzDialect.do_rollback r* r c � � t � � �)z�Provide an implementation of ``connection.commit()``, given a DB-API connection. :param dbapi_connection: a DBAPI connection, typically proxied within a :class:`.ConnectionFairy`. r rY s r � do_commitzDialect.do_commit& r* r c � � t � � �)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. r rY s r �do_closezDialect.do_close1 � � � "�#�#�#r c � � t � � �)z�Create a two-phase transaction ID. This id will be passed to do_begin_twophase(), do_rollback_twophase(), do_commit_twophase(). Its format is unspecified. r �r s r � create_xidzDialect.create_xid> r= r c � � t � � �)z�Create a savepoint with the given name. :param connection: a :class:`_engine.Connection`. :param name: savepoint name. r �r r rJ s r � do_savepointzDialect.do_savepointH r= r c � � t � � �)z�Rollback a connection to the named savepoint. :param connection: a :class:`_engine.Connection`. :param name: savepoint name. r rg s r �do_rollback_to_savepointz Dialect.do_rollback_to_savepointR r= r c � � t � � �)z�Release the named savepoint on a connection. :param connection: a :class:`_engine.Connection`. :param name: savepoint name. r rg s r �do_release_savepointz Dialect.do_release_savepoint\ r7 r c � � t � � �)z�Begin a two phase transaction on the given connection. :param connection: a :class:`_engine.Connection`. :param xid: xid r �r r �xids r �do_begin_twophasezDialect.do_begin_twophasee r= r c � � t � � �)z�Prepare a two phase transaction on the given connection. :param connection: a :class:`_engine.Connection`. :param xid: xid r rn s r �do_prepare_twophasezDialect.do_prepare_twophaseo r= r Tc � � t � � �)a3 Rollback 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. r �r r ro � is_prepared�recovers r �do_rollback_twophasez Dialect.do_rollback_twophasey r r c � � t � � �)a2 Commit 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. r rt s r �do_commit_twophasezDialect.do_commit_twophase� s � � "�#�#�#r c � � t � � �)z�Recover list of uncommitted prepared two phase transaction identifiers on the given connection. :param connection: a :class:`_engine.Connection`. r r s r �do_recover_twophasezDialect.do_recover_twophase� r= r c � � t � � �)z]Provide an implementation of ``cursor.executemany(statement, parameters)``. r �r �cursor� statement� parameters�contexts r �do_executemanyzDialect.do_executemany� r4 r c � � t � � �)zYProvide an implementation of ``cursor.execute(statement, parameters)``. r r} s r � do_executezDialect.do_execute� r4 r c � � t � � �)z{Provide an implementation of ``cursor.execute(statement)``. The parameter collection should not be sent. r r} s r �do_execute_no_paramsz Dialect.do_execute_no_params� r* r c � � t � � �)zXReturn True if the given DB-API error indicates an invalid connection. r )r �er r~ s r � is_disconnectzDialect.is_disconnect� r4 r c � � dS )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` Nr )r �cargs�cparamss r �connectzDialect.connect� � � � � r c � � dS )ak Return 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.first_connect` and :meth:`_events.PoolEvents.connect` event hooks, then unwrapping the DBAPI connection and passing it into the callable. The reason it is invoked for both events is so that any dialect-level initialization that occurs upon first connection, which also makes use of the :meth:`_events.PoolEvents.first_connect` method, will proceed after this hook has been called. This currently means the hook is in fact called twice for the very first connection in which a dialect creates; and once per connection afterwards. 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. Nr rd s r � on_connectzDialect.on_connect� s � �X �tr c � � t � � �)a2 Given 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 r �r � dbapi_conns r �reset_isolation_levelz Dialect.reset_isolation_level � � �2 "�#�#�#r c � � t � � �)a& Given 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. .. 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 r� �levels r �set_isolation_levelzDialect.set_isolation_level/ r� r c � � t � � �)a� Given 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 r r� s r �get_isolation_levelzDialect.get_isolation_levelJ r r c � � t � � �)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 r r� s r �get_default_isolation_levelz#Dialect.get_default_isolation_levelk r@ r c � � | 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. .. versionadded:: 1.0.3 r )r r s r �get_dialect_clszDialect.get_dialect_cls s � � � r c � � dS )aJ Set 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 Nr )r s r �load_provisioningzDialect.load_provisioning� r� r c � � dS )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. .. versionadded:: 1.0.3 Nr )r �engines r �engine_createdzDialect.engine_created� s � �$ �r �N)TF)9�__name__� __module__� __qualname__�__doc__� _has_eventsr � classmethodr r r r' r � deprecatedr) r, r. r1 r3 r6 r9 r< r? rB rE rG rK rM rO rS rU rW r[ r] r_ ra re rh rj rl rp rr rw ry r{ r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r s� � � � � � �B� B�H �K� $� $� $�B � $� $� �[� $� � � �"$� $� $�, $� $� $� $�D �T�_� � 6�� � $� $� $� � � $� $� $� $� $�"$� $� $� $�4$� $� $� $� $� $� $� $�$� $� $� $�$� $� $� $�$� $� $� $�$� $� $� $�* .2�$� $� $� $�0$� $� $� $�,$� $� $� $�$$� $� $�$� $� $� $� $� $� $� $� $� $� $� $� $� $� $� $� $�$� $� $�0 $� $� $� $� $� $� $� $� $�$� $� $�$� $� $�$� $� $�$� $� $�$� $� $�$� $� $� :?� $� $� $� $� :?�$� $� $� $� $� $� $�$� $� $� $�$� $� $� $� 6:� $� $� $� $�$� $� $� � � �B,� ,� ,�\$� $� $�6$� $� $�6 $� $� $�B$� $� $�( � � � �[� � � � � �[� �8 � � � �[� � � r r c �* � e Zd ZdZd� Zd� Zd� Zd� ZdS )�CreateEnginePlugina� A 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:`.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:`.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 Plugins are registered using entry points in a similar way as that of dialects:: entry_points={ 'sqlalchemy.plugins': [ 'myplugin = myapp.plugins:MyPlugin' ] 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=myplugin") Alternatively, the :paramref:`.create_engine.plugins" argument may be passed as a list to :func:`_sa.create_engine`:: 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 The ``plugin`` argument 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") A plugin can receive additional arguments from the URL string as well as from the keyword arguments passed to :func:`_sa.create_engine`. The :class:`.URL` object and the keyword dictionary are passed to the constructor so that these arguments can be extracted from the url's :attr:`.URL.query` collection as well as from the dictionary:: class MyPlugin(CreateEnginePlugin): def __init__(self, url, kwargs): 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) Arguments like those illustrated above would be consumed from the following:: 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') The URL and dictionary are used for subsequent setup of the engine as they are, so the plugin can modify their arguments in-place. Arguments that are only understood by the plugin should be popped or otherwise removed so that they aren't interpreted as erroneous arguments afterwards. When the engine creation process completes and produces the :class:`_engine.Engine` object, it is again passed to the plugin via the :meth:`.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`). .. versionadded:: 1.1 c � � || _ dS )ag Construct 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:`.URL` object. The plugin should inspect what it needs here as well as remove its custom arguments from the :attr:`.URL.query` collection. The URL can be modified in-place in any other way as well. :param kwargs: The keyword arguments passed to :func:`.create_engine`. The plugin can read and modify this dictionary in-place, to affect the ultimate arguments used to create the engine. It should remove its custom arguments from the dictionary as well. N)r )r r �kwargss r �__init__zCreateEnginePlugin.__init__ s � �& ����r c � � dS )z parse and modify dialect kwargsNr )r � dialect_cls� dialect_argss r �handle_dialect_kwargsz(CreateEnginePlugin.handle_dialect_kwargs- r� r c � � dS )z parse and modify pool kwargsNr )r �pool_cls� pool_argss r �handle_pool_kwargsz%CreateEnginePlugin.handle_pool_kwargs0 r� r c � � dS )z�Receive 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. Nr )r r� s r r� z!CreateEnginePlugin.engine_created3 r� r N)r� r� r� r� r� r� r� r� r r r r� r� � s] � � � � � �T� T�l� � �*.� .� .�+� +� +� � � � � r r� c �N � e Zd ZdZdZ dZ d� Zd� Zd� Zd� Z d� Z d� Z d � Z d � Z dS ) �ExecutionContextaA A messenger object for a Dialect that corresponds to a single execution. ExecutionContext should have these data members: connection Connection object which can be freely used by default value generators to execute SQL. This Connection should reference the same underlying connection/transactional resources of root_connection. root_connection Connection object which is the source of this ExecutionContext. This Connection may have close_with_result=True set, in which case it can only be used once. dialect dialect which created this ExecutionContext. cursor DB-API cursor procured from the connection, compiled if passed to constructor, sqlalchemy.engine.base.Compiled object being executed, statement string version of the statement to be executed. Is either passed to the constructor, or must be created from the sql.Compiled object by the time pre_exec() has completed. parameters bind parameters passed to the execute() method. For compiled statements, this is a dictionary or list of dictionaries. For textual statements, it should be in a format suitable for the dialect's paramstyle (i.e. dict or list of dicts for non positional, list or list of lists/tuples for positional). isinsert True if the statement is an INSERT. isupdate True if the statement is an UPDATE. should_autocommit True if the statement is a "committable" statement. prefetch_cols a list of Column objects for which a client-side default was fired off. Applies to inserts and updates. postfetch_cols a list of Column objects for which a server-side default or inline SQL expression value was fired off. Applies to inserts and updates. Nc � � t � � �)z�Return 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. r rd s r � create_cursorz ExecutionContext.create_cursor� r* r c � � t � � �)z�Called 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. r rd s r �pre_execzExecutionContext.pre_exec� r= r c � � t � � �)a Called 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. r rd s r � post_execzExecutionContext.post_exec� r= r c � � t � � �)zhReturn a result object corresponding to this ExecutionContext. Returns a ResultProxy. r rd s r �resultzExecutionContext.result� r7 r c � � t � � �)z[Receive a DBAPI exception which occurred upon execute, result fetch, etc. r )r r� s r �handle_dbapi_exceptionz'ExecutionContext.handle_dbapi_exception� r4 r c � � t � � �)zmParse the given textual statement and return True if it refers to a "committable" statement r )r r s r �should_autocommit_textz'ExecutionContext.should_autocommit_text� r4 r c � � t � � �)zkReturn True if the last INSERT or UPDATE row contained inlined or database-side defaults. r rd s r �lastrow_has_defaultsz%ExecutionContext.lastrow_has_defaults� r4 r c � � t � � �)z�Return the DBAPI ``cursor.rowcount`` value, or in some cases an interpreted value. See :attr:`_engine.ResultProxy.rowcount` for details on this. r rd s r � get_rowcountz ExecutionContext.get_rowcount� r= r )r� r� r� r� � exceptionr� r� r� r� r� r� r� r� r� r r r r� r� = s� � � � � � �7� 7�r �I�� �M�� $� $� $�$� $� $�$� $� $�$� $� $�$� $� $�$� $� $�$� $� $�$� $� $� $� $r r� c �� � e Zd ZdZd� ZdZ ej dd� � d� � � Zd� Z ej dd � � d � � � Z ej dd � � d � � � Z d � Z d� Z d� Zdd�ZdS )� Connectablea- Interface for an object which supports execution of SQL constructs. The two implementations of :class:`.Connectable` are :class:`_engine.Connection` and :class:`_engine.Engine`. Connectable must also implement the 'dialect' member which references a :class:`.Dialect` instance. c � � dS )a2 Return a :class:`_engine.Connection` object. Depending on context, this may be ``self`` if this object is already an instance of :class:`_engine.Connection`, or a newly procured :class:`_engine.Connection` if this object is an instance of :class:`_engine.Engine`. Nr )r r� s r r� zConnectable.connect� r� r Nz1.3a@ The :meth:`_engine.Engine.contextual_connect` and :meth:`_engine.Connection.contextual_connect` methods are deprecated. This method is an artifact of the threadlocal engine strategy which is also to be deprecated. For explicit connections from an :class:`_engine.Engine`, use the :meth:`_engine.Engine.connect` method.c � � | j |i |��S )aj Return a :class:`_engine.Connection` object which may be part of an ongoing context. Depending on context, this may be ``self`` if this object is already an instance of :class:`_engine.Connection`, or a newly procured :class:`_engine.Connection` if this object is an instance of :class:`_engine.Engine`. )�_contextual_connect)r �argr& s r �contextual_connectz Connectable.contextual_connect s � �, (�t�'��3��3�3�3r c � � t � � �r� r rd s r r� z Connectable._contextual_connect � � �!�#�#�#r z0.7a The :meth:`.Connectable.create` method is deprecated and will be removed in a future release. Please use the ``.create()`` method on specific schema objects to emit DDL sequences, including :meth:`_schema.Table.create`, :meth:`.Index.create`, and :meth:`_schema.MetaData.create_all`.c � � t � � �)z3Emit CREATE statements for the given schema entity.r �r �entityr� s r �createzConnectable.create rb r a The :meth:`.Connectable.drop` method is deprecated and will be removed in a future release. Please use the ``.drop()`` method on specific schema objects to emit DDL sequences, including :meth:`_schema.Table.drop`, :meth:`.Index.drop`, and :meth:`_schema.MetaData.drop_all`.c � � t � � �)z1Emit DROP statements for the given schema entity.r r� s r �dropzConnectable.drop) rb r c � � t � � �)z+Executes the given construct and returns a r �r �object_� multiparams�paramss r �executezConnectable.execute6 s � �+�!�#�#�#r c � � t � � �)zzExecutes and returns the first column of the first row. The underlying cursor is closed after execution. r r� s r �scalarzConnectable.scalar; s � � "�#�#�#r c � � t � � �r� r )r �visitorcallable�elementr� s r � _run_visitorzConnectable._run_visitorB r� r c � � t � � �r� r )r �elemr� r� s r �_execute_clauseelementz"Connectable._execute_clauseelementE r� r )NN)r� r� r� r� r� r� r r� r� r� r� r� r� r� r� r� r r r r� r� � s% � � � � � �� � � � � �F�� �T�_� � � � � 4� 4� � � 4� $� $� $� �T�_� � /�� �$� $�� �$� �T�_� � -�� �$� $�� �$� $� $� $� $� $� $�$� $� $�$� $� $� $� $� $r r� c �R � e Zd ZdZdZ dZ dZ dZ dZ dZ dZ dZ dZ dZ dZdS )�ExceptionContexta$ Encapsulate information about an error condition in progress. This object exists solely to be passed to the :meth:`_events.ConnectionEvents.handle_error` event, supporting an interface that can be extended without backwards-incompatibility. .. versionadded:: 0.9.7 NT)r� r� r� r� r r� r~ r r� �original_exception�sqlalchemy_exception�chained_exception�execution_contextr� � invalidate_pool_on_disconnectr r r r� r� I s� � � � � � � � � �J� � �F�� �F�� �I�� �J�� ��� ��� ��� ���& �M��0 %)�!�� r r� N) r� � r � sql.compilerr r �objectr r� r� r� r� r r r �<module>r� sM �� 8� 7� � � � � � � #� #� #� #� #� #� '� '� '� '� '� '�o � o � o � o � o �f� o � o � o �d y � y � y � y � y �� y � y � y �xd$� d$� d$� d$� d$�v� d$� d$� d$�Nb$� b$� b$� b$� b$�&� b$� b$� b$�JR� R� R� R� R�v� R� R� R� R� Rr