sqlalchemy.ext.asyncio.engine

module documentation

Undocumented

Class ​Async​Connection An asyncio proxy for a _engine.Connection.
Class ​Async​Engine An asyncio proxy for a _engine.Engine.
Class ​Async​Transaction An asyncio proxy for a _engine.Transaction.
Class ​Async​Connectable Undocumented
Function ​_get​_sync​_engine​_or​_connection Undocumented
Function ​_no​_insp​_for​_async​_conn​_yet Undocumented
Function ​_no​_insp​_for​_async​_engine​_xyet Undocumented
Function async​_engine​_from​_config Create a new AsyncEngine instance using a configuration dictionary.
Function create​_async​_engine Create a new async engine instance.
def _get_sync_engine_or_connection(async_engine):

Undocumented

@inspection._inspects(AsyncConnection)
def _no_insp_for_async_conn_yet(subject):

Undocumented

@inspection._inspects(AsyncEngine)
def _no_insp_for_async_engine_xyet(subject):

Undocumented

def async_engine_from_config(configuration, prefix='sqlalchemy.', **kwargs):

Create a new AsyncEngine instance using a configuration dictionary.

This function is analogous to the _sa.engine_from_config function in SQLAlchemy Core, except that the requested dialect must be an asyncio-compatible dialect such as :ref:`dialect-postgresql-asyncpg`. The argument signature of the function is identical to that of _sa.engine_from_config.

New in version 1.4.29.
def create_async_engine(*arg, **kw):

Create a new async engine instance.

Arguments passed to _asyncio.create_async_engine are mostly identical to those passed to the _sa.create_engine function. The specified dialect must be an asyncio-compatible dialect such as :ref:`dialect-postgresql-asyncpg`.

New in version 1.4.