orionis.cache.stores.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.

module documentation

(source)

Undocumented

Class	`DatabaseCacheBackend`	Cache backend that stores entries in a relational database table.
Function	`_build_entries_table`	Build the table definition for the cache entries table.
Function	`_build_locks_table`	Build the table definition for the atomic-locks table.
Function	`build`	Build and return a `DatabaseCacheBackend`.
Constant	`_DEFAULT_LOCK_TABLE`	Undocumented
Constant	`_INCREMENT_ATTEMPTS`	Undocumented
Constant	`_MISSING`	Undocumented

def _build_entries_table(table: str) -> TableDefinition: (source) ¶

Build the table definition for the cache entries table.

Parameters
table:`str`	Logical table name for cache entries.

Returns
`TableDefinition`	Definition with `cache_key` (primary key), `cache_value` (JSON payload) and `expiration` (epoch seconds, sub-second precision, nullable) columns.

def _build_locks_table(table: str) -> TableDefinition: (source) ¶

Build the table definition for the atomic-locks table.

Parameters
table:`str`	Logical table name for cache locks.

Returns
`TableDefinition`	Definition with `cache_key` (primary key), `owner` and `expiration` (epoch seconds, sub-second precision) columns.

def build(connection: IConnection, table: str, lock_table: str | None = None) -> DatabaseCacheBackend: (source) ¶

Build and return a DatabaseCacheBackend.

Parameters
connection:`IConnection`	Database connection used to store cache entries and locks.
table:`str`	Table name used to store cache entries.
lock_table:`str \| None`	Table name used to store atomic locks.

Returns
`DatabaseCacheBackend`	Configured database-backed cache backend.

Undocumented

Value

'cache_locks'

Undocumented

Value

Undocumented

Value

object()