PgQue docs

Short docs for users, plus a contributor primer.

Get started

• Tutorial — a hands-on walkthrough. Send, tick, receive, retry, DLQ, observability. Start here if you are new.

Guides

• Installation and operations — install, ticking, role grants, uninstall, and troubleshooting.
• Examples — short patterns: fan-out, exactly-once, batch send, recurring jobs, DLQ inspection, and cooperative consumers / subconsumers (experimental).
• Monitoring and health — queue, consumer, and batch introspection; lag and pending-event signals; what to alert on.

Reference

• Function reference — every function, return type, and role grant in the default install.

Explanation

• Latency and tick tuning — how ticks shape end-to-end delivery latency, choosing tick_period_ms, and idle backoff.
• Concepts and heritage — the core vocabulary (event, batch, tick, rotation, ticker rule) and where PgQue comes from.

For the full specification and implementation plan, see blueprints/SPECx.md. For what ships in the default install vs experimental, see blueprints/PHASES.md.