sqlalchemy.pool.base.PoolProxiedConnection

class documentation

class PoolProxiedConnection(ManagesConnection): (source)

Known subclasses: sqlalchemy.pool.base._AdhocProxiedConnection, sqlalchemy.pool.base._ConnectionFairy

View In Hierarchy

A connection-like adapter for a :pep:`249` DBAPI connection, which includes additional methods specific to the :class:`.Pool` implementation. :class:`.PoolProxiedConnection` is the public-facing interface for the internal :class:`._ConnectionFairy` implementation object; users familiar with :class:`._ConnectionFairy` can consider this object to be equivalent. .. versionadded:: 2.0 :class:`.PoolProxiedConnection` provides the public- facing interface for the :class:`._ConnectionFairy` internal class.

Method close Release this connection back to the pool.
Method commit Undocumented
Method cursor Undocumented
Method detach Separate this connection from its Pool.
Method rollback Undocumented
Class Variable __slots__ Undocumented
Property is_detached Return True if this :class:`.PoolProxiedConnection` is detached from its pool.
Property is_valid Return True if this :class:`.PoolProxiedConnection` still refers to an active DBAPI connection.

Inherited from ManagesConnection:

Method invalidate Mark the managed connection as invalidated.
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 close(self): (source)
overridden in sqlalchemy.pool.base._ConnectionFairy

Release this connection back to the pool. The :meth:`.PoolProxiedConnection.close` method shadows the :pep:`249` ``.close()`` method, altering its behavior to instead :term:`release` the proxied connection back to the connection pool. Upon release to the pool, whether the connection stays "opened" and pooled in the Python process, versus actually closed out and removed from the Python process, is based on the pool implementation in use and its configuration and current state.

def commit(self): (source)

Undocumented

def cursor(self) -> DBAPICursor: (source)
overridden in sqlalchemy.pool.base._AdhocProxiedConnection, sqlalchemy.pool.base._ConnectionFairy

Undocumented

def detach(self): (source)
overridden in sqlalchemy.pool.base._ConnectionFairy

Separate this connection from its Pool. This means that the connection will no longer be returned to the pool when closed, and will instead be literally closed. The associated :class:`.ConnectionPoolEntry` is de-associated from this DBAPI connection. Note that any overall connection limiting constraints imposed by a Pool implementation may be violated after a detach, as the detached connection is removed from the pool's knowledge and control.

def rollback(self): (source)

Undocumented

__slots__: tuple = (source)
overrides sqlalchemy.pool.base.ManagesConnection.__slots__
overridden in sqlalchemy.pool.base._AdhocProxiedConnection, sqlalchemy.pool.base._ConnectionFairy

Undocumented

@property
is_detached: bool = (source)
overridden in sqlalchemy.pool.base._ConnectionFairy

Return True if this :class:`.PoolProxiedConnection` is detached from its pool.

@property
is_valid: bool = (source)
overridden in sqlalchemy.pool.base._AdhocProxiedConnection, sqlalchemy.pool.base._ConnectionFairy

Return True if this :class:`.PoolProxiedConnection` still refers to an active DBAPI connection.