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
Known subclasses: orionis.database.schema.schema.Schema
Define the contract for schema implementations.
| Method | connection |
Set the connection name for schema operations. |
| Method | create |
Start a fluent table declaration block with async with. |
| Async Method | create |
Create a table from a reusable, versioned schema definition. |
| Async Method | create |
Create the current table declared by a concrete model. |
| Async Method | drop |
Drop an existing table. |
| Class Variable | __slots__ |
Declare that this class introduces no additional instance slots. |
overridden in
orionis.database.schema.schema.SchemaSet the connection name for schema operations.
| Parameters | |
name:str | None, optional | The connection name to use, by default None. |
| Returns | |
typing.Self | The current Schema instance for method chaining. |
| Raises | |
ValueError | If connection name has already been defined. |
overridden in
orionis.database.schema.schema.SchemaStart a fluent table declaration block with async with.
The block yields a Blueprint so columns can be declared fluently; the table is created after the block exits successfully.
| Parameters | |
name:str | The name of the table to create. If the table belongs to a non-default schema, use the schema.table format. |
| Returns | |
orionis.database.schema.table_creation.TableCreation | Async context manager that collects definitions and creates the table after a successful block. |
overridden in
orionis.database.schema.schema.SchemaCreate a table from a reusable, versioned schema definition.
| Parameters | |
definition:orionis.orm.schema.TableDefinition | Definition shared by a model and a historical migration. |
| Returns | |
bool | Whether table creation completed successfully. |
overridden in
orionis.database.schema.schema.SchemaCreate the current table declared by a concrete model.
| Parameters | |
model:type of orionis.orm.Model | Model providing precompiled table and connection metadata. |
| Returns | |
bool | Whether table creation completed successfully. |
overridden in
orionis.database.schema.schema.SchemaDeclare that this class introduces no additional instance slots.