Durable change feeds for PostgreSQL, powered by logical replication.
1.6K
English | Deutsch
Durable change feeds for PostgreSQL, powered by logical replication.
Source & issues: github.com/pt9912/pg-change-feed
PG Change Feed provides persistent change feeds for existing PostgreSQL tables. It targets applications and integrations that need to consume changes reliably and independently, without having to process PostgreSQL WAL or the logical replication protocol themselves.
Everything below is available end-to-end, real-world tested — via
environment variables, docker compose/make and SQL, with no
graphical interface.
| Area | What it does |
|---|---|
| Capture | Attach a PostgreSQL source via logical replication; (de)activate tables via SQL administration (cdc.enable_table/disable_table) or CDC_TABLES live; exclude individual columns from capture; store changes (INSERT/UPDATE/DELETE) transactionally and durably; detect schema changes on captured tables. |
| Reading | Read captured changes via SQL (cdc.changes) — or through one of four delivery paths: HTTP/JSON API, gRPC stream, Server-Sent Events or NATS (wake-up signal or full change content, table-granular). |
| Consumers | Register multiple independent consumers, acknowledge and resume their position — duplicates are preferred over silent gaps. |
| Retention | Run time- and consumer-based retention, surface blocking consumers before they prevent deletion. |
| Operations | Query operational status, CLI diagnostics, metrics and WAL lag; push metrics to an OpenTelemetry collector via OTLP/HTTP. |
| Security | Enforce role-specific access rights (cdc_capture/cdc_admin/cdc_reader, least privilege, no user accounts of its own); protect the HTTP and gRPC APIs with API tokens per class (several valid tokens at once, so tokens can be rotated without downtime) and serve them over TLS. |
| Distribution | Available as an OCI image for linux/amd64 and linux/arm64 (GHCR and Docker Hub, identical digest); the HTTP API, gRPC stream, SSE stream, and NATS full-content stream are also available as an official C# client library (PgChangeFeed.Client on NuGet.org), the same four delivery paths as an official Python client library (pgchangefeed on PyPI), and as an official Kotlin client library (pgchangefeed-kotlin on Cloudsmith and GitHub Packages). |
Details and examples for each access path (Go, C#, Kotlin) are in the
user manual; the full scope of
requirements and acceptance criteria is in spec/lastenheft.md.
See:
docs/user/benutzerhandbuch.md for usage (German).sdks/csharp/ for the official C# client library (PgChangeFeed.Client on NuGet.org).sdks/python/ for the official Python client library (pgchangefeed on PyPI).sdks/kotlin/pgchangefeed-kotlin/ for the official Kotlin client library (pgchangefeed-kotlin on Cloudsmith and GitHub Packages).docs/maintainer/releasing.md for the release process.spec/lastenheft.md for requirements and acceptance criteria.spec/pflichtenheft.md for the technical specification.docs/plan/adr/ for architecture decisions.PostgreSQL provides powerful CDC foundations with WAL, logical decoding and logical replication, but no general-purpose, persistent CDC abstraction with change history, stable positions, independent consumers and retention. PG Change Feed closes that gap without requiring a new database, a message broker, or changes to the source application.
PostgreSQL WAL → durable change feed → independent consumers.
A source position is only acknowledged after its associated changes have been stored durably. In failure scenarios, possible duplicates are preferred over silent gaps.
AGENTS.md for binding development rules and harness/README.md for source precedence and existing gates.spec/lastenheft.md with traceable LH-* requirements and acceptance criteria.spec/pflichtenheft.md.docs/plan/adr/, planning in docs/plan/planning/.MIT — see LICENSE.
Content type
Image
Digest
sha256:97c68c406…
Size
7.9 MB
Last updated
7 days ago
docker pull pt9912/pg-change-feed