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#
EDB Postgres Distributed cluster failure or seeding a new cluster from a backup : Cluster-level commands for managing the cluster.
Show the nodes in the cluster : Show cluster-level information.
Verify that the target node isn't the write leader : Verify cluster-level information.
Creating and joining PGD groups : Group-level commands for managing groups.
Show the nodes in the cluster : 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).
Creating and joining PGD groups : Group related commands for listing groups. - Listing PGD groups : List groups.
Monitoring node join and removal : Node-level commands for managing nodes.
Show the nodes in the cluster : Show node-level information.
pgd group set-option : Set node-level options.
pgd group get-option : Get node-level options.
Application schema upgrades : Perform a major version upgrade of a PGD Postgres node.
Creating PGD nodes : Node related commands for listing nodes. - Listing PGD groups : List nodes.
pgd events : Event log commands for viewing events. - Show the nodes in the cluster : Show events.
Cleanup of replication origins : Replication related-commands for managing replication. - Show the nodes in the cluster : Show replication information.
Monitoring Raft consensus : Raft related commands for managing Raft consensus. - Show the nodes in the cluster : Show information about Raft state.
pgd commit-scope create : Commit scope related commands for managing PGD commit scopes.
Show the nodes in the cluster : Show information about a commit-scope.
Replication slots created by PGD : Create a commit-scope.
Update the Postgres service configuration : Update a commit-scope.
Creating and dropping proxy configurations : Drop a commit-scope.
pgd assess : Assesses a Postgres server’s PGD compatibility.
bdr.wait_for_join_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.<br/>This is ignored if --dsn flag is present<br/>Default "/etc/edb/pgd-cli/pgd-cli-config.yml" |
--dsn |
Database connection string<br/>For example "host=bdr-a1 port=5432 dbname=bdrdb user=postgres" |
|
-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 |