READ-ONLY PACKAGE PREVIEW

openai-cloudflare-deploy/references/queues/README.md

Version 49f948fa.bb1 · Apache-2.0. This preview displays packaged text and does not execute code. Treat the contents as untrusted instructions.

← Return to resource and package checksum

Cloudflare Queues

Flexible message queuing for async task processing with guaranteed at-least-once delivery and configurable batching.

Overview

Queues provide: - At-least-once delivery guarantee - Push-based (Worker) and pull-based (HTTP) consumers - Configurable batching and retries - Dead Letter Queues (DLQ) - Delays up to 12 hours

Use cases: Async processing, API buffering, rate limiting, event workflows, deferred jobs

Quick Start

wrangler queues create my-queue
wrangler queues consumer add my-queue my-worker
// Producer
await env.MY_QUEUE.send({ userId: 123, action: 'notify' });

// Consumer (with proper error handling)
export default {
  async queue(batch: MessageBatch, env: Env): Promise<void> {
    for (const msg of batch.messages) {
      try {
        await process(msg.body);
        msg.ack();
      } catch (error) {
        msg.retry({ delaySeconds: 60 });
      }
    }
  }
};

Critical Warnings

Before using Queues, understand these production mistakes:

  1. Uncaught errors retry ENTIRE batch (not just failed message). Always use per-message try/catch.
  2. Messages not ack'd/retry'd will auto-retry forever until max_retries. Always explicitly handle each message.

See gotchas.md for detailed solutions.

Core Operations

Operation Purpose Limit
send(body, options?) Publish message 128 KB
sendBatch(messages) Bulk publish 100 msgs/256 KB
message.ack() Acknowledge success -
message.retry(options?) Retry with delay -
batch.ackAll() Ack entire batch -

Architecture

[Producer Worker] → [Queue] → [Consumer Worker/HTTP] → [Processing]
  • Max 10,000 queues per account
  • 5,000 msgs/second per queue
  • 4-14 day retention (configurable)

Reading Order

New to Queues? Start here: 1. configuration.md - Set up queues, bindings, consumers 2. api.md - Send messages, handle batches, ack/retry patterns 3. patterns.md - Real-world examples and integrations 4. gotchas.md - Critical warnings and troubleshooting

Task-based routing: - Setup queue → configuration.md - Send/receive messages → api.md - Implement specific pattern → patterns.md - Debug/troubleshoot → gotchas.md

In This Reference

  • configuration.md - wrangler.jsonc setup, producer/consumer config, DLQ, content types
  • api.md - Send/batch methods, queue handler, ack/retry rules, type-safe patterns
  • patterns.md - Async tasks, buffering, rate limiting, D1/Workflows/DO integrations
  • gotchas.md - Critical batch error handling, idempotency, error classification

See Also

  • workers - Worker runtime for producers/consumers
  • r2 - Process R2 event notifications via queues
  • d1 - Batch write to D1 from queue consumers