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

class QueueClearCommand(BaseCommand): (source)

View In Hierarchy

Clear every pending state from one logical queue.

Async Method handle Remove the selected queue's jobs and report the count.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable arguments Command-line argument declarations accepted by this command.
Class Variable description Delete ready, delayed, and reserved jobs from a queue..
Class Variable signature queue:clear.
Class Variable timestamps Timestamps flag used by QueueClearCommand.
async def handle(self, manager: IQueueManager) -> int: (source)

Remove the selected queue's jobs and report the count.

Parameters
manager:orionis.queues.contracts.manager.IQueueManagerQueue manager resolving the selected backend.
Returns
intZero on success or one for an invalid backend or queue.
__slots__: tuple = (source)

Declare that this class introduces no additional instance slots.

arguments: ClassVar[list[Argument]] = (source)

Command-line argument declarations accepted by this command.

description: str = (source)

Delete ready, delayed, and reserved jobs from a queue..

signature: str = (source)

queue:clear.

timestamps: bool = (source)

Timestamps flag used by QueueClearCommand.