EDB Postgres Distributed Command Line Interface (PGD CLI)

The EDB Postgres Distributed Command Line Interface (PGD CLI) is a tool for managing your EDB Postgres Distributed cluster. It’s the key tool for inspecting and managing cluster resources.

It allows you to run commands against EDB Postgres Distributed clusters to:

• Determine the health of the cluster, inspect the cluster’s configuration, and manage the cluster’s resources.

• Inspect and manage the cluster’s nodes and groups.

• Perform a write-leader change operation on the group.

You can also install it manually on Linux and macOS systems that can connect to a PGD cluster, including:

• HCP advanced and distributed high-availability clusters.

• PGD clusters deployed using the CloudNative Postgres Global Clusters operator.

• Manually deployed PGD clusters.

PGD Essential constraints

PGD Essential clusters have constraints that apply to certain CLI commands:

• Cluster architecture: A PGD Essential cluster must have at most three data nodes and must have routing enabled for the global group only. Use pgd cluster verify --arch to check compliance.

• Compatibility assessment: The pgd assess command skips checks for tables with multiple unique indexes, row level lock usage, lock table usage, and listen/notify usage.

• Commit scope commands: pgd commit-scope create , pgd commit-scope update , and pgd commit-scope drop are not supported.

• Group options: pgd group set-option cannot update enable_raft , enable_routing , enable_wal_decoder , or streaming_mode .

• Node setup: pgd node setup enables routing for the global group and disables it for subgroups.

• Installing PGD CLI
  • Installing PGD CLI on Linux
    • Obtain your EDB subscription token
    • Set the EDB_SUBSCRIPTION_TOKEN environment variable
  • Installing PGD CLI on macOS
• Using PGD CLI
  • What is the PGD CLI?
  • Passing a database connection string
  • Specifying a configuration file
  • Specifying the output format
  • Accessing the command line help
• Configuring PGD CLI
  • PGD CLI and database connection strings
  • Configuring the database to connect to
    • Using database connection strings in the command line
    • Using database connection strings in an environment variable
    • Using a configuration file
• Discovering connection strings
  • PGD CLI and database connection strings
  • Getting your database connection string
    • For a cluster deployed with EDB CloudNative Postgres Global Cluster
• Command reference
  • Synopsis
  • Commands
  • Global Options
  • Additional Options
  • Output formats
    • pgd assess
    • pgd cluster
    • pgd commit-scope
    • pgd completion
    • pgd events
    • pgd group
    • pgd groups
    • pgd node
    • pgd nodes
    • pgd raft
    • pgd replication