A database-backed worker backend for Django's Tasks framework (django.tasks), on Django 5.2 LTS and later.
Documentation: https://oxpull.com/django-ox/
Django ships the Tasks API but no production backend: the built-in
ImmediateBackend and DummyBackend are for development and testing only.
django-ox stores background tasks in the database you already run and executes
them with a worker process. There is no broker to provision, secure, upgrade or
back up, and because enqueue() is an INSERT on your default connection, a
task enqueued inside transaction.atomic() commits or rolls back with your
data. No transaction.on_commit() needed.
Comparing backends? See Choosing a task backend.
Requires Python 3.12+ and Django 5.2+. Django 6.0 and later ship the Tasks
framework in core. On Django 5.2 LTS it comes from the django-tasks
backport, so install the backport extra there. Your import path depends on the Django version: on Django 6.0+ you write from django.tasks import task, and on
Django 5.2 you write from django_tasks import task. django-ox itself
handles both.
pip install django-ox
# on Django 5.2 LTS
pip install "django-ox[backport]"
INSTALLED_APPS = [
# ...
"django_ox",
]
TASKS = {
"default": {
"BACKEND": "django_ox.backend.OxBackend",
}
}python manage.py migrate django_ox
python manage.py ox_worker
Tasks are plain django.tasks tasks; django-ox adds nothing to learn on the
producer side. The worker is a separate process, and tasks run only while one
is running. Every option and flag is on the
Configuration page.
A broker-based task queue adds a second datastore to your deployment. Redis or RabbitMQ has to be provisioned, monitored, secured and upgraded, and it has to be running before a single task executes. For an application that already depends on a database, that is a full operational surface added for one feature.
django-ox uses the database you already run. A deployment is your application, a worker process, and one migration. Backups already cover the queue, because the queue is a table.
enqueue() is a single INSERT on the connection the task table uses, so it
participates in the caller's open transaction. A task enqueued inside
transaction.atomic() becomes visible to workers only when the transaction
commits, and disappears on rollback. There is no window where business data
exists without its task, or a task without its data, and no
transaction.on_commit() boilerplate. Execution is at-least-once: workers
claim tasks with SELECT ... FOR UPDATE SKIP LOCKED on databases that support
it (PostgreSQL, MySQL 8+) and an atomic compare-and-set UPDATE elsewhere
(including SQLite), and a reaper returns tasks whose worker died to the queue.
Failed tasks retry with exponential backoff up to a configurable attempt
limit, keeping the full traceback of every attempt.
A soak and chaos harness ran django-ox 1.1.0 for 21.5 minutes of sustained mixed load on PostgreSQL 16, 37,804 tasks in all. For nine of those minutes a random worker was SIGKILLed every 20 to 45 seconds; over the whole run, 18 kills and 27 interrupted executions. Every task reached a terminal state, every interrupted execution was re-executed inside the reclaim bound, no task executed twice in this run, and the median latency under kills stayed within two milliseconds of the undisturbed baseline.
Execution is at-least-once, so a worker killed between finishing a task and recording the outcome leaves that task to run again. The harness asserts that a second execution is only ever attributable to a kill, and it held.
Forty assertions ran and all forty passed. The harness design, every assertion and the caveats are in SOAK-2026-09-11.md, written from the raw data. The soak and the comparison below both ran on 1.1.0 on 2026-09-11.
Against django-tasks-db on PostgreSQL 16, 2,000 no-op tasks, one worker,
five runs per arm on one machine: django-ox 1.1.0 completed the batch at about 125 tasks per second against
108. Every one of the five django-ox runs beat every one of
the five control runs; the slowest django-ox run was 121.3 and the fastest
control run was 110.1. In-transaction enqueue latency was a tie, about six
tenths of a millisecond at p50 and the same story at p95.
The benchmarks page has the full matrix and the raw data behind every figure.
The four backends a Django team is most likely to shortlist. Every cell about another project comes from that project's own documentation or issue tracker, each carrying a link and the date it was read on the Choosing a task backend page.
| django-ox | django-tasks-db | Celery | huey | |
|---|---|---|---|---|
django.tasks backend |
Yes, native | Yes, native | No | No |
| Broker to run | None. The queue is a table in the database you already run | None. Django ORM | RabbitMQ, Redis or SQS | Redis, SQLite, PostgreSQL, file or memory |
| Transactional enqueue | Yes. A task enqueued in atomic() commits or rolls back with your data |
Not claimed | No. Django's own docs name this as the case for on_commit() |
Not claimed |
| Worker killed mid-task | Retried. The lease expires and the task goes back on the queue | Stuck. The task stays PROCESSING, never retried and never failed. Open since 2024-06-11 |
Lost when the child process is killed, even with acks_late |
Lost. "will not be retried automatically" |
| Retries and backoff | Exponential, keeping every attempt's traceback | None | Yes | Yes |
| Recurring schedules | Cron or a fixed interval, and no scheduler process. Editable in the Django admin, limited to the tasks your code exposes | None | celery beat, a separate process you must run exactly one of |
Yes |
The full version has three more backends, a footnote and a date on every cell, and a section on when django-ox is the wrong choice.
Every option has a default; add one when you have a reason to.
TASKS = {
"default": {
"BACKEND": "django_ox.backend.OxBackend",
"QUEUES": ["default", "emails"], # [] allows any queue name
"OPTIONS": {
"MAX_ATTEMPTS": 3, # claims per task before FAILED
"LOCK_TIMEOUT": 300, # seconds before a dead worker's task is reclaimed
"BACKOFF_INITIAL": 5, # first retry delay, seconds; doubles per attempt
"BACKOFF_MAX": 600, # retry delay ceiling, seconds
},
}
}from django.tasks import task # Django 6.0+
# On Django 5.2 the Tasks framework comes from the backport:
# from django_tasks import task
@task
def send_welcome_email(user_id): ...
result = send_welcome_email.enqueue(user_id=42)
result.refresh() # later: status, return_value, errorsRun a worker:
python manage.py ox_worker
| Flag | Default | Meaning |
|---|---|---|
--backend |
default |
Backend alias from the TASKS setting. |
--queues |
all configured queues | Comma-separated queue names to process. |
--concurrency |
1 |
Tasks executed concurrently (thread pool). |
--processes |
1 |
Worker processes under one supervisor. Each is a full worker with its own connections, reaper and --concurrency thread pool; a process that dies is restarted. POSIX only. |
--interval |
1.0 |
Polling interval in seconds when idle. |
--lock-timeout |
backend LOCK_TIMEOUT |
Seconds a RUNNING task's lock may go unrefreshed before the task is reclaimed. |
On SIGTERM or SIGINT the worker stops claiming, finishes in-flight tasks, then
exits. A second signal forces an immediate exit. With --processes above 1,
send the signal to the supervisor; it forwards once and restarts a worker that
dies.
Finished task rows stay in the table until pruned. Run ox_prune on your
own schedule (cron, systemd timer):
python manage.py ox_prune --older-than 7d
| Flag | Default | Meaning |
|---|---|---|
--older-than |
7d |
Minimum time since the task finished. Accepts 7d, 24h, 90m, 45s, or a plain number of seconds. |
--include-failed |
off | Also delete FAILED and LOST rows. By default they are kept: they hold the per-attempt tracebacks and can be retried. |
--batch-size |
1000 |
Rows per DELETE statement, so pruning a large table never takes a long lock or builds a giant IN clause. |
--dry-run |
off | Report how many rows would be deleted without deleting any. |
Only SUCCESSFUL and DISCARDED rows (and, with --include-failed, FAILED and
LOST rows) past the cutoff are deleted. READY and RUNNING rows are never touched, whatever their
age. Old rows from the recurring-schedule tick log are cleared with the same
cutoff, always keeping each schedule's most recent tick.
django_ox.stats exposes queue metrics as plain functions, each a single
ORM query: per-queue status counts, backlog depth and age, throughput,
and failure rate. The ox_health command turns thresholds on those
numbers into an exit code for cron alerting and container probes:
python manage.py ox_health --max-backlog 1000 --max-age 600
| Flag | Default | Meaning |
|---|---|---|
--queue |
all queues | Restrict the checks to one queue. |
--max-backlog |
off | Fail when more than this many READY tasks are eligible to run. |
--max-age |
off | Fail when the oldest waiting task has waited longer than this. Accepts 7d, 24h, 90m, 45s, or a plain number of seconds. |
--worker-timeout |
off | Fail when no worker has claimed a task within this long. Accepts 7d, 24h, 90m, 45s, or a plain number of seconds. |
Mounting path("ox/", include("django_ox.urls")) exposes GET /ox/metrics,
the same numbers as Prometheus gauges; the view has no authentication of its
own.
When django.contrib.admin is installed, the task table is registered with
it: a filterable list, a read-only detail page with every attempt's
traceback, and Retry selected tasks and Discard selected tasks
actions. The same two operations are django_ox.actions.retry(result_id)
and django_ox.actions.discard(result_id). A retry is one more attempt on
a FAILED or LOST task; a discard closes a READY, FAILED or LOST task without
running it. Neither touches a running task.
Worker lifecycle events (claim, start, success, retry, failure, reclaim,
shutdown) log to the django_ox logger with stable extra keys (task id,
queue, attempt, duration), ready for JSON log handlers.
Schedules are declared in settings, next to the backend they enqueue through, so they deploy with your code. There is no separate scheduler process to keep alive:
TASKS = {
"default": {
"BACKEND": "django_ox.backend.OxBackend",
"QUEUES": ["default", "emails"],
"OPTIONS": {
"SCHEDULES": {
"nightly-report": {
"task": "reports.tasks.build_report",
"cron": "0 3 * * *",
"kwargs": {"full": True},
},
"warm-cache": {
"task": "core.tasks.warm_cache",
"cron": "*/15 * * * *",
},
},
},
}
}Each tick enqueues a normal task instance, which workers claim and execute through the ordinary queue: retries, backoff, priorities and the result store all apply unchanged. Every running worker doubles as the scheduler, and a unique constraint on (schedule name, tick time) enqueues each due tick once however many workers are polling. Execution stays at-least-once.
| Key | Required | Meaning |
|---|---|---|
task |
yes | Dotted path to a @task callable, e.g. "reports.tasks.build_report". |
cron |
one of | Five-field cron expression. |
every |
one of | A fixed interval, as a timedelta or seconds, counted from a fixed instant rather than from the last run. |
phase |
no | Shifts an every sequence. |
args, kwargs |
no | JSON-serializable arguments passed to each enqueue. |
queue_name |
no | Queue override; defaults to the task's own queue. |
priority |
no | Priority override (-100 to 100). |
Cron expressions use the classic five-field syntax: *, lists (1,15),
ranges (mon-fri), steps (*/15), month and weekday names, 0 or 7 for
Sunday, and the @hourly, @daily, @weekly, @monthly and @yearly
shortcuts. When both day-of-month and day-of-week are restricted, a day
matches if either field does, as in vixie cron. Times are wall-clock in
your TIME_ZONE.
Misconfigured schedules (a task path that does not import, an expression
that can never fire) fail at worker startup and in manage.py check, not
silently at dispatch time.
Missed ticks: if every worker was down when a tick passed, the latest missed tick fires once on recovery and older ones are skipped, so a nightly job still runs after an unlucky deploy window but a backlog never stampedes. A newly deployed schedule waits for its next tick rather than firing for a time before it existed.
Schedules can also live in the database and be edited in the Django admin without a deploy, for the cases where whoever needs to pause a job cannot ship one. A row names a task the code has exposed rather than an import path, so admin access does not become permission to run anything. See Schedules in the database.
run_after(deferred tasks),priority(-100 to 100, higher runs first),get_result()and the async variants are all supported; the backend declaressupports_defer,supports_priority,supports_get_resultandsupports_async_taskaccordingly.- Retry state is visible in the database: attempts, per-attempt tracebacks,
and the next scheduled run (
run_after). - Because execution is at-least-once, tasks should be idempotent. A task is retried both when it raises and when its worker dies mid-run. The lease number stops two workers writing the same row; it does not stop two threads running the same task body, which is a property of every at-least-once queue. What the lease guarantees, precisely.
- Concurrency uses a thread pool. That fits I/O-bound tasks (email, HTTP,
ORM); for CPU-bound work, run
--processes N --concurrency 1, which is N worker processes under one supervisor.
The core is finite on purpose: a durable queue, a worker, recurring
schedules, monitoring, and nothing else to operate. Outside the current
scope: interrupting one chosen running task on demand (every attempt can be
bounded with TASK_TIMEOUT), and multi-database routing (every django-ox
table lives on the one database your router sends OxTask to).
Batches, unique tasks and rate limiting are in
Oxpull Pro, a paid add-on; https://oxpull.com/ has the details. Metrics stay in this
package: django_ox.stats and ox_health are free and stay free.
What counts as public API, the versioning and deprecation policy, and the supported Python and Django versions are documented in the stability policy.
BSD 3-Clause.
