orionis.queues.drivers.database.DatabaseQueueDriver

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

Constructor: DatabaseQueueDriver(connection, table)

View In Hierarchy

Persist queued jobs using atomic conditional updates and expiring leases.

Method	`__init__`	Bind the queue driver to a framework database connection.
Async Method	`_ensureSchema`	Create the queue table on first use.
Method	`_ownershipClauses`	Require a current, unexpired reservation for a transition.
Async Method	`clear`	Remove every job in one logical queue.
Async Method	`close`	Leave the shared database connection under its manager's ownership.
Async Method	`delete`	Acknowledge an owned reservation by removing its row.
Async Method	`push`	Store an envelope for immediate or delayed consumption.
Async Method	`release`	Release an owned reservation for another attempt.
Async Method	`reserve`	Claim one eligible job in queue priority order.
Async Method	`size`	Count ready, delayed, and reserved jobs in one queue.
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 = 'jobs'): (source) ¶

Bind the queue driver to a framework database connection.

Parameters
connection:`IConnection`	Shared framework connection used for queue persistence.
table:`str, optional`	Logical table name, with the connection prefix applied by DB.

Returns
`None`	Complete the documented operation without returning a value.

async def _ensureSchema(self): (source) ¶

Create the queue table on first use.

Returns
`None`	Ensure the queue storage exists.

def _ownershipClauses(self, reserved: ReservedJob) -> list[WhereClause]: (source) ¶

Require a current, unexpired reservation for a transition.

Parameters
reserved:`ReservedJob`	Reservation whose ownership must still hold.

Returns
`list of WhereClause`	Predicates fencing reclaimed and expired reservations.

async def clear(self, queue: str) -> int: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.clear

Remove every job in one logical queue.

Parameters
queue:`str`	Logical queue whose jobs are removed.

Returns
`int`	Number of removed jobs, including active reservations.

async def close(self): (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.close

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

Returns
`None`	Preserve the framework-managed connection lifecycle.

async def delete(self, reserved: ReservedJob) -> bool: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.delete

Acknowledge an owned reservation by removing its row.

Parameters
reserved:`ReservedJob`	Reservation owned by the acknowledging worker.

Returns
`bool`	Whether a current reservation was removed.

async def push(self, envelope: JobEnvelope, delay: float = 0) -> str: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.push

Store an envelope for immediate or delayed consumption.

Parameters
envelope:`JobEnvelope`	Immutable serialized job configuration and state.
delay:`float, optional`	Seconds before the job becomes available.

Returns
`str`	Persisted job identifier.

async def release(self, reserved: ReservedJob, delay: float = 0) -> bool: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.release

Release an owned reservation for another attempt.

Parameters
reserved:`ReservedJob`	Reservation owned by the releasing worker.
delay:`float, optional`	Seconds before the job becomes available again.

Returns
`bool`	Whether a current reservation was released.

async def reserve(self, queues: tuple[str, ...], retry_after: float) -> ReservedJob | None: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.reserve

Claim one eligible job in queue priority order.

Parameters
queues:`tuple of str`	Logical queues ordered from highest to lowest priority.
retry_after:`float`	Lease duration in seconds.

Returns
`ReservedJob or None`	Acquired reservation, or no available job.

Raises
`QueueStorageError`	If an ambient transaction would prevent committing the claim.

async def size(self, queue: str) -> int: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.size

Count ready, delayed, and reserved jobs in one queue.

Parameters
queue:`str`	Logical queue whose jobs are counted.

Returns
`int`	Total number of persisted jobs in the queue.

__slots__: tuple[str, ...] = (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.__slots__

Undocumented

_connection = (source) ¶

Undocumented

_definition = (source) ¶

Undocumented

_ready: bool = (source) ¶

Undocumented

_ready_lock = (source) ¶

Undocumented