EDB Postgres Distributed (PGD)

Welcome to the PGD {{version.full}} documentation. PGD {{version.full}} is available in two editions: Essential and Expanded.

• Introduction
  • Why PGD?
  • What does PGD enable?
  • What are the differences between PGD Essential and PGD Expanded?
• Getting started
  • Get started with PGD
    • What is EDB Postgres Distributed?
    • What is EDB Postgres Distributed Essential?
    • What is the PGD Essential Standard architecture
    • Create your first PGD Essential cluster with Docker Compose
      • An introduction to PGD Essential
        • Standard/One-location architecture
      • Creating your first cluster (PGD Essential)
        • Prerequisites
        • Install the PGD Docker Quickstart kit
        • Accessing the PGD Cluster
        • Next Steps
      • First steps with your Quickstart PGD Cluster
        • Working with SQL and the PGD Cluster
        • Loading Data into your PGD Cluster
        • Using PGD CLI
      • Expanded Examples and Use Cases
        • Use Cases
• How to
  • Essential How-To
    • Overview
    • Essential features
    • Essential How-To Guides
      • PGD Essential architectures
        • Choosing an architecture
        • Standard architecture - Ideal for a highly available single location
        • Near/far architecture - Ideal for disaster recovery
      • Installing and configuring EDB Postgres Distributed 6
        • 1 - Prerequisites for Essential installation
        • Step 2 - Configure repositories
        • Step 3 - Installing the database and pgd
        • Step 4 - Configuring the cluster
        • Step 5 - Checking the cluster
      • Connections
        • Connecting through the connection manager
        • Connecting directly to a data node
      • Using PGD CLI
        • Using PGD CLI
        • Worked example
        • PGD Essential constraints
      • Durability in PGD Essential
        • Commit Scopes
        • Using Commit Scopes
      • Autopartitioning
        • Autopartitioning and replication
        • Range partitioning
      • Production Best Practices
        • Sizing
        • Time and PGD
        • Security Best Practices
  • Expanded How-to
    • Overview
    • Expanded Features
      • PGD Architectures
        • Always-On Architecture
        • Essential Architectures
        • Multi-Location Architectures
        • Geo-Distributed Architectures
      • Installing and configuring EDB Postgres Distributed 6
        • 1 - Prerequisites for Expanded installation
        • Step 2 - Configure repositories
        • Step 3 - Installing the database and pgd
        • Step 4 - Configuring the cluster
        • Step 5 - Checking the cluster
• In depth
  • PGD concepts explained
    • PGD concepts
    • PGD Expanded concepts
      • Replication
        • How Replication Works
        • Commit scopes and replication
        • What is replicated?
      • PGD Nodes and Groups
        • Data Nodes
        • Groups
        • Witness Nodes
        • Subscriber-only Nodes
        • Logical Standby Nodes
      • Connection Management
      • Locking
        • Kinds of Locks
      • Durability
      • Commit Scopes
      • Lag Control
        • Lag Control in PGD
      • Expanded Commit Scopes
      • Geo-Distributed Clusters
      • Advanced Durability
      • Conflict Management
• Reference
  • PGD Reference
    • Functions and Commands
    • Configuration and Management
    • Advanced Functionality
      • PGD overview
        • Architecture overview
        • PGD overview - architecture and performance
        • PGD compared
      • Advanced functionality
        • DDL replication
        • Decoding worker
        • CDC Failover support
        • Parallel Apply
        • Replication sets
        • Security and roles
        • Sequences
        • Stream triggers
        • Transaction streaming
        • Explicit two-phase commit (2PC)
      • Config and management
        • Node types and capabilities
        • Node management
        • Connection Manager
        • Postgres configuration
        • Backup and recovery
        • Monitoring
        • AutoPartition in PGD
        • Commit Scopes
        • Conflict Management
        • Testing and tuning PGD clusters
      • Functions and command
        • Tables, views and functions reference
        • EDB Postgres Distributed Command Line Interface (PGD CLI)
      • Guidance for dev
        • Application use
  • Terminology
    • Asynchronous replication
    • Commit scopes
    • CAMO or commit-at-most-once
    • Conflicts
    • Consensus
    • Cluster
    • DDL (data definition language)
    • DML (data manipulation language)
    • Eager
    • Eventual consistency
    • Failover
    • Group commit
    • Immediate consistency
    • Logical replication
    • Node
    • Node groups
    • PGD cluster
    • PGD node
    • Physical replication
    • Postgres cluster
    • Quorum
    • Replicated available fault tolerance (Raft)
    • Read scalability
    • Subscription
    • Switchover
    • Synchronous replication
    • Subscriber-only nodes
    • Two-phase commit (2PC)
    • Vertical scaling or scale up
    • Witness nodes
    • Write leader
    • Writer
• Appendix
  • PGD compatibility
    • PGD compatibility with PostgreSQL versions
    • PGD compatibility with operating systems and architectures
      • Linux
  • EDB Postgres Distributed 6 release notes
    • EDB Postgres Distributed 6.2.0 release notes
      • Highlights
      • Features
      • Enhancements
      • Bug Fixes
    • EDB Postgres Distributed 6.1.0 release notes
      • Highlights
      • Features
      • Enhancements
      • Changes
      • Bug Fixes
    • EDB Postgres Distributed 6.1.1 release notes
      • Bug Fixes
    • EDB Postgres Distributed 6.1.2 release notes
      • Bug Fixes
    • EDB Postgres Distributed 6.0.1 release notes
      • Highlights
      • Features
      • Enhancements
      • Changes
      • Bug Fixes
    • EDB Postgres Distributed 6.0.2 release notes
      • Bug Fixes
  • Known issues and limitations
    • Known issues
    • Limitations
      • Nodes
      • Multiple databases on single instances
      • Durability options (Group Commit/CAMO)
      • General durability limitations
      • Group Commit
      • Eager
    • CAMO
      • Mixed PGD versions
      • Other limitations
• Upgrading
  • Upgrading PGD
  • Upgrading Postgres or Postgres and PGD major versions
  • Other upgrades
    • Upgrading PGD clusters manually
      • Upgrade planning
        • Rolling upgrade considerations
        • Rolling server software upgrades
        • Rolling upgrade using node join
        • Upgrading a CAMO-enabled cluster
      • Upgrade preparation
      • Server software upgrade
        • BDR extension upgrade
        • Fence the node
        • Stop Postgres
        • Upgrade packages
        • Start Postgres
        • Unfence the node
        • Postgres upgrade
        • Minor version Postgres upgrade
        • Major version Postgres upgrade
      • Upgrade check and validation
      • PGD 5 - Moving from PGD Proxy to Connection Manager
    • Supported PGD upgrade paths
      • Upgrading to version {{version.full}}
    • Compatibility changes
      • Summary
      • Connection Manager
      • DDL Locking changes
      • Join/part behavior
        • Function and node state changes
        • Sequences conversion
        • Parting a node drops it
      • Administration function changes
      • Other
        • Replica identity
        • Run on (all) writes
        • General UI improvements
      • Changes to defaults
        • Global lock timeout
        • Auto sync
    • Application schema upgrades
      • Rolling application schema upgrades
    • In-place Postgres or Postgres and PGD major version upgrades
      • Terminology
      • Precautions
      • Usage
        • pgd node upgrade command-line
        • Synopsis
        • Options
        • Environment variables
        • Example
        • Steps performed
        • PGD Postgres checks
        • pg_upgrade steps
        • PGD post-upgrade steps
    • Performing a Postgres major version rolling upgrade on a PGD cluster
      • Upgrading Postgres major versions
        • Prepare the upgrade
        • Perform the upgrade on each node
      • Worked example: Upgrade PGD 4 to PGD 6
        • Overview
        • Confirm the harp-proxy leader
        • Fence the node
        • Stop the Postgres service
        • Stop HARP manager
        • Remove and install packages
        • Start the Postgres service
        • Start HARP manager
        • Unfence the node
        • Repeat steps for all nodes
        • Confirm cluster version
        • Confirm SCRAM hashes
        • Enable routing
        • Switch to Connection Manager
        • Stop harp manager and proxy services.
      • Worked example: Upgrade PGD 5 to PGD 6
      • Prerequisites
        • Install packages for the new server and PGD
      • Pre-upgrade steps
        • Version Check
        • Move to Connection Manager
        • Write leader node verification
        • Fence the node
        • Initialize the new Postgres instance
        • Migrate configuration to the new Postgres version
        • Execute the upgrade.
      • Post-upgrade steps
        • Update the Postgres service file
        • Start the postgres service
        • Verify the upgraded cluster versions
        • Unfence the node
        • Verify the Connection Manager is working
        • Clean up and vacuum analyze
        • Upgrade the remaining nodes
        • Verify the final state of the cluster
        • Verify the Connection Manager