Usage Notes Overview
After installing pdbcli and preparing your config.yaml file, you can run commands from the working directory using the format pdbcli <command>. This document provides a reference for the pdbcli command-line interface (CLI), which is used to manage PolarDB for PostgreSQL (PolarFlex) clusters.
You can run the pdbcli help command to view descriptions of all supported commands.
Command | Description |
Validates the cluster configuration file to ensure that required parameters are correct. | |
Installs the PolarFlex software stack on all target nodes. | |
Creates the target cluster based on the configuration file. | |
Displays the cluster version information. | |
Displays the cluster status. | |
Upgrades the cluster. This includes the high availability (HA) components, database engine, cluster proxy, and other components. | |
Manages the running status of the HA component (Cluster Manager) on target nodes. This includes starting, stopping, restarting, and querying the status of the component. | |
Traces issues, such as collecting all component logs from each node. | |
Dumps logs for all components. | |
Performs a manual cluster failover. | |
Restarts all cluster components. This includes the HA components, database engine, cluster proxy, and other components. | |
Rebuilds the database engine or other components on a specified node. | |
Deletes a cluster or specified components on a node. | |
Uninstalls the PolarFlex software stack from all target nodes. |