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 orm schema constraints components and public imports.

Module composite_foreign_key Multi-column foreign key constraint.
Module foreign_reference Immutable value object describing a foreign key reference.
Module table_index Composite index spanning one or more columns.
Module unique_constraint Composite UNIQUE constraint spanning one or more columns.

From __init__.py:

Class CompositeForeignKey Multi-column foreign key constraint.
Class ForeignReference Immutable value object describing a foreign key reference.
Class TableIndex Composite index spanning one or more columns.
Class UniqueConstraint Composite UNIQUE constraint spanning one or more 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
{'CompositeForeignKey': ('orionis.orm.schema.constraints.composite_foreign_key',
                         'CompositeForeignKey'),
 'ForeignReference': ('orionis.orm.schema.constraints.foreign_reference',
                      'ForeignReference'),
 'TableIndex': ('orionis.orm.schema.constraints.table_index', 'TableIndex'),
 'UniqueConstraint': ('orionis.orm.schema.constraints.unique_constraint',
                      'UniqueConstraint')}