Skip to content

sqlalchemy

Functions:

async_engine_provider async

async_engine_provider(
    url: str | URL, **kwargs: Any
) -> AsyncIterator[AsyncEngine]

Provide an async SQLAlchemy engine.

async_session_provider async

async_session_provider(
    cls: Callable[..., A] = AsyncSession,
    *args: Any,
    **kwargs: Any
) -> AsyncIterator[A]

Provide an async SQLAlchemy session.

Parameters:

  • cls

    (Callable[..., A], default: AsyncSession ) –

    The session class to instantiate. Defaults to AsyncSession.

  • args

    (Any, default: () ) –

    Positional arguments to pass to the session constructor.

  • kwargs

    (Any, default: {} ) –

    Keyword arguments to pass to the session constructor.

engine_provider

engine_provider(
    url: str | URL, **kwargs: Any
) -> Iterator[Engine]

Provide a SQLAlchemy engine.

session_provider

session_provider(
    cls: Callable[..., S] = Session,
    *args: Any,
    **kwargs: Any
) -> Iterator[S]

Provide a SQLAlchemy session.

Parameters:

  • cls

    (Callable[..., S], default: Session ) –

    The session class to instantiate. Defaults to Session.

  • args

    (Any, default: () ) –

    Positional arguments to pass to the session constructor.

  • kwargs

    (Any, default: {} ) –

    Keyword arguments to pass to the session constructor.