orionis.console.commands.migrate.base.MigrationCommand

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.

Explore modules View classes

class documentation

class MigrationCommand(BaseCommand): (source)

View In Hierarchy

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`	Undocumented
Class Variable	`timestamps`	Undocumented

def progressEvents(self) -> MigrationEvents: (source) ¶

Build the progress callbacks rendering one line per migration.

Returns
`MigrationEvents`	Callbacks printing RUNNING, DONE, and FAIL lines.

def reportEmpty(self, message: str): (source) ¶

Report that the command had nothing to do.

Parameters
message:`str`	Message describing why nothing ran.

Returns
`None`	This 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 None`	Named connection, or `None` for the default one.

arguments: ClassVar[list[Argument]] = (source) ¶

overridden in orionis.console.commands.db.show.DbShowCommand, orionis.console.commands.db.table.DbTableCommand, orionis.console.commands.migrate.migrate.MigrateCommand, orionis.console.commands.migrate.refresh.MigrateRefreshCommand, orionis.console.commands.migrate.rollback.MigrateRollbackCommand

Undocumented

timestamps: bool = (source) ¶

overridden in orionis.console.commands.db.show.DbShowCommand, orionis.console.commands.db.table.DbTableCommand

Undocumented