Skip to content

Soniq reference: API, CLI and storage format

This section lists the Soniq API, CLI, dead-letter queue and PostgreSQL storage format. Use it to look things up, not to read from start to end. If you are learning Soniq for the first time, the tutorial is a better starting point.

Python API

  • Soniq - the application object
  • Jobs - the @soniq.job() decorator and enqueue surface
  • Worker - run_worker and worker configuration
  • Hooks - before_job, after_job, on_error

CLI

  • Commands - setup, worker, scheduler, dead-letter, status, inspect, dashboard, migrate-status, migrations export, tasks-check

Operational reference

  • Dead-letter queue - how the DLQ works and how to inspect it
  • Storage format - the PostgreSQL tables and SQL functions, for readers and writers in any language
  • Glossary - one-paragraph definitions for the words the docs use

Migration

  • Migrating to Soniq - tradeoffs and shared facts
  • From Celery - concept map, retry/result/Beat equivalents, module-at-a-time sequence
  • From RQ - concept map, four-state lifecycle vs registries, mechanical rewrite

Dashboard

  • Overview - the bundled web UI for inspecting queues