/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine
Edit: /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyo (46807B)
4]c @ s d Z d d l m Z d d l m Z d d l m Z d e f d YZ d e f d YZ d e f d
YZ d e f d YZ
d
e f d YZ d S( s1 Define core interfaces used by the engine system.i ( t util( t Compiled( t TypeCompilert Dialectc B s e Z d Z e Z d Z e d Z d Z d Z d1 d Z e j
d d d1 d Z d1 d Z d1 d
Z d1 d Z d1 d Z d1 d
Z d1 d Z d1 d Z d1 d Z d1 d Z d1 d Z d1 d Z d Z d Z d1 d Z d1 d 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) e* e d$ Z+ e* e d% Z, d& Z- d1 d' Z. d1 d( Z/ d1 d) Z0 d* Z1 d+ Z2 d, Z3 d- Z4 d. Z5 e d/ Z6 e d0 Z7 RS(2 s 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.
All Dialects implement the following attributes:
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).
convert_unicode
True if Unicode conversion should be applied to all ``str``
types.
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``.
max_identifier_length
The maximum length of identifier names.
supports_unicode_statements
Indicate whether the DB-API can receive SQL statements as Python
unicode strings
supports_unicode_binds
Indicate whether the DB-API can receive string bind parameters
as Python unicode strings
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
c C s
t d S( s Build DB-API compatible connection arguments.
Given a :class:`~sqlalchemy.engine.url.URL` object, returns a tuple
consisting of a `*args`/`**kwargs` suitable to send directly
to the dbapi's connect function.
N( t NotImplementedError( t selft url( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt create_connect_args s c C s
t d S( s4 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.
N( R ( t clst typeobj( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt type_descriptor s
c C s d S( s 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 t
connection( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt
initialize s c C s
t d S( sr Load table description from the database.
Given a :class:`.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:`.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.
N( R ( R R t tablet include_columnst exclude_columnst resolve_fks( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt reflecttable s c K s
t d S( s
Return information about columns in `table_name`.
Given a :class:`.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.
N( R ( R R t
table_namet schemat kw( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_columns s s 0.8s 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 K s
t d S( s@ Return information about primary keys in `table_name`.
N( R ( R R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_primary_keys s c K s
t d S( s Return information about the primary key constraint on
table_name`.
Given a :class:`.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.
N( R ( R R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_pk_constraint s c K s
t d S( s Return information about foreign_keys in `table_name`.
Given a :class:`.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
N( R ( R R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_foreign_keys s c K s
t d S( s* Return a list of table names for `schema`.N( R ( R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_table_names6 s c K s
t d S( sy Return a list of temporary table names on the given connection,
if supported by the underlying backend.
N( R ( R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_temp_table_names; s c K s
t d S( s Return a list of all view names available in the database.
schema:
Optional, retrieve names from a non-default schema.
N( R ( R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_view_namesC s c K s
t d S( sx Return a list of temporary view names on the given connection,
if supported by the underlying backend.
N( R ( R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_temp_view_namesL s c K s
t d S( s Return view definition.
Given a :class:`.Connection`, a string
`view_name`, and an optional string `schema`, return the view
definition.
N( R ( R R t view_nameR R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_view_definitionT s c K s
t d S( su Return information about indexes in `table_name`.
Given a :class:`.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
N( R ( R R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_indexes^ s c K s
t d S( s 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
N( R ( R R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_unique_constraintsq s c K s
t d S( s 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
N( R ( R R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_check_constraints s c K s
t d S( s| 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
N( R ( R R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_table_comment s c C s
t d S( s 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.
N( R ( R t name( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt normalize_name s c C s
t d S( s 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.
N( R ( R R# ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt denormalize_name s c C s
t d S( s Check the existence of a particular table in the database.
Given a :class:`.Connection` object and a string
`table_name`, return True if the given table (possibly within
the specified `schema`) exists in the database, False
otherwise.
N( R ( R R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt has_table s c C s
t d S( s Check the existence of a particular sequence in the database.
Given a :class:`.Connection` object and a string
`sequence_name`, return True if the given sequence exists in
the database, False otherwise.
N( R ( R R t
sequence_nameR ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt has_sequence s c C s
t d S( s 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.
N( R ( R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt _get_server_version_info s c C s
t d S( s 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.
N( R ( R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt _get_default_schema_name s
c C s
t d S( s/ 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:`.Connection` is used in its default "autocommit"
mode.
:param dbapi_connection: a DBAPI connection, typically
proxied within a :class:`.ConnectionFairy`.
N( R ( R t dbapi_connection( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_begin s c C s
t d S( s Provide an implementation of ``connection.rollback()``, given
a DB-API connection.
:param dbapi_connection: a DBAPI connection, typically
proxied within a :class:`.ConnectionFairy`.
N( R ( R R+ ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_rollback s c C s
t d S( s Provide an implementation of ``connection.commit()``, given a
DB-API connection.
:param dbapi_connection: a DBAPI connection, typically
proxied within a :class:`.ConnectionFairy`.
N( R ( R R+ ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_commit s c C s
t d S( s Provide an implementation of ``connection.close()``, given a DBAPI
connection.
This hook is called by the :class:`.Pool` when a connection has been
detached from the pool, or is being returned beyond the normal
capacity of the pool.
N( R ( R R+ ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_close s
c C s
t d S( s 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.
N( R ( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt
create_xid* s c C s
t d S( s Create a savepoint with the given name.
:param connection: a :class:`.Connection`.
:param name: savepoint name.
N( R ( R R R# ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_savepoint4 s c C s
t d S( s Rollback a connection to the named savepoint.
:param connection: a :class:`.Connection`.
:param name: savepoint name.
N( R ( R R R# ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_rollback_to_savepoint> s c C s
t d S( s Release the named savepoint on a connection.
:param connection: a :class:`.Connection`.
:param name: savepoint name.
N( R ( R R R# ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_release_savepointH s c C s
t d S( s Begin a two phase transaction on the given connection.
:param connection: a :class:`.Connection`.
:param xid: xid
N( R ( R R t xid( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_begin_twophaseQ s c C s
t d S( s Prepare a two phase transaction on the given connection.
:param connection: a :class:`.Connection`.
:param xid: xid
N( R ( R R R4 ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_prepare_twophase[ s c C s
t d S( s, Rollback a two phase transaction on the given connection.
:param connection: a :class:`.Connection`.
:param xid: xid
:param is_prepared: whether or not
:meth:`.TwoPhaseTransaction.prepare` was called.
:param recover: if the recover flag was passed.
N( R ( R R R4 t is_preparedt recover( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_rollback_twophasee s
c C s
t d S( s+ Commit a two phase transaction on the given connection.
:param connection: a :class:`.Connection`.
:param xid: xid
:param is_prepared: whether or not
:meth:`.TwoPhaseTransaction.prepare` was called.
:param recover: if the recover flag was passed.
N( R ( R R R4 R7 R8 ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_commit_twophaset s c C s
t d S( s Recover list of uncommitted prepared two phase transaction
identifiers on the given connection.
:param connection: a :class:`.Connection`.
N( R ( R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_recover_twophase s c C s
t d S( sS Provide an implementation of ``cursor.executemany(statement,
parameters)``.N( R ( R t cursort statementt
parameterst context( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_executemany s c C s
t d S( sO Provide an implementation of ``cursor.execute(statement,
parameters)``.N( R ( R R< R= R> R? ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt
do_execute s c C s
t d S( s{ Provide an implementation of ``cursor.execute(statement)``.
The parameter collection should not be sent.
N( R ( R R< R= R> R? ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt do_execute_no_params s c C s
t d S( sM Return True if the given DB-API error indicates an invalid
connectionN( R ( R t eR R< ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt
is_disconnect s c C s d S( s return a callable which sets up a newly created DBAPI connection.
The callable accepts a single argument "conn" which is the
DBAPI connection itself. It has no return value.
This is used to set dialect-wide per-connection options such as
isolation modes, unicode modes, etc.
If a callable is returned, it will be assembled into a pool listener
that receives the direct DBAPI connection, with all wrappers removed.
If None is returned, no listener will be generated.
N( t None( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt connect s c C s
t d S( s 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:`.Connection` and
:class:`.Engine`
isolation level facilities; these APIs should be preferred for
most typical use cases.
.. seealso::
:meth:`.Connection.get_isolation_level` - view current level
:attr:`.Connection.default_isolation_level` - view default level
:paramref:`.Connection.execution_options.isolation_level` -
set per :class:`.Connection` isolation level
:paramref:`.create_engine.isolation_level` -
set per :class:`.Engine` isolation level
N( R ( R t
dbapi_conn( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt reset_isolation_level s c C s
t d S( s 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:`.Connection` and
:class:`.Engine`
isolation level facilities; these APIs should be preferred for
most typical use cases.
.. seealso::
:meth:`.Connection.get_isolation_level` - view current level
:attr:`.Connection.default_isolation_level` - view default level
:paramref:`.Connection.execution_options.isolation_level` -
set per :class:`.Connection` isolation level
:paramref:`.create_engine.isolation_level` -
set per :class:`.Engine` isolation level
N( R ( R RG t level( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt set_isolation_level s c C s
t d S( s Given a DBAPI connection, return its isolation level.
When working with a :class:`.Connection` object, the corresponding
DBAPI connection may be procured using the
:attr:`.Connection.connection` accessor.
Note that this is a dialect-level method which is used as part
of the implementation of the :class:`.Connection` and
:class:`.Engine` isolation level facilities;
these APIs should be preferred for most typical use cases.
.. seealso::
:meth:`.Connection.get_isolation_level` - view current level
:attr:`.Connection.default_isolation_level` - view default level
:paramref:`.Connection.execution_options.isolation_level` -
set per :class:`.Connection` isolation level
:paramref:`.create_engine.isolation_level` -
set per :class:`.Engine` isolation level
N( R ( R RG ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_isolation_level s c C s | S( s 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 ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_dialect_cls s c C s d S( sq A convenience hook called before returning the final :class:`.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
N( ( R t engine( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt engine_created s N(8 t __name__t
__module__t __doc__t Falset _has_eventsR t classmethodR
R R RE R R t
deprecatedR R R R R R R R R R R! R" R$ R% R& R( R) R* R, R- R. R/ R0 R1 R2 R3 R5 R6 t TrueR9 R: R; R@ RA RB RD RF RH RJ RK RL RN ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyR sf !
t CreateEnginePluginc B s2 e Z d Z d Z d Z d Z d Z RS( sw
A set of hooks intended to augment the construction of an
:class:`.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:`.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:`.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:`.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` 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 C s
| | _ d S( sS Construct a new :class:`.CreateEnginePlugin`.
The plugin object is instantiated individually for each call
to :func:`.create_engine`. A single :class:`.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 t kwargs( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt __init__ s c C s d S( s parse and modify dialect kwargsN( ( R t dialect_clst dialect_args( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt handle_dialect_kwargs t c C s d S( s parse and modify pool kwargsN( ( R t pool_clst pool_args( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt handle_pool_kwargs R] c C s d S( s Receive the :class:`.Engine` object when it is fully constructed.
The plugin may make additional changes to the engine, such as
registering engine or connection pool events.
N( ( R RM ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyRN R] ( RO RP RQ RY R\ R` RN ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyRW 0 s
U t ExecutionContextc B sb e Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z d Z d Z
RS(
sA 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.
c C s
t d S( s 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.
N( R ( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt
create_cursor s c C s
t d S( s 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.
N( R ( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt pre_exec s c C s
t d S( s 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.
N( R ( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt post_exec s c C s
t d S( sg Return a result object corresponding to this ExecutionContext.
Returns a ResultProxy.
N( R ( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt result% s c C s
t d S( sQ Receive a DBAPI exception which occurred upon execute, result
fetch, etc.N( R ( R RC ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt handle_dbapi_exception- s c C s
t d S( sc Parse the given textual statement and return True if it refers to
a "committable" statementN( R ( R R= ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt should_autocommit_text3 s c C s
t d S( sj Return True if the last INSERT or UPDATE row contained
inlined or database-side defaults.
N( R ( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt lastrow_has_defaults9 s c C s
t d S( s Return the DBAPI ``cursor.rowcount`` value, or in some
cases an interpreted value.
See :attr:`.ResultProxy.rowcount` for details on this.
N( R ( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt get_rowcount@ s N( RO RP RQ RE t exceptionRD Rb Rc Rd Re Rf Rg Rh Ri ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyRa s 8
t Connectablec B s e Z d Z d Z d Z e j d d d Z d Z e j d d d Z
e j d d d
Z d Z d Z
d
Z d d d Z RS( s Interface for an object which supports execution of SQL constructs.
The two implementations of :class:`.Connectable` are
:class:`.Connection` and :class:`.Engine`.
Connectable must also implement the 'dialect' member which references a
:class:`.Dialect` instance.
c K s d S( s Return a :class:`.Connection` object.
Depending on context, this may be ``self`` if this object
is already an instance of :class:`.Connection`, or a newly
procured :class:`.Connection` if this object is an instance
of :class:`.Engine`.
N( ( R RX ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyRF V R] s 1.3s% The :meth:`.Engine.contextual_connect` and :meth:`.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`, use the :meth:`.Engine.connect` method.c O s | j | | S( sF Return a :class:`.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:`.Connection`, or a newly
procured :class:`.Connection` if this object is an instance
of :class:`.Engine`.
( t _contextual_connect( R t argR ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt contextual_connectg s c C s
t d S( N( R ( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyRl | s s 0.7s 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:`.Table.create`, :meth:`.Index.create`, and :meth:`.MetaData.create_all`.c K s
t d S( s< Emit CREATE statements for the given schema entity.
N( R ( R t entityRX ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt create s s 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:`.Table.drop`, :meth:`.Index.drop`, and :meth:`.MetaData.drop_all`.c K s
t d S( s: Emit DROP statements for the given schema entity.
N( R ( R Ro RX ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt drop s c O s
t d S( sA Executes the given construct and returns a :class:`.ResultProxy`.N( R ( R t object_t multiparamst params( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt execute s c O s
t d S( sz Executes and returns the first column of the first row.
The underlying cursor is closed after execution.
N( R ( R Rr Rs Rt ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt scalar s c K s
t d S( N( R ( R t visitorcallablet elementRX ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt _run_visitor s c C s
t d S( N( R ( R t elemRs Rt ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt _execute_clauseelement s N( RO RP RQ RF RE RM R RU Rn Rl Rp Rq Ru Rv Ry R{ ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyRk K s"
t ExceptionContextc B sP e Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z d Z d Z
e Z RS( s Encapsulate information about an error condition in progress.
This object exists solely to be passed to the
:meth:`.ConnectionEvents.handle_error` event, supporting an interface that
can be extended without backwards-incompatibility.
.. versionadded:: 0.9.7
N( RO RP RQ RE R RM R< R= R> t original_exceptiont sqlalchemy_exceptiont chained_exceptiont execution_contextRD RV t invalidate_pool_on_disconnect( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyR| s
N( RQ R] R t sql.compilerR R t objectR RW Ra Rk R| ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/engine/interfaces.pyt
s $zb