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

View In Hierarchy

Generate a migration named for its creation date and time.

Method createFiles Create a migration with a timestamp from the application timezone.
Class Variable description Creates a timestamped database migration..
Class Variable path_key database_migrations.
Class Variable signature make:database-migration.
Class Variable success_label Database migration.
Class Variable template_name database_migration.
Class Variable timestamps Timestamps flag used by MakeDatabaseMigration.

Inherited from MakeStubCommand:

Method createFile Render one stub into its configured application directory.
Method getReplacements Read string replacements from the parsed command arguments.
Method getTemplateName Return the selected template name.
Async Method handle Create configured files without blocking the running event loop.
Class Variable arguments Command-line argument declarations accepted by this command.
Class Variable postfix Suffix appended to the generated resource name.
Class Variable prefix Prefix applied when constructing names or storage keys.
Class Variable replacement_arguments Command arguments forwarded to template placeholder replacement.
def createFiles(self, app: IApplication, name: str) -> tuple[tuple[str, str], ...]: (source)

Create a migration with a timestamp from the application timezone.

Parameters
app:orionis.IApplicationApplication that resolves the migrations directory.
name:strMigration name and optional nested directory path.
Returns
tuple[tuple[str, str], ...]Label and application-relative path of the new migration.
Raises
ValueErrorIf the migration name cannot form a Python module name.
description: str = (source)

Creates a timestamped database migration..

signature: str = (source)

make:database-migration.

timestamps: bool = (source)

Timestamps flag used by MakeDatabaseMigration.