MainSourcesPg

PostgreSQL Setup

Prerequisites

Before you begin, ensure you have:

  • Supported PostgreSQL Version: PostgreSQL version 9.4 or higher.
  • Database Admin Access: Sufficient privileges to create users, grant permissions, and modify database configuration parameters. This might require superuser privileges or specific cloud provider roles (e.g., rds_superuser on AWS RDS, azure_pg_admin on Azure).
  • Network Connectivity: Ensure that Supermetal's services can reach your PostgreSQL database. You may need to configure firewall rules, security groups, or VPC peering.

Setup

Supermetal supports two replication types for PostgreSQL sources:

  • Snapshot: One-time or periodic full table snapshots.
  • Logical Replication: Real-time change data capture (CDC) with initial snapshot.

High Availability

Supermetal supports fast failover for clustered PostgreSQL databases (e.g., AWS Aurora, RDS Multi-AZ).

  • Use Cluster Endpoints: Use the Cluster Writer Endpoint (e.g., my-cluster.cluster-xyz.us-east-1.rds.amazonaws.com) rather than instance addresses.
  • Automatic Recovery: During logical replication, Supermetal detects failovers and resumes streaming from the new primary (typically < 10 seconds).

Transient connection errors (network timeouts, server restarts, failovers) are retried with backoff for up to 5 minutes (configurable via retry_window_seconds).

Last updated on

On this page