Skip to content

API & CLI Reference

Curated API reference, CLI subcommand documentation, OpenTelemetry and Prometheus metric catalog, and contributor verification guides for litestar-queues.

  • Plugin, Config & Service

    QueuePlugin, QueueConfig, WorkerConfig, QueueMaintenanceConfig, QueueService, QueueNamespace, and QueuedBackgroundTask.

  • Tasks, Models & Exceptions

    @task, Task, ScheduleConfig, RetryBackoff, QueuedTaskRecord, TaskRequest, TaskReservation, TaskResult, TaskStatus, dependency hooks, and exception hierarchy.

  • Storage Backends

    BaseQueueBackend, SQLSpecBackendConfig, SQLSpecQueueBackend, SQLAlchemyBackendConfig, SQLAlchemyBackend, ORM model mixins, RedisBackendConfig, ValkeyBackendConfig, EphemeralQueueBackend, and InMemoryQueueBackend.

  • Execution, Workers & Maintenance

    BaseExecutionBackend, Cloud Tasks, Cloud Run Jobs, Pub/Sub, SQS, RabbitMQ, and Kafka execution configs and backends, Worker, QueueMaintenanceService, and consume_one / run_task.

  • Events, Streams & History

    QueueEventsConfig, EventDeliveryConfig, EventBufferConfig, EventStreamConfig, EventHistoryConfig, EventHistoryExtraColumn, TaskExecutionContext, QueueEvent, QueueEventLog, QueueEventQuery, and sinks.

  • Observability & Metric Catalog

    ObservabilityConfig and the complete OpenTelemetry and Prometheus metric, histogram, gauge, and bounded attribute catalog.

  • CLI Reference

    Generated reference for litestar queues commands (run, run-consumer, run-task, run-maintenance, status, scheduler-health) and programmatic litestar_queues.cli integration.

  • Contributing & Testing

    Unit, integration, and browser E2E testing tiers, backend registry design, and the documentation verification workflow.