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

Module compiler Translate Orionis query plans into engine-executable statements.
Module connection Named database connection encapsulating the SQL engine.
Module connection_manager Resolve named database connections and manage their lifecycle.
Package contracts Group the database contracts components and public imports.
Module dialect Provide database operations.
Package entities Group the database entities components and public imports.
Module exceptions Provide database operations.
Package migrations Group the database migrations components and public imports.
Module provider Register connection manager services in the application container.
Module redshift Define redshift for database.
Package schema Group the database schema components and public imports.
Module schema_provider Register schema services in the application container.
Package seeders Group the database seeders components and public imports.
Package threaded Thread-backed SQLAlchemy Core execution for blocking database connectors.
Module transaction Async context manager driving a connection-level transaction.

From __init__.py:

Class Connection Named database connection encapsulating the SQL engine.
Class ConnectionManager Resolve named database connections and manage their lifecycle.
Class Migration Abstract base class for all database migrations.
Class SQLCompiler Translate Orionis query plans into engine-executable statements.
Class Transaction Async context manager driving a connection-level transaction.
Exception ConnectionNotFoundException Raised when a connection name is not present in the configuration.
Exception DatabaseException Base exception for all database-related errors.
Exception MigrationNotFoundException Raised when a recorded migration has no matching migration file.
Exception MissingDatabaseDependencyException Raised when a driver requires an optional package that is not installed.
Exception QueryException Raised when a statement fails to compile or execute.
Exception TransactionException Raised when transaction control methods are used incorrectly.
Exception UnsupportedDriverException Raised when a connection references a driver with no implementation.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXCEPTIONS_MODULE Module defining the exported database exception types.
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.
_EXCEPTIONS_MODULE: str = (source)

Module defining the exported database exception types.

Value
'orionis.database.exceptions'
_EXPORTS = (source)

Public export names mapped to their defining modules and attributes.

Value
{'Connection': ('orionis.database.connection', 'Connection'),
 'ConnectionManager': ('orionis.database.connection_manager',
                       'ConnectionManager'),
 'ConnectionNotFoundException': (_EXCEPTIONS_MODULE,
                                 'ConnectionNotFoundException'),
 'DatabaseException': (_EXCEPTIONS_MODULE, 'DatabaseException'),
 'Migration': ('orionis.database.contracts.migration', 'Migration'),
...