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 PostgreSQL-backed job queue designed for simplicity and reliability. Unlike traditional message queues that require separate infrastructure, pgqrs leverages your existing PostgreSQL database.

Guide Structure

• Getting Started

  ---

  Install pgqrs and create your first queue in minutes.

  • Installation
  • Quickstart

• Concepts

  ---

  Understand the core architecture and design principles.

  • Architecture
  • Producer & Consumer
  • Workers
  • Message Lifecycle

• 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
  • Batch Processing
  • Delayed Messages
  • Worker Management

• CLI Reference

  ---

  Command-line tool documentation.

  • CLI Reference

Prerequisites

Before using pgqrs, ensure you have:

• PostgreSQL 12+ - pgqrs uses features like SKIP LOCKED available in PostgreSQL 12 and later
• Rust 1.70+ (for Rust applications) or Python 3.8+ (for Python applications)

Quick Links

Topic	Description
Installation	How to install pgqrs for Rust or Python
Architecture	System design and components
Rust Producer	Creating and sending messages in Rust
Python Consumer	Processing messages in Python
CLI Reference	Command-line operations