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

Retain failed envelopes and diagnostics in framework-owned DB storage.

Method __init__ Bind failure storage to a framework database connection.
Async Method _ensureSchema Create the failure table on first use.
Async Method all Return recorded failures in chronological order.
Async Method close Leave the shared database connection under its manager's ownership.
Async Method find Find one persisted failure by identifier.
Async Method forget Remove one recorded failure.
Async Method record Record a terminal failure once for this reservation token.
Class Variable __slots__ Undocumented
Instance Variable _connection Undocumented
Instance Variable _definition Undocumented
Instance Variable _ready Undocumented
Instance Variable _ready_lock Undocumented
def __init__(self, connection: IConnection, table: str = 'failed_jobs'): (source)

Bind failure storage to a framework database connection.

Parameters
connection:IConnectionShared framework connection used for failure persistence.
table:str, optionalLogical table name for recorded failures.
Returns
NoneComplete the documented operation without returning a value.
async def _ensureSchema(self): (source)

Create the failure table on first use.

Returns
NoneEnsure the failure storage exists.
async def all(self) -> tuple[FailedJob, ...]: (source)

Return recorded failures in chronological order.

Returns
tuple of FailedJobPersisted failed jobs ordered by timestamp and identifier.
async def close(self): (source)

Leave the shared database connection under its manager's ownership.

Returns
NonePreserve the framework-managed connection lifecycle.
async def find(self, failure_id: str) -> FailedJob | None: (source)

Find one persisted failure by identifier.

Parameters
failure_id:strStable failure identifier returned by the repository.
Returns
FailedJob or NoneRecorded failure or no matching record.
async def forget(self, failure_id: str) -> bool: (source)

Remove one recorded failure.

Parameters
failure_id:strStable identifier of the failure to remove.
Returns
boolWhether a failure was removed.
async def record(self, reserved: ReservedJob, connection: str, exception: Exception) -> FailedJob: (source)

Record a terminal failure once for this reservation token.

Parameters
reserved:ReservedJobReservation whose encoded envelope must remain retryable.
connection:strQueue connection on which the job failed.
exception:ExceptionOriginal failure including its traceback.
Returns
FailedJobPersisted failure or its existing idempotent record.
_connection = (source)

Undocumented

_definition = (source)

Undocumented

Undocumented

_ready_lock = (source)

Undocumented