sqlalchemy.pool.base.ManagesConnection

class documentation

class ManagesConnection: (source)

Known subclasses: sqlalchemy.pool.base.ConnectionPoolEntry, sqlalchemy.pool.base.PoolProxiedConnection

Common base for the two connection-management interfaces :class:`.PoolProxiedConnection` and :class:`.ConnectionPoolEntry`. These two objects are typically exposed in the public facing API via the connection pool event hooks, documented at :class:`.PoolEvents`. .. versionadded:: 2.0

Method	`invalidate`	Mark the managed connection as invalidated.
Class Variable	`__slots__`	Undocumented
Class Variable	`dbapi_connection`	A reference to the actual DBAPI connection being tracked.
Class Variable	`driver_connection`	The "driver level" connection object as used by the Python DBAPI or database driver.
Property	`info`	Info dictionary associated with the underlying DBAPI connection referred to by this :class:`.ManagesConnection` instance, allowing user-defined data to be associated with the connection.
Property	`record_info`	Persistent info dictionary associated with this :class:`.ManagesConnection`.

def invalidate(self, e: Optional[BaseException] = None, soft: bool = False): (source) ¶

overridden in sqlalchemy.pool.base._AdhocProxiedConnection, sqlalchemy.pool.base._ConnectionFairy, sqlalchemy.pool.base._ConnectionRecord

Mark the managed connection as invalidated. :param e: an exception object indicating a reason for the invalidation. :param soft: if True, the connection isn't closed; instead, this connection will be recycled on next checkout. .. seealso:: :ref:`pool_connection_invalidation`

__slots__: tuple = (source) ¶

overridden in sqlalchemy.pool.base.ConnectionPoolEntry, sqlalchemy.pool.base.PoolProxiedConnection

Undocumented

dbapi_connection: Optional[DBAPIConnection] = (source) ¶

overridden in sqlalchemy.pool.base._AdhocProxiedConnection, sqlalchemy.pool.base._ConnectionFairy, sqlalchemy.pool.base._ConnectionRecord

A reference to the actual DBAPI connection being tracked. This is a :pep:`249`-compliant object that for traditional sync-style dialects is provided by the third-party DBAPI implementation in use. For asyncio dialects, the implementation is typically an adapter object provided by the SQLAlchemy dialect itself; the underlying asyncio object is available via the :attr:`.ManagesConnection.driver_connection` attribute. SQLAlchemy's interface for the DBAPI connection is based on the :class:`.DBAPIConnection` protocol object .. seealso:: :attr:`.ManagesConnection.driver_connection` :ref:`faq_dbapi_connection`

driver_connection: Optional[Any] = (source) ¶

overridden in sqlalchemy.pool.base._AdhocProxiedConnection, sqlalchemy.pool.base._ConnectionFairy, sqlalchemy.pool.base._ConnectionRecord

The "driver level" connection object as used by the Python DBAPI or database driver. For traditional :pep:`249` DBAPI implementations, this object will be the same object as that of :attr:`.ManagesConnection.dbapi_connection`. For an asyncio database driver, this will be the ultimate "connection" object used by that driver, such as the ``asyncpg.Connection`` object which will not have standard pep-249 methods. .. versionadded:: 1.4.24 .. seealso:: :attr:`.ManagesConnection.dbapi_connection` :ref:`faq_dbapi_connection`

@util.ro_memoized_property
info: _InfoType = (source) ¶

overridden in sqlalchemy.pool.base._ConnectionFairy, sqlalchemy.pool.base._ConnectionRecord

Info dictionary associated with the underlying DBAPI connection referred to by this :class:`.ManagesConnection` instance, allowing user-defined data to be associated with the connection. The data in this dictionary is persistent for the lifespan of the DBAPI connection itself, including across pool checkins and checkouts. When the connection is invalidated and replaced with a new one, this dictionary is cleared. For a :class:`.PoolProxiedConnection` instance that's not associated with a :class:`.ConnectionPoolEntry`, such as if it were detached, the attribute returns a dictionary that is local to that :class:`.ConnectionPoolEntry`. Therefore the :attr:`.ManagesConnection.info` attribute will always provide a Python dictionary. .. seealso:: :attr:`.ManagesConnection.record_info`

@util.ro_memoized_property
record_info: Optional[_InfoType] = (source) ¶

overridden in sqlalchemy.pool.base._AdhocProxiedConnection, sqlalchemy.pool.base._ConnectionFairy, sqlalchemy.pool.base._ConnectionRecord

Persistent info dictionary associated with this :class:`.ManagesConnection`. Unlike the :attr:`.ManagesConnection.info` dictionary, the lifespan of this dictionary is that of the :class:`.ConnectionPoolEntry` which owns it; therefore this dictionary will persist across reconnects and connection invalidation for a particular entry in the connection pool. For a :class:`.PoolProxiedConnection` instance that's not associated with a :class:`.ConnectionPoolEntry`, such as if it were detached, the attribute returns None. Contrast to the :attr:`.ManagesConnection.info` dictionary which is never None. .. seealso:: :attr:`.ManagesConnection.info`