diff options
| author | Federico Caselli <cfederico87@gmail.com> | 2021-08-31 23:03:18 +0200 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2021-09-17 18:08:42 -0400 |
| commit | 26140c08111da9833dd2eff0b5091494f253db46 (patch) | |
| tree | 61a64b7361ab0890521771a5d185db787482eaaf /README.dialects.rst | |
| parent | 204fe7ea206a1b0ab4ae248006f99afd15fa7f72 (diff) | |
| download | sqlalchemy-26140c08111da9833dd2eff0b5091494f253db46.tar.gz | |
Surface driver connection object when using a proxied dialect
Improve the interface used by adapted drivers, like the asyncio ones,
to access the actual connection object returned by the driver.
The :class:`_engine._ConnectionRecord` and
:class:`_engine._ConnectionFairy` now have two new attributes:
* ``dbapi_connection`` always represents a DBAPI compatible
object. For pep-249 drivers, this is the DBAPI connection as it always
has been, previously accessed under the ``.connection`` attribute.
For asyncio drivers that SQLAlchemy adapts into a pep-249 interface,
the returned object will normally be a SQLAlchemy adaption object
called :class:`_engine.AdaptedConnection`.
* ``driver_connection`` always represents the actual connection object
maintained by the third party pep-249 DBAPI or async driver in use.
For standard pep-249 DBAPIs, this will always be the same object
as that of the ``dbapi_connection``. For an asyncio driver, it will be
the underlying asyncio-only connection object.
The ``.connection`` attribute remains available and is now a legacy alias
of ``.dbapi_connection``.
Fixes: #6832
Change-Id: Ib72f97deefca96dce4e61e7c38ba430068d6a82e
Diffstat (limited to 'README.dialects.rst')
| -rw-r--r-- | README.dialects.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/README.dialects.rst b/README.dialects.rst index 50fcdb7f5..810267a20 100644 --- a/README.dialects.rst +++ b/README.dialects.rst @@ -183,6 +183,18 @@ Key aspects of this file layout include: # [ODBC Microsoft Access Driver] Optional feature not implemented. return +AsyncIO dialects +---------------- + +As of version 1.4 SQLAlchemy supports also dialects that use +asyncio drivers to interface with the database backend. + +SQLAlchemy's approach to asyncio drivers is that the connection and cursor +objects of the driver (if any) are adapted into a pep-249 compliant interface, +using the ``AdaptedConnection`` interface class. Refer to the internal asyncio +driver implementations such as that of ``asyncpg``, ``asyncmy`` and +``aiosqlite`` for examples. + Going Forward ============== |