EDB Postgres Distributed Command Line Interface

The EDB Postgres Distributed Command Line Interface (PGD CLI) is a tool for managing your EDB Postgres Distributed cluster. It allows you to run commands against EDB Postgres Distributed clusters. It’s installed automatically on systems in a TPA-deployed PGD cluster. Or it can be installed manually on systems that can connect to any PGD cluster, such as EDB BigAnimal distributed high-availability clusters or PGD clusters deployed using the EDB PGD for Kubernetes operator.

• Installing PGD CLI has instructions on manually installing PGD CLI on various systems.

• Using PGD CLI offers an introduction to using the PGD CLI and how to connect to your PGD cluster.

• Configuring PGD CLI has details on creating persistent configurations for quicker connections.

• PGD CLI's Command reference covers all the available commands to inspect, manage, and get information about cluster resources.

• Discovering connection strings shows how to obtain the correct connection strings for your PGD-powered deployment.

• Installing PGD CLI
  • Installing automatically with Trusted Postgres Architect (TPA)
  • Installing manually on Linux
    • Add repository and install PGD CLI on Debian or Ubuntu
    • Add repository and install PGD CLI on RHEL, Rocky, AlmaLinux, or Oracle Linux
• 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 a configuration file
• Discovering connection strings
  • PGD CLI and database connection strings
  • Getting your database connection string
    • For a TPA-deployed PGD cluster
    • For an EDB BigAnimal distributed high-availability cluster
    • For a cluster deployed with EDB PGD for Kubernetes
• Command reference
  • Synopsis
  • Options
  • See also
    • 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