orionis.foundation.config.database.Database

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

class documentation

class Database(BaseEntity): (source)

View In Hierarchy

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	`getFields`	Describe field names, normalized types, defaults, and metadata.
Method	`toDict`	Convert the dataclass instance to a recursively copied dictionary.
Class Variable	`__slots__`	Undocumented

def __post_init__(self): (source) ¶

overrides orionis.support.entities.BaseEntity.__post_init__

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:`Database`	The instance of the Database class.

Returns
`None`	This method does not return a value.

connections: Connections or dict = (source) ¶

The different database connections available to the application.

default: ConnectionName | str = (source) ¶

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