Command

ECOX is a high-availability cluster management tool for PostgreSQL. It provides a command-line interface to manage the full lifecycle of the cluster, supporting commands like start, stop, and show.

Synopsis

ecox start   [-c CONFIG] [-l LICENSE]
ecox stop    [-c CONFIG] [-C] [-W] [-t SECS]
ecox show    [-c CONFIG]
ecox reload  [-c CONFIG]
ecox remove  [-c CONFIG] [-C] [-N NODES]
ecox license [-l LICENSE]

Sub-command	Description
start	Start the current node
stop	Stop the current node or the entire cluster
show	Display the current cluster status
reload	Reload the configuration file
remove	Remove the specific nodes or the entire cluster
license	Display license information

Options

Common Options

• -c, --config=CONFIG

  Specify the location of the configuration file.

• -v, --version

  Display version information and exit.

• -?, --help

  Display usage information and exit.

Options for stop

• -C, --cluster

  Stop the entire cluster instead of just the current node.

• -t, --timeout=SECS

  Specify the timeout in seconds to wait for the operation to complete.

• -w, --wait

  Wait until the operation completes (default behavior).

• -W, --no-wait

  Do not wait for the operation to complete; return immediately.

Options for remove

• -C, --cluster

  Remove the entire cluster.

• -N, --node=NODES

  Specify a comma-separated list of node names to remove.

Options for start and license

• -l, --license=LICENSE

  Specify the location of the license file.

Environment Variables

• ECOX_CONFIG

  If the -c or --config option is omitted, the environment variable ECOX_CONFIG is used to locate the configuration file.

• ECOX_LICENSE

  If the -l or --license option is omitted, the environment variable ECOX_LICENSE is used to locate the license file.