orionis.database.schema.Blueprint

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

Constructor: Blueprint()

View In Hierarchy

Fluent collector of column definitions for a single table.

Instances are yielded by Schema.create(name) when used as an async context manager (async with schema.create(name) as table:), allowing columns to be declared one call at a time instead of passing every definition up front. Table-level constraints (Comment, ForeignKey, Index, PrimaryKey, Unique) are declared the same way, via table.comment(...), table.foreignKey(...), table.index(...), table.primaryKey(...) and table.unique(...).

Method	`__getattr__`	Proxy a column-factory call to `Column`, recording it.
Method	`__init__`	Initialize the blueprint with no columns declared yet.
Method	`columns`	Return the columns declared so far, in declaration order.
Method	`comment`	Attach a table-level comment.
Method	`definitions`	Return every column and table-level constraint declared so far.
Method	`foreignKey`	Declare a foreign key constraint on this table.
Method	`index`	Declare an index over one or more columns.
Method	`primaryKey`	Declare a (composite) primary key over one or more columns.
Method	`timestamps`	Add nullable `created_at` and `updated_at` columns.
Method	`unique`	Declare a unique constraint over one or more columns.
Class Variable	`__slots__`	Undocumented
Instance Variable	`__columns`	Undocumented
Instance Variable	`__constraints`	Undocumented
Instance Variable	`__factory_cache`	Undocumented

def __getattr__(self, name: str) -> Callable[..., ColumnDefinition]: (source) ¶

Proxy a column-factory call to Column, recording it.

This is what powers calls such as table.string("username") or table.boolean("is_admin"): any factory exposed by Column becomes available on the blueprint, and the resulting column is appended to this table automatically.

Parameters
name:`str`	Name of the `Column` factory method being invoked.

Returns
`Callable[..., ColumnDefinition]`	Wrapper that builds the column and appends it to this table.

Raises
`AttributeError`	If `name` does not match a known `Column` factory method.

def __init__(self): (source) ¶

Initialize the blueprint with no columns declared yet.

Returns
`None`	This method does not return a value.

def columns(self) -> tuple[ColumnDefinition, ...]: (source) ¶

Return the columns declared so far, in declaration order.

Returns
`tuple of ColumnDefinition`	Snapshot of every column recorded on this blueprint.

def comment(self, text: str) -> Comment: (source) ¶

Attach a table-level comment.

Parameters
text:`str`	The comment text content.

Returns
`Comment`	The constraint recorded on this blueprint.

Return every column and table-level constraint declared so far.

Returns
`tuple`	Columns followed by constraints, in the order each group was recorded on this blueprint.

def foreignKey(self, column: str, ref_table: str, ref_column: str, name: str | None = None) -> ForeignKey: (source) ¶

Declare a foreign key constraint on this table.

Parameters
column:`str`	The local column name.
ref_table:`str`	The referenced table name.
ref_column:`str`	The referenced column name.
name:`str \| None, optional`	The constraint name. Defaults to None.

Returns
`ForeignKey`	The constraint recorded on this blueprint.

def index(self, *columns: str, name: str | None = None, unique: bool = False) -> Index: (source) ¶

Declare an index over one or more columns.

Parameters
*columns:`str`	Column names to include in the index.
name:`str \| None, optional`	Name of the index. If not provided, a default name will be generated.
unique:`bool, optional`	Whether the index should enforce uniqueness. Default is False.

Returns
`Index`	The constraint recorded on this blueprint.

def primaryKey(self, *columns: str) -> PrimaryKey: (source) ¶

Declare a (composite) primary key over one or more columns.

Parameters
*columns:`str`	Column names that compose the primary key.

Returns
`PrimaryKey`	The constraint recorded on this blueprint.

def timestamps(self, *, timezone: bool = False): (source) ¶

Add nullable created_at and updated_at columns.

Parameters
timezone:`bool, optional`	Whether the timestamp columns should be timezone-aware.

Returns
`None`	This method does not return a value.

def unique(self, *columns: str, name: str | None = None) -> Unique: (source) ¶

Declare a unique constraint over one or more columns.

Parameters
*columns:`str`	Column names to apply the unique constraint to.
name:`str \| None, optional`	Name of the unique constraint. If not provided, a default name will be generated.

Returns
`Unique`	The constraint recorded on this blueprint.

__slots__: tuple[str, ...] = (source) ¶

Undocumented

__columns: list[ColumnDefinition] = (source) ¶

Undocumented

__constraints: list[Comment | ForeignKey | Index | PrimaryKey | Unique] = (source) ¶

Undocumented

__factory_cache: dict[str, Callable[..., ColumnDefinition]] = (source) ¶

Undocumented