Skip to main content

purge

Erase all messages from all known task queues.

Warning:

There's no undo operation for this command.
def purge(
ctx: click.Context,
force: boolean = False,
queues: list = null,
exclude_queues: list = null,
**kwargs: dict
) - > null

Erase all messages from all known task queues. Warning: There's no undo operation for this command.

Parameters

NameTypeDescription
ctxclick.ContextThe Click context object containing the Celery application instance and styling utilities.
forceboolean = FalseIf true, bypasses the interactive confirmation prompt before deleting messages.
queueslist = nullA list of specific queue names to target for message deletion; defaults to all known queues if not provided.
exclude_queueslist = nullA list of queue names that should be skipped and protected from the purge operation.
**kwargsdictAdditional keyword arguments passed from the command line interface.

Returns

TypeDescription
nullThis function does not return a value; it outputs the purge results to the console.