orionis.queues.contracts.failed_repository.IFailedJobRepository

ORIONIS API REFERENCE

Modules Classes Names

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

Known subclasses: orionis.queues.failed.repository.DatabaseFailedJobRepository

View In Hierarchy

Declare durable terminal failure inspection and removal.

Async Method	`all`	List persisted failures in creation order.
Async Method	`close`	Close resources owned by the repository.
Async Method	`find`	Find a persisted failure by its identifier.
Async Method	`forget`	Delete a persisted failure by its identifier.
Async Method	`record`	Persist the original payload and exception before acknowledgement.
Class Variable	`__slots__`	Undocumented

@abstractmethod

async def all(self) -> tuple[FailedJob, ...]: (source) ¶

overridden in orionis.queues.failed.repository.DatabaseFailedJobRepository

List persisted failures in creation order.

Returns
`tuple[FailedJob, ...]`	Failure records available for inspection.

@abstractmethod

async def close(self): (source) ¶

overridden in orionis.queues.failed.repository.DatabaseFailedJobRepository

Close resources owned by the repository.

Returns
`None`	Release repository-owned resources.

@abstractmethod

async def find(self, failed_id: str) -> FailedJob | None: (source) ¶

overridden in orionis.queues.failed.repository.DatabaseFailedJobRepository

Find a persisted failure by its identifier.

Parameters
failed_id:`str`	Failure identifier.

Returns
`FailedJob \| None`	Matching failure, if present.

@abstractmethod

async def forget(self, failed_id: str) -> bool: (source) ¶

overridden in orionis.queues.failed.repository.DatabaseFailedJobRepository

Delete a persisted failure by its identifier.

Parameters
failed_id:`str`	Failure identifier.

Returns
`bool`	Whether a record was removed.

@abstractmethod

async def record(self, reserved: ReservedJob, connection: str, exception: BaseException) -> FailedJob: (source) ¶

overridden in orionis.queues.failed.repository.DatabaseFailedJobRepository

Persist the original payload and exception before acknowledgement.

Parameters
reserved:`ReservedJob`	Failed claim, including corrupt wire data when applicable.
connection:`str`	Queue connection name.
exception:`BaseException`	Original execution or deserialization failure.

Returns
`FailedJob`	Durable failure record.

__slots__: tuple = (source) ¶

overridden in orionis.queues.failed.repository.DatabaseFailedJobRepository

Undocumented