orionis.database.contracts.schema.ISchema

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 ISchema(ABC): (source)

Undocumented

Method	`connection`	Set the connection name for schema operations.
Method	`create`	Start a fluent table declaration block with `async with`.
Async Method	`createFromDefinition`	Create a table from a reusable, versioned schema definition.
Async Method	`createFromModel`	Create the current table declared by a concrete model.
Async Method	`drop`	Drop an existing table.
Class Variable	`__slots__`	Undocumented

def connection(self, name: str | None = None) -> Self: (source) ¶

overridden in orionis.database.schema.schema.Schema

Set the connection name for schema operations.

Parameters
name:`str \| None, optional`	The connection name to use, by default None.

Returns
`Self`	The current Schema instance for method chaining.

Raises
`ValueError`	If connection name has already been defined.

def create(self, name: str) -> TableCreation: (source) ¶

overridden in orionis.database.schema.schema.Schema

Start 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
`TableCreation`	Async context manager that collects definitions and creates the table after a successful block.

async def createFromDefinition(self, definition: TableDefinition) -> bool: (source) ¶

overridden in orionis.database.schema.schema.Schema

Create a table from a reusable, versioned schema definition.

Parameters
definition:`TableDefinition`	Definition shared by a model and a historical migration.

Returns
`bool`	Whether table creation completed successfully.

async def createFromModel(self, model: type[Model]) -> bool: (source) ¶

overridden in orionis.database.schema.schema.Schema

Create the current table declared by a concrete model.

Parameters
model:`type of Model`	Model providing precompiled table and connection metadata.

Returns
`bool`	Whether table creation completed successfully.

async def drop(self, name: str) -> bool: (source) ¶

overridden in orionis.database.schema.schema.Schema

Drop an existing table.

Parameters
name:`str`	The name of the table to drop. If the table belongs to a non-default schema, use the `schema.table` format.

Returns
`bool`	`True` when the table is dropped without errors.

overridden in orionis.database.schema.schema.Schema

Undocumented