queue

Queue API Reference

Python SDK

Function	Description
ack	Acknowledge successful job completion.
ack_batch	Acknowledge multiple jobs as completed.
cancel	Cancel a pending job by deleting it.
clear_actor	Clear actor context.
create_schedule	Create a recurring schedule that produces jobs automatically.
delete_schedule	Delete a schedule by name.
extend_visibility	Extend the visibility timeout of a running job.
fail	Move job to dead letter queue (permanent failure).
get_queue_stats	Get per-queue statistics with operational metrics.
get_schedule	Get a schedule by name.
get_stats	Get namespace-wide queue statistics.
list_schedules	List schedules with optional filters and cursor pagination.
nack	Return job to queue for retry (temporary failure).
pause_schedule	Pause an active schedule.
pull	Pull one job from a queue.
pull_any	Pull one job from multiple queues (priority order).
pull_batch	Pull multiple jobs from a queue.
purge_dead_letters	Delete old un-retried dead letters.
purge_queue	Delete all pending jobs from a queue.
push	Push a job onto a queue.
push_batch	Push multiple jobs onto a queue efficiently.
release_jobs	Release all jobs held by a worker, returning them to pending.
resume_schedule	Resume a paused schedule. Recalculates next_run_at from now.
retry_dead_letter	Retry a dead-lettered job by creating a new job from its payload.
retry_dead_letters	Retry multiple dead letters for a queue in a single transaction.
set_actor	Set actor context for audit logging. Only updates fields that are passed.
tick_schedules	Process due schedules and create jobs.
tick_timeouts	Reclaim running jobs whose visibility timeout has expired.

SQL Functions

Function	Description
queue.ack	Acknowledge successful job completion.
queue.ack_batch	Acknowledge multiple jobs as completed.
queue.cancel	Cancel a pending job by deleting it.
queue.fail	Move job to dead letter queue (permanent failure).
queue.nack	Return job to queue for retry (temporary failure).
queue.purge_queue	Delete all pending jobs from a queue.
queue.release_jobs	Release all jobs held by a worker, returning them to pending.
queue.clear_actor	Clear actor context. Call before returning connections to pool.
queue.clear_tenant	Clear the tenant context. Call before returning connections to pool.
queue.set_actor	Set actor context for audit trail.
queue.set_tenant	Set the tenant context for RLS policies.
queue.purge_dead_letters	Delete old un-retried dead letters.
queue.retry_dead_letter	Retry a dead-lettered job by creating a new job from its payload.
queue.retry_dead_letters	Retry multiple dead letters for a queue in a single transaction.
queue.extend_visibility	Extend the visibility timeout of a running job.
queue.pull	Pull one job from a queue.
queue.pull_any	Pull one job from multiple queues (priority order).
queue.pull_batch	Pull multiple jobs from a queue.
queue.push	Push a job onto a queue.
queue.push_batch	Push multiple jobs onto a queue efficiently.
queue.create_schedule	Create a recurring schedule that produces jobs automatically.
queue.delete_schedule	Delete a schedule by name.
queue.get_schedule	Get a schedule by name.
queue.list_schedules	List schedules with optional filters and cursor pagination.
queue.pause_schedule	Pause an active schedule.
queue.resume_schedule	Resume a paused schedule. Recalculates next_run_at from now.
queue.tick_schedules	Process due schedules and create jobs.
queue.tick_timeouts	Reclaim running jobs whose visibility timeout has expired.
queue.get_queue_stats	Get per-queue statistics with operational metrics.
queue.get_stats	Get namespace-wide queue statistics.