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 configuration entity for a database-backed cache store.

Mirrors database cache store configuration array, supporting a dedicated connection/table for cache entries and an independent connection/table for the atomic locks used by Cache::lock().

Method __post_init__ Validate the Database cache configuration after initialization.
Method __validateConnection Validate the connection property.
Method __validateDriver Validate the driver property.
Instance Variable connection The database connection name used to store cache entries. Resolved from the DB_CACHE_CONNECTION environment variable or None to use the application's default connection.
Instance Variable driver The driver type. Defaults to 'database'.
Instance Variable lock_table The database table name used to store cache locks. Must match the pattern [a-z_]+ when provided. Resolved from the DB_CACHE_LOCK_TABLE environment variable or None to let the driver fall back to its own default.
Instance Variable table The database table name used to store cache entries. Must match the pattern [a-z_]+. Resolved from the DB_CACHE_TABLE environment variable or defaults to 'cache'.

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: Self): (source)

Validate the Database cache configuration after initialization.

Returns
NoneValidates every field against its declared type hint.
Raises
TypeErrorIf any property does not match its expected type.
ValueErrorIf table or lock_table fail table-name validation.
def __validateConnection(self: Self): (source)

Validate the connection property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf connection is neither a string nor None.
def __validateDriver(self: Self): (source)

Validate the driver property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf driver is not a string.
ValueErrorIf driver is an empty string.
connection: str | None = (source)

The database connection name used to store cache entries. Resolved from the DB_CACHE_CONNECTION environment variable or None to use the application's default connection.

The driver type. Defaults to 'database'.

lock_table: str | None = (source)

The database table name used to store cache locks. Must match the pattern [a-z_]+ when provided. Resolved from the DB_CACHE_LOCK_TABLE environment variable or None to let the driver fall back to its own default.

The database table name used to store cache entries. Must match the pattern [a-z_]+. Resolved from the DB_CACHE_TABLE environment variable or defaults to 'cache'.