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

Render connection details and a table summary.

Async Method handle Fetch metadata and render the database summary.
Class Variable arguments Command-line argument declarations accepted by this command.
Class Variable description Shows database information and table summaries..
Class Variable signature db:show.
Class Variable timestamps Timestamps flag used by DbShowCommand.

Inherited from MigrationCommand:

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.
async def handle(self, conn_manager: IConnectionManager): (source)

Fetch metadata and render the database summary.

Parameters
conn_manager:orionis.database.contracts.IConnectionManagerConnection manager used to resolve the active database.
Returns
NoneThe command writes the summary to the console.
arguments: ClassVar[list[Argument]] = (source)

Command-line argument declarations accepted by this command.

description: str = (source)

Shows database information and table summaries..

signature: str = (source)

db:show.

timestamps: bool = (source)

Timestamps flag used by DbShowCommand.