Command reference

The command name for the PGD command line interface is pgd .

Synopsis

The EDB Postgres Distributed Command Line Interface (PGD CLI) is a tool to manage your EDB Postgres Distributed cluster. It allows you to run commands against EDB Postgres Distributed clusters. You can use it to inspect and manage cluster resources.

Commands

• Cluster configuration : Cluster-level commands for managing the cluster.

• pgd cluster show : Show cluster-level information.

• pgd cluster verify : Verify cluster-level information.

• Viewing groups and replication sets : Group-level commands for managing groups.

• pgd cluster show : Show group-level information.

• pgd group set-option : Set group-level options.

• pgd group get-option : Get group-level options.

• pgd group set-leader : Set the write leader of a group (perform a switchover).

• Viewing groups and replication sets : Group related commands for listing groups. - pgd commit-scopes list : List groups.

• Failing Over to Newly Joined Nodes : Node-level commands for managing nodes.

• Running pgd node setup : Setup a node in the cluster.

• pgd cluster show : Show node-level information.

• pgd node part : Part a PGD node from an active cluster.

• pgd group set-option : Set node-level options.

• pgd group get-option : Get node-level options.

• pgd node set-config : Set node-level configuration.

• pgd node get-config : Get node-level configuration.

• pgd node upgrade : Perform a major version upgrade of a PGD Postgres node.

• Node management : Node related commands for listing nodes. - pgd commit-scopes list : List nodes.

• Monitoring degrade events : Event log commands for viewing events. - pgd cluster show : Show events.

• EXPLAIN ANALYZE Replication : Replication related-commands for managing replication. - pgd cluster show : Show replication information.

• Using Raft for the commit decision : Raft related commands for managing Raft consensus.

• pgd cluster show : Show information about Raft state.

• pgd raft enable : Enable the Raft consensus worker on one or more nodes.

• pgd raft disable : Disable the Raft consensus worker on one or more nodes.

• pgd group set-leader : Transfer Raft leadership to a specified node.

• pgd raft sync-snapshot : Synchronize Raft state across all nodes.

• pgd commit-scope create : Commit scope related commands for managing PGD commit scopes.

• pgd cluster show : Show information about a commit-scope.

• pgd commit-scope create : Create a commit-scope.

• pgd commit-scope update : Update a commit-scope.

• pgd commit-scope drop : Drop a commit-scope.

• pgd commit-scopes list : List commit scopes.

• Assessing the cluster state : Assesses a Postgres server’s PGD compatibility.

• pgd completion : Generate shell completion scripts.

Global Options

All commands accept the following global options:

Short	Long	Description
-f	--config-file	Name/Path to config file. This is ignored if --dsn flag is present Default "/etc/edb/pgd-cli/pgd-cli-config.yml"
	--dsn	Database connection string For example "host=bdr-a1 port=5432 dbname=pgddb user=postgres" Also set by PGD_CLI_DSN environment variable.
-h	--help	Help for pgd - will show specific help for any command used
-o	--output	Output format: json, psql, modern, markdown, simple (see Output formats )

Additional Options

Run pgd -V to see the version information for the pgd CLI.

Output formats

Used with the -o /--output option:

Format	Description
simple	Simple format - Output as a simple ASCII table (Default).
json	JSON format - Output as a JSON document, non-tabular
psql	PSQL format - Output as an ASCII table in the style of PSQL
modern	Modern format - Output as a table using box characters
markdown	Markdown table format - Output as a markdown compatible ASCII table

• pgd assess
  • Synopsis
  • Syntax
  • Options
  • Example
• pgd cluster
  • Subcommands
    • pgd cluster show
    • pgd cluster verify
• pgd commit-scope
  • Subcommands
    • pgd commit-scope create
    • pgd commit-scope drop
    • pgd commit-scopes list
    • pgd commit-scope show
    • pgd commit-scope update
• pgd completion
  • Synopsis
  • Syntax
  • Options
  • Example
• pgd events
  • Subcommands
    • pgd events show
• pgd group
  • Subcommands
    • pgd group show
    • pgd group set-option
    • pgd group get-option
    • pgd group set-leader
• pgd groups
  • Subcommands
    • pgd groups list
• pgd node
  • Subcommands
    • pgd node get-config
    • pgd node get-option
    • pgd node part
    • pgd node set-config
    • pgd node set-option
    • pgd node setup
    • pgd node show
    • pgd node upgrade
• pgd nodes
  • Subcommands
    • pgd nodes list
• pgd raft
  • Subcommands
    • pgd raft disable
    • pgd raft enable
    • pgd raft set-leader
    • pgd raft show
    • pgd raft sync-snapshot
• pgd replication
  • Subcommands
    • pgd replication show