ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

module documentation

Undocumented

Function current_migration_connection Return the connection selected by the current migration step.
Function migration_connection_scope Bind unqualified migration operations to their tracking transaction.
Constant _MIGRATION_CONNECTION Undocumented
def current_migration_connection() -> IConnection | None: (source)

Return the connection selected by the current migration step.

Returns
IConnection or NoneConnection inherited by unqualified schema and ORM operations.
def migration_connection_scope(connection: IConnection) -> Generator[None]: (source)

Bind unqualified migration operations to their tracking transaction.

Parameters
connection:IConnectionConnection selected by the migration runner.
Returns
Generator[None]Undocumented
Yields
NoneThe previous binding is restored when the step finishes or fails.
_MIGRATION_CONNECTION: ContextVar[IConnection | None] = (source)

Undocumented

Value
ContextVar('orionis_migration_connection',
           default=None)