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 a table schema summary.

Async Method handle Inspect the requested table and render its schema details.
Class Variable arguments Command-line argument declarations accepted by this command.
Class Variable description Shows columns, indexes and keys for a database table..
Class Variable signature db:table.
Class Variable timestamps Timestamps flag used by DbTableCommand.

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) -> int: (source)

Inspect the requested table and render its schema details.

Parameters
conn_manager:orionis.database.contracts.IConnectionManagerConnection manager used to resolve the active database.
Returns
intExit status code for the command: 0 on success and 1 when the table name is invalid.
arguments: ClassVar[list[Argument]] = (source)

Command-line argument declarations accepted by this command.

description: str = (source)

Shows columns, indexes and keys for a database table..

signature: str = (source)

db:table.

timestamps: bool = (source)

Timestamps flag used by DbTableCommand.