Skip to content

xtr_orm.command

The orm:* console commands.

Importing this module declares them. With a container, the orm bundle loads it when the console bundle is active, and every command acts on the connections the bundle registered.

Every command takes that :class:~xtr_orm.ConnectionRegistry as its one constructor argument, so a console application registering them itself builds each with a registry of its own:

from xtr_orm import ConnectionRegistry
from xtr_orm.command import MigrationsMigrateCommand

registry = ConnectionRegistry()
registry.register("default", engine=engine, migrator=migrator, database=database)
command = MigrationsMigrateCommand(registry)

Needs xtr-console installed beside this package.

DatabaseCreateCommand

DatabaseCreateCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Creates a connection's database on its server.

DatabaseDropCommand

DatabaseDropCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Drops a connection's database from its server.

MigrationsCurrentCommand

MigrationsCurrentCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Prints the revisions the database is at.

MigrationsDiffCommand

MigrationsDiffCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Writes a revision of what differs between the database and the table definitions.

MigrationsDumpSchemaCommand

MigrationsDumpSchemaCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Writes a first revision creating every table an existing database has.

MigrationsExecuteCommand

MigrationsExecuteCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Runs chosen revisions alone, each up or down.

MigrationsGenerateCommand

MigrationsGenerateCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Writes an empty revision to fill in by hand.

MigrationsLatestCommand

MigrationsLatestCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Prints the revisions no other follows.

MigrationsListCommand

MigrationsListCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Lists every revision and whether it is applied.

MigrationsMigrateCommand

MigrationsMigrateCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Brings the database to a revision, up or down.

MigrationsRollupCommand

MigrationsRollupCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Records the single remaining revision as all the database has applied.

MigrationsStatusCommand

MigrationsStatusCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Shows where the database stands against its revisions.

MigrationsUpToDateCommand

MigrationsUpToDateCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Tells whether every revision is applied.

MigrationsVersionCommand

MigrationsVersionCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Records revisions as applied or not, running nothing.

RunSqlCommand

RunSqlCommand(connections: ConnectionRegistry)

Bases: ConnectionCommand

Runs a statement and shows what it returned.