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.

class documentation

Represent the general database configuration.

Method __post_init__ Validate and normalize the 'default' and 'connections' attributes.
Instance Variable connections The different database connections available to the application.
Instance Variable default The name of the default database connection to use. Accepts a ConnectionName enum member or a plain string (e.g. 'sqlite').

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
def __post_init__(self): (source)

Validate and normalize the 'default' and 'connections' attributes.

Validates that the 'default' attribute is a valid ConnectionName member or a string corresponding to one. Ensures that the 'connections' attribute is an instance of Connections or a dictionary. Raises an exception if validation fails.

Parameters
self:orionis.foundation.config.database.DatabaseThe instance of the Database class.
Returns
NoneThis method does not return a value.

The different database connections available to the application.

default: orionis.foundation.config.database.ConnectionName | str = (source)

The name of the default database connection to use. Accepts a ConnectionName enum member or a plain string (e.g. 'sqlite').