Skip to main content
Ctrl+K
EDB Postgres Distributed -PGD 5.5.1 documentation - Home
  • General Information
    • Compatibility)
    • EDB Postgres Distributed release notes
      • EDB Postgres Distributed 5.5.1 release notes
      • EDB Postgres Distributed 5.5.0 release notes
      • EDB Postgres Distributed 5.4.1 release notes
      • EDB Postgres Distributed 5.4.0 release notes
      • EDB Postgres Distributed 5.3.0 release notes
      • EDB Postgres Distributed 5.2.0 release notes
      • EDB Postgres Distributed 5.1.0 release notes
      • EDB Postgres Distributed 5.0.1 release notes
      • EDB Postgres Distributed 5.0.0 release notes
    • Known issues
  • Concepts
    • Terminology
    • PGD overview
  • Get Started
    • Introducing PGD quick starts
      • Deploying an EDB Postgres Distributed example cluster on Docker
      • Deploying an EDB Postgres Distributed example cluster on Linux hosts
      • Deploying an EDB Postgres Distributed example cluster on AWS
      • Deploying an EDB Postgres Distributed example cluster on Azure and Google cloud platforms
      • Connecting to your database
      • Exploring replication with PGD
      • Exploring failover handling with PGD
      • Exploring conflict handling with PGD
      • Next steps with PGD
    • Planning your PGD deployment
      • Choosing your architecture
      • Choosing a Postgres distribution
      • Choosing your deployment method
      • Other considerations
      • Limitations
    • Deploying and configuring EDB Postgres Distributed
      • Manual deployment and configuration of PGD
        • Deploying PGD manually
      • Deployment and management with TPA
        • Deploying PGD using TPA
      • Deploying and configuring PGD on Kubernetes
      • Deploying and configuring PGD on EDB BigAnimal
  • Using
    • Application use
      • Application behavior
      • DML and DDL replication and nonreplication
      • Nodes with differences
      • General rules for applications
      • Timing considerations and synchronous replication
      • Use of table access methods (TAMs) in PGD
      • Feature compatibility
    • DDL replication
      • DDL overview
      • DDL replication options
      • DDL locking details
      • Managing DDL with PGD replication
      • DDL command handling matrix
      • DDL and role manipulation statements
      • Workarounds for DDL restrictions
      • PGD functions that behave like DDL
    • Sequences
  • Administration
    • Node management
      • Node types
      • Groups and subgroups
      • Creating and joining PGD groups
      • Witness nodes
      • Logical standby nodes
      • Subscriber-only nodes and groups
      • Viewing PGD topology
      • Removing nodes and groups
      • Joining a heterogeneous cluster
      • Connection DSNs and SSL (TLS)
      • Decoding worker
      • Replication slots created by PGD
      • Node restart and down node recovery
      • Maintenance commands through proxies
    • Postgres configuration
    • PGD Proxy
      • EDB Postgres Distributed Proxy overview
      • Installing PGD Proxy
      • PGD Proxy configuration
      • Administering PGD Proxy
      • Monitoring PGD Proxy
      • Read-only routing with PGD Proxy
      • Proxies, Raft, and Raft subgroups
        • Creating Raft subgroups using TPA
        • Working with Raft subgroups and PGD CLI
        • Migrating to Raft subgroups
        • Raft elections in depth
    • Backup and recovery
    • Security and roles
      • Roles
      • Role management
      • PGD predefined roles
      • Roles and replication
      • Access control
    • Monitoring
      • OpenTelemetry integration
      • Monitoring through SQL
    • Testing and tuning PGD clusters
    • Upgrading
      • Upgrading PGD clusters with TPA
      • Upgrading PGD clusters manually
      • Supported PGD upgrade paths
      • Compatibility changes
      • In-place Postgres major version upgrades
      • Application schema upgrades
      • Performing a Postgres major version rolling upgrade on a PGD cluster built with TPA
  • Tools
    • EDB Postgres Distributed Command Line Interface (PGD CLI)
      • Installing PGD CLI
        • Installing PGD CLI on Linux
        • Installing PGD CLI on macOS
        • Installing PGD CLI with TPA
      • Using PGD CLI
      • Configuring PGD CLI
      • Discovering connection strings
      • Command reference
        • check-health
        • create-proxy
        • delete-proxy
        • set-group-options
        • set-node-options
        • set-proxy-options
        • show-clockskew
        • show-events
        • show-groups
        • show-nodes
        • show-proxies
        • show-raft
        • show-replslots
        • show-subscriptions
        • show-version
        • switchover
        • verify-cluster
        • verify-settings
  • PGD Features
    • Durability
      • Overview of durability options
      • Durability terminology
      • Commit scopes
      • Commit scope rules
      • Comparing durability options
      • Coomit Scope kinds
        • Group Commit
        • Commit At Most Once
        • Lag Control
        • PGD Synchronous Commit
      • Working with
        • Administering
        • Legacy synchronous replication using PGD
        • Limitations
      • Internal timing of operations
    • Consistency
      • Conflicts
      • Column-level conflict detection
      • Conflict-free replicated data types
      • Eager conflict resolution
    • Parallel Apply
    • Replication sets
    • Stream triggers
    • PGD AutoPartition
    • Explicit two-phase commit (2PC)
    • Transaction streaming
    • Timestamp-based snapshots
  • PGD reference
    • User visible catalogs and views
    • System functions
    • PGD settings
    • Node management
    • Node management interfaces
    • Routing functions
    • Commit scopes
    • Replication set management
    • Replication set membership
    • DDL replication filtering
    • Testing and tuning commands
    • Global sequence management interfaces
    • Autopartition
    • Stream triggers reference
      • Stream triggers manipulation interfaces
      • Stream triggers row functions
      • Stream triggers row variables
    • Internal catalogs and views
    • Internal system functions
  • PGD Compatibility by PostgreSQL Version
  • .rst

Installing PGD CLI

Installing PGD CLI#

You can install PGD CLI on any system that can connect to the PGD cluster. Linux and macOS are currently supported platforms to install PGD CLI on.

  • Installing PGD CLI on Linux
    • Obtain your EDB subscription token
    • Set the EDB_SUBSCRIPTION_TOKEN environment variable
    • Install on Debian or Ubuntu
    • Install on RHEL, Rocky, AlmaLinux, or Oracle Linux
  • Installing PGD CLI on macOS
  • Installing PGD CLI with TPA

previous

EDB Postgres Distributed Command Line Interface (PGD CLI)

next

Installing PGD CLI on Linux

By EnterpriseDB Corporation.

© Copyright EnterpriseDB Corporation..