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.

class documentation

Base class shared by every migration console command.

It centralizes the pieces all of them repeat: the --database option selecting the target connection and the wiring that renders one RUNNING/DONE (or FAIL) line per migration.

Method progressEvents Build the progress callbacks rendering one line per migration.
Method reportEmpty Report that the command had nothing to do.
Method targetConnection Return the connection the command was asked to run against.
Class Variable arguments Every migration command targets an optional named connection.
Class Variable timestamps Indicates whether timestamps will be shown in the command output.
def progressEvents(self) -> MigrationEvents: (source)

Build the progress callbacks rendering one line per migration.

Returns
orionis.database.migrations.events.MigrationEventsCallbacks printing RUNNING, DONE, and FAIL lines.
def reportEmpty(self, message: str): (source)

Report that the command had nothing to do.

Parameters
message:strMessage describing why nothing ran.
Returns
NoneThis method does not return a value.
def targetConnection(self) -> str | None: (source)

Return the connection the command was asked to run against.

Returns
str or NoneNamed connection, or None for the default one.
timestamps: bool = (source)

Indicates whether timestamps will be shown in the command output.