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

class MigrateStatusCommand(MigrationCommand): (source)

View In Hierarchy

Report which migrations are applied and which are pending.

Async Method handle Print the applied/pending status of every migration.
Class Variable description Shows the status of every discovered migration..
Class Variable signature migrate:status.

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.
Class Variable arguments Every migration command targets an optional named connection.
Class Variable timestamps Indicates whether timestamps will be shown in the command output.
async def handle(self, migrator: Migrator): (source)

Print the applied/pending status of every migration.

Parameters
migrator:orionis.database.migrations.MigratorService that discovers migrations and reads their history.
Returns
NoneThis method does not return a value.
description: str = (source)

Shows the status of every discovered migration..

signature: str = (source)

migrate:status.