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.

Explore modules View classes

orionis.database

package documentation
(source)

Undocumented

Module compiler Undocumented
Module connection No module docstring; 0/1 constant, 1/1 function, 1/1 class documented
Module connection_manager Undocumented
Package contracts No package docstring; 2/3 classes, 0/6 module documented
Module dialect No module docstring; 0/9 constant, 20/20 functions, 1/1 class documented
Package entities No package docstring; 1/1 class, 0/1 module documented
Module exceptions Undocumented
Package migrations No package docstring; 1/1 class, 0/3 module documented
Module provider Undocumented
Package schema No package docstring; 2/8 classes, 0/12 module documented
Module schema_provider Undocumented
Package seeders No package docstring; 2/2 classes, 0/3 module documented
Module transaction Undocumented

From __init__.py:

Class Connection Named database connection encapsulating the SQL engine.
Class ConnectionManager No class docstring; 0/3 instance variable, 0/1 class variable, 9/9 methods documented
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 _EXPORTS Undocumented
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)

Undocumented

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