User Guide

Welcome to the pgqrs User Guide. This guide covers everything you need to know to effectively use pgqrs in your applications.

Overview

pgqrs is a library-only durable execution engine with multiple storage backends. PostgreSQL remains the primary production backend, while SQLite, Turso, and S3-backed queues cover embedded, portable, and object-storage-backed deployments.

Guide Structure

• Getting Started

  ---

  Install pgqrs and create your first queue in minutes.

  • Installation
  • Quickstart

• Concepts

  ---

  Understand the core architecture and design principles.

  • Architecture
  • Backend Selection
  • Producer & Consumer
  • Workers
  • Message Lifecycle
  • Durable Workflows

• Rust API

  ---

  Complete reference for the Rust library.

  • Overview
  • Producer
  • Consumer
  • Admin

• Python API

  ---

  Complete reference for Python bindings.

  • Overview
  • Producer
  • Consumer
  • Admin

• Guides

  ---

  Step-by-step tutorials for common use cases.

  • Basic Workflow
  • S3 Queue Guide
  • Durable Workflows
  • Batch Processing
  • Delayed Messages
  • Worker Management

Prerequisites

Before using pgqrs, ensure you have:

• One supported backend: PostgreSQL 12+, SQLite, Turso, or an S3 bucket plus AWS-compatible credentials
• Rust 1.70+ (for Rust applications) or Python 3.11+ (for Python applications)

Quick Links

Topic	Description
Installation	How to install pgqrs for Rust or Python
Backend Selection	Choose between PostgreSQL, SQLite, Turso, and S3
Architecture	System design and components
Producer	Creating and sending messages
Consumer	Processing messages
S3 Queue Guide	Bootstrapping and syncing an S3-backed queue
Durable Workflows	Multi-step, crash-resistant workflows