sqlalchemy.ext.asyncio.engine

module documentation
(source)

Undocumented

Class AsyncConnectable Undocumented
Class AsyncConnection An asyncio proxy for a :class:`_engine.Connection`.
Class AsyncEngine An asyncio proxy for a :class:`_engine.Engine`.
Class AsyncTransaction An asyncio proxy for a :class:`_engine.Transaction`.
Function async_engine_from_config Create a new AsyncEngine instance using a configuration dictionary.
Function create_async_engine Create a new async engine instance.
Function _get_sync_engine_or_connection Undocumented
Function _no_insp_for_async_conn_yet Undocumented
Function _no_insp_for_async_engine_xyet Undocumented
Type Variable _T Undocumented
def async_engine_from_config(configuration: Dict[str, Any], prefix: str = 'sqlalchemy.', **kwargs: Any) -> AsyncEngine: (source)

Create a new AsyncEngine instance using a configuration dictionary. This function is analogous to the :func:`_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 :func:`_sa.engine_from_config`. .. versionadded:: 1.4.29

def create_async_engine(url: Union[str, URL], **kw: Any) -> AsyncEngine: (source)

Create a new async engine instance. Arguments passed to :func:`_asyncio.create_async_engine` are mostly identical to those passed to the :func:`_sa.create_engine` function. The specified dialect must be an asyncio-compatible dialect such as :ref:`dialect-postgresql-asyncpg`. .. versionadded:: 1.4

@overload
def _get_sync_engine_or_connection(async_engine: AsyncEngine) -> Engine:
@overload
def _get_sync_engine_or_connection(async_engine: AsyncConnection) -> Connection:
(source)

Undocumented

@inspection._inspects(AsyncConnection)
def _no_insp_for_async_conn_yet(subject: AsyncConnection) -> NoReturn: (source)

Undocumented

@inspection._inspects(AsyncEngine)
def _no_insp_for_async_engine_xyet(subject: AsyncEngine) -> NoReturn: (source)

Undocumented

_T = (source)

Undocumented

Value
TypeVar('_T',
        bound=Any)