Deployment Patterns¶
PgQueuer requires no message broker, Redis instance, or additional infrastructure, just PostgreSQL. This page covers how to run workers in production.
Single worker process¶
The simplest deployment: one process, one QueueManager.
# myapp.py
from contextlib import asynccontextmanager
import asyncpg
from pgqueuer import PgQueuer
from pgqueuer.db import AsyncpgDriver
from pgqueuer.models import Job
@asynccontextmanager
async def main():
conn = await asyncpg.connect()
driver = AsyncpgDriver(conn)
pgq = PgQueuer(driver)
@pgq.entrypoint("process_order")
async def process_order(job: Job) -> None:
...
yield pgq
This is sufficient for most workloads. A single QueueManager handles multiple entrypoints
concurrently via asyncio.
Horizontal scaling¶
Run multiple worker processes against the same PostgreSQL database. PgQueuer uses
FOR UPDATE SKIP LOCKED in every dequeue query, so workers never claim the same job:
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
│ Worker 1 │ │ Worker 2 │ │ Worker 3 │
│ QueueManager │ │ QueueManager │ │ QueueManager │
└──────┬───────┘ └──────┬───────┘ └──────┬───────┘
│ │ │
└────────────────────┴────────────────────┘
│
┌──────┴──────┐
│ PostgreSQL │
└─────────────┘
Each worker:
- Listens on the same ch_pgqueuer channel independently
- Claims jobs atomically; no coordinator or leader election needed
- Can run on separate VMs, containers, or processes on the same host
Starting multiple workers:
# Fly.io: scale to 3 machines
fly scale count 3
# Docker Compose: scale service
docker compose up --scale worker=3
# Local: multiple terminals or background processes
pgq run myapp:main &
pgq run myapp:main &
pgq run myapp:main
One process per CPU core¶
For CPU-bound workloads, run one worker per core to avoid GIL contention in Python:
For IO-bound workloads (HTTP calls, database queries), a single asyncio process typically saturates a database connection before needing additional processes.
Process supervision¶
Use a supervisor to restart workers on crash.
systemd:
# /etc/systemd/system/pgqueuer-worker.service
[Unit]
Description=PgQueuer Worker
After=network.target postgresql.service
[Service]
User=app
WorkingDirectory=/app
ExecStart=pgq run myapp:main --shutdown-on-listener-failure
Restart=always
RestartSec=5
Environment=PGHOST=localhost
Environment=PGUSER=pgqueuer_app
Environment=PGDATABASE=mydb
[Install]
WantedBy=multi-user.target
Docker / Docker Compose:
services:
worker:
image: myapp:latest
command: pgq run myapp:main --shutdown-on-listener-failure
restart: always
environment:
PGHOST: db
PGUSER: pgqueuer_app
PGDATABASE: mydb
depends_on:
db:
condition: service_healthy
Fly.io:
Fly machines restart automatically on exit. Add --shutdown-on-listener-failure so a broken
LISTEN connection causes a clean restart rather than silent degradation:
Graceful shutdown¶
pgq run handles SIGTERM and SIGINT. On receiving a signal:
- Stop accepting new jobs from the queue.
- Wait for in-flight jobs to finish. PgQueuer has no built-in drain timeout; it awaits running jobs to completion, so bound the wait via your orchestrator (see below).
- Exit cleanly.
Container orchestrators (Kubernetes, Fly.io, ECS) send SIGTERM before SIGKILL, so
in-flight jobs finish provided the terminationGracePeriodSeconds is long enough.
Tip
Set terminationGracePeriodSeconds to at least the 95th-percentile runtime of your
longest job plus a 30-second buffer.
Schema migrations on deploy¶
Run pgq upgrade before deploying new application code. It is safe to run against a live
database and never drops a table or a column:
# Deploy workflow
pgq upgrade --plan # optional: review the delta first
pgq upgrade # apply schema changes
# then roll out new workers
pgq upgrade compares the installed schema against what the release declares and applies
the delta for that database, rather than replaying a migration history. Run again on a
current database, it applies nothing and reports PgQueuer schema is already up to date.
Anything it will not do on its own is printed as a note: line on stderr. A column an
older release left behind is reported, never dropped -- it holds data, and discarding it
is your call. Worth reading the notes on the first upgrade after a long gap.
One class of note is about what the upgrade will do: converting a column type rewrites
the table under ACCESS EXCLUSIVE, blocking the queue for the duration. Only a database
still on int4 ids or the pre-v0.27 statistics enum hits it, and pgq upgrade --plan
says so before you commit to the window.
Concurrent upgrades serialize on an advisory lock. It is session-scoped, so hold schema
changes on a single connection; see pgq upgrade.
Environment configuration¶
The database drivers read standard PostgreSQL environment variables:
| Variable | Purpose |
|---|---|
PGHOST |
Database host |
PGPORT |
Database port (default 5432) |
PGUSER |
Database user |
PGPASSWORD |
Database password |
PGDATABASE |
Database name |
PGQUEUER_PREFIX |
Prefix prepended to table/channel names (default: empty; names default to pgqueuer, ch_pgqueuer, etc.) |
PGQUEUER_SCHEMA |
Postgres schema holding all PgQueuer objects (default: unset; objects are resolved via the connection's search_path) |
PGQUEUER_DURABILITY |
Durability level the schema is declared at: volatile, balanced, or durable (default). pgq upgrade reports a table that differs; pgq durability changes it |
Use PGQUEUER_PREFIX to run multiple isolated PgQueuer instances in the same database:
Use PGQUEUER_SCHEMA to keep PgQueuer objects in a dedicated schema; workers must
run with the same value the objects were installed with:
Deployment checklist¶
- [ ]
pgq installrun once against the target database - [ ]
pgq autovacapplied after installation - [ ] Application role granted minimal runtime privileges
- [ ] Workers started with
--shutdown-on-listener-failure - [ ] Supervisor configured to restart workers on exit
- [ ]
pgq upgradeincluded in the deploy pipeline before rolling out new workers - [ ]
terminationGracePeriodSeconds(or equivalent) set to cover longest expected job runtime