Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Version Compatibility

This page documents compatibility between pg_tide versions, PostgreSQL versions, and the relay binary.

PostgreSQL Compatibility

pg_tide ExtensionPostgreSQL VersionsNotes
0.11.014, 15, 16, 17, 18Current release
0.10.014, 15, 16, 17, 18
0.9.014, 15, 16, 17
0.1.0–0.8.014, 15, 16Initial releases

Extension / Relay Compatibility

The pg_tide extension and relay binary are versioned together. Use matching major.minor versions:

ExtensionRelay BinaryCompatible?
0.11.x0.11.x
0.11.x0.10.x✓ (backward compatible)
0.10.x0.11.x⚠️ May work, not tested
0.10.x0.10.x

Rule of thumb: The relay binary should be ≥ the extension version. Newer relays are backward compatible with older extensions (they ignore unknown catalog features). Older relays may not understand newer catalog schema additions.

Upgrade Path

pg_tide supports sequential upgrades. Each version provides a migration script:

-- Upgrade from 0.10.0 to 0.11.0
ALTER EXTENSION pg_tide UPDATE TO '0.11.0';

Available upgrade scripts:

  • pg_tide--0.1.0--0.2.0.sql
  • pg_tide--0.2.0--0.3.0.sql
  • pg_tide--0.3.0--0.4.0.sql
  • pg_tide--0.4.0--0.5.0.sql
  • pg_tide--0.5.0--0.6.0.sql
  • pg_tide--0.6.0--0.7.0.sql
  • pg_tide--0.7.0--0.8.0.sql
  • pg_tide--0.8.0--0.9.0.sql
  • pg_tide--0.9.0--0.10.0.sql
  • pg_tide--0.10.0--0.11.0.sql

Important: Upgrades must be sequential. You cannot skip versions (e.g., jump from 0.8.0 to 0.11.0 directly). Apply each migration in order.

Feature Availability by Version

FeatureSince Version
Outbox/Inbox core0.1.0
Relay catalog0.1.0
Consumer groups0.3.0
Dead letter queue0.5.0
Circuit breaker0.5.0
Rate limiting0.6.0
JMESPath transforms0.7.0
Content-based routing0.7.0
Wire formats (Debezium, Maxwell, Canal)0.8.0
Schema Registry0.8.0
OpenTelemetry0.9.0
CDC JSON wire format0.10.0
Webhook signatures0.10.0
DuckLake sink0.11.0
Arrow Flight sink0.11.0

Sink/Source Availability

All sinks and sources listed in the documentation are available in the current release (0.11.0). Some are feature-gated at compile time:

Feature GateIncludes
Default (no flag)Kafka, NATS, HTTP, stdout, PostgreSQL sinks/sources
cloudS3, GCS, Azure Blob, BigQuery, Pub/Sub, SQS, Kinesis, Event Hubs, Service Bus
analyticsClickHouse, Snowflake, Iceberg, Delta, DuckLake, Arrow Flight
schema-registryConfluent Schema Registry + Avro
otelOpenTelemetry tracing
singerSinger/Meltano tap and target support
airbyteAirbyte connector support

Pre-built release binaries include all feature gates enabled.

Breaking Changes

VersionBreaking Change
0.8.0Wire format config moved from top-level to wire_config sub-object
0.5.0DLQ table schema changed (added error_kind column)
0.3.0Consumer group API changed (renamed functions)

Further Reading