Queues

Managing RabbitMQ queues and their messages.

actions(vhost: str, queue: str, value: dict) -> dict async

Perform administrative actions on a queue.

Parameters:

Name	Type	Description	Default
value	dict	Dict with 'action' (e.g., {"action": "sync"} or "cancel_sync").	required

all(*, enable_queue_totals: bool = False, disable_stats: bool = False) -> list[dict] async

List all queues in the cluster.

Parameters:

Name	Type	Description	Default
enable_queue_totals	bool	Return simplified set of fields.	False
disable_stats	bool	Reduce CPU/bandwidth footprint by omitting detailed stats.	False

bindings(vhost: str, queue: str) -> list[dict] async

List all bindings for a specific queue.

by_vhost(vhost: str) -> list[dict] async

List all queues in a specific virtual host.

delete(vhost: str, queue: str) -> dict async

Delete a specific queue.

detail(vhost: str, queue: str) -> dict async

Get details of a specific queue.

messages(vhost: str, queue: str, value: dict) -> list[dict] async

Fetch messages from a queue for diagnostic purposes.

Parameters:

Name	Type	Description	Default
value	dict	Dict with 'count', 'ackmode' (e.g., 'ack_requeue_true'), 'encoding', and optional 'truncate'.	required

Note

This is a management tool, not a high-performance messaging API.

purge(vhost: str, queue: str) -> dict async

Remove all messages from the queue without deleting the queue itself.

set(vhost: str, queue: str, value: dict) -> dict async

Create or update a queue.

Parameters:

Name	Type	Description	Default
value	dict	Dict with optional keys: 'auto_delete', 'durable', 'arguments', 'node'.	required