Command reference v5.7.0

Suggest edits

Warning: You are not reading the most recent version of this documentation.
Documentation improvements are made only to the latest version.
As per semantic versioning, PGD minor releases remain backward compatible and may include important bug fixes and enhancements.
We recommend upgrading the latest minor release as soon as possible.
If you want up-to-date information, read the latest PGD documentation.

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: Cluster-level commands for managing the cluster.
- show: Show cluster-level information.
- verify: Verify cluster-level information.
group: Group-level commands for managing groups.
- show: Show group-level information.
- set-option: Set group-level options.
- get-option: Get group-level options.
- set-leader: Set the write leader of a group (perform a switchover).
groups: Group related commands for listing groups.
- list: List groups.
node: Node-level commands for managing nodes.
- show: Show node-level information.
- set-option: Set node-level options.
- get-option: Get node-level options.
- upgrade: Perform a major version upgrade of a PGD Postgres node.
nodes: Node related commands for listing nodes.
- list: List nodes.
events: Event log commands for viewing events.
- show: Show events.
replication: Replication related-commands for managing replication.
- show: Show replication information.
raft: Raft related commands for managing Raft consensus.
- show: Show information about Raft state.
commit-scope: Commit scope related commands for managing PGD commit scopes.
- show: Show information about a commit-scope.
- create: Create a commit-scope.
- update: Update a commit-scope.
- drop: Drop a commit-scope.
assess: Assesses a Postgres server's PGD compatibility.
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=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

← Prev

Discovering connection strings

↑ Up

EDB Postgres Distributed Command Line Interface (PGD CLI)

pgd assess