pgmq-sqlalchemy

PGMQ Postgres extension Python client supporting SQLAlchemy ORM .

Features

• Supports async and sync engines, sessionmakers, or directly constructed from dsn.

• Supports all Postgres DBAPIs supported by SQLAlchemy.

  • Examples: psycopg, psycopg2, asyncpg

  • See SQLAlchemy Postgresql Dialects

• Transaction-friendly operations via the op module for combining PGMQ with your business logic in the same transaction.

• Fully tested across all supported DBAPIs in both async and sync modes.

• Battle-tested with real-world FastAPI Pub/Sub examples and corresponding tests.

Table of Contents

• pgmq-sqlalchemy
• Installation
• Getting Started
  • Postgres Setup
  • pgmq-sqlalchemy Setup
  • Using Transaction-Friendly Operations
  • FastAPI Pub/Sub Example
• FastAPI Pub/Sub Example with PGMQ
  • Scenario
  • Architecture
  • Prerequisites
  • Running the Example with Pytest
  • Configuration
  • How It Works
  • Testing
• API Reference
  • PGMQueue
  • PGMQOperation (op)
  • Schema Classes
• Development
  • How to Contribute
  • Development Setup
  • Testing
  • Documentation
• Release Notes