The pgEDGE Command Line Interface
pgedge
is the pgEdge Command Line Interface (CLI) for managing components. You can use pgEdge Platform commands to stand up and manage a self-managed multi-master active-active PostgreSQL database. The individual modules are:
Module | Description |
---|---|
ace | Use ACE to compare the data on different nodes to confirm data consistency. |
cluster | Calls to the cluster module install and configure your replication scenario. |
db | Use calls to the db module to configure and control your PostgreSQL databases. |
localhost | Use commands in the localhost module to manage clusters on your local host. |
service | Calls to the service module control the state of services. |
setup | Setup a pgEdge node with configuration for user, database, port, version, spock, snowflake. |
spock | Use calls to spock to manage your replication cluster. |
um | Use calls to update manager to list and update the installed components. |
CLI Command Synopsis
./pgedge <module_name> <command> [parameters] [options]
When calling a pgedge
command, specify the name of the module, followed by the command name and any
command options.
To review available help, use the command:
./pgedge --help
To review help for a specific module, use the command:
./pgedge <module_name> --help
For information about the installed version of the pgEdge CLI and other system details, use the command:
./pgedge info