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.

package documentation

Group the database schema components and public imports.

Module blueprint Fluent collector of column definitions for a single table.
Module column Create column definitions for database schema declarations.
Module comment Describe a database schema comment.
Module definition_bucket Mutable accumulator used while classifying schema definitions.
Module definitions Define definitions for database schema.
Module foreign Describe a foreign-key constraint and its referential actions.
Module index Describe a database index and its indexed columns.
Module primary Describe a primary-key constraint on a table.
Module schema Apply database schema operations to the selected connection.
Module table_creation Async context manager returned by Schema.create.
Module timestamp Describe the standard creation and update timestamp columns.
Module unique Describe a uniqueness constraint on table columns.

From __init__.py:

Class Blueprint Fluent collector of column definitions for a single table.
Class Column Create column definitions for database schema declarations.
Class Comment Describe a database schema comment.
Class ForeignKey Describe a foreign-key constraint and its referential actions.
Class Index Describe a database index and its indexed columns.
Class PrimaryKey Describe a primary-key constraint on a table.
Class Timestamps Describe the standard creation and update timestamp columns.
Class Unique Describe a uniqueness constraint on table columns.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'Blueprint': ('orionis.database.schema.blueprint', 'Blueprint'),
 'Column': ('orionis.database.schema.column', 'Column'),
 'Comment': ('orionis.database.schema.comment', 'Comment'),
 'ForeignKey': ('orionis.database.schema.foreign', 'ForeignKey'),
 'Index': ('orionis.database.schema.index', 'Index'),
 'PrimaryKey': ('orionis.database.schema.primary', 'PrimaryKey'),
 'Timestamps': ('orionis.database.schema.timestamp', 'Timestamps'),
...