Management Utility Reference

Describes the command-line management utilities provided with Greenplum Database.

Greenplum Database uses the standard PostgreSQL client and server programs and provides additional management utilities for administering a distributed Greenplum Database DBMS. Greenplum Database management utilities reside in $GPHOME/bin.

Note: When referencing IPv6 addresses in gpfdist URLs or when using numeric IP addresses instead of hostnames in any management utility, always enclose the IP address in brackets. For command prompt use, the best practice is to escape any brackets or put them inside quotation marks. For example, use either:\[2620:0:170:610::11\] or '[2620:0:170:610::11]'.

Greenplum Database provides the following management utility programs:

analyzedb

gpactivatestandby

gpaddmirrors

gpbackup

gpcheck

gpcheckcat

gpcheckperf

gpconfig

gpcopy

gpcrondump

gpdbrestore

gpdeletesystem

gp_dump (deprecated)

gpexpand

gpfdist

gpfilespace

gpinitstandby

gpinitsystem

gpkafka

gpkafka-v2.yaml

gpkafka.yaml

gpload

gplogfilter

|gpmapreduce

gpmfr

gpmovemirrors

gpmt

gpperfmon_install

gppkg

gprecoverseg

gpreload

gprestore

gp_restore (deprecated)

gpscp

gpseginstall

gpssh

gpssh-exkeys

gpstart

gpstate

gpstop

gpsys1

gptransfer (deprecated)

pgbouncer

pgbouncer.ini

pgbouncer-admin

pxf

pxf cluster

Backend Server Programs

The following standard PostgreSQL server management programs are provided with Greenplum Database and reside in $GPHOME/bin. They are modified to handle the parallelism and distribution of a Greenplum Database system. You access these programs only through the Greenplum Database management tools and utilities.

Program Name	Description	Use Instead
initdb	This program is called by gpinitsystem when initializing a Greenplum Database array. It is used internally to create the individual segment instances and the master instance.	gpinitsystem
ipcclean	Not used in Greenplum Database	N/A
pg_basebackup	This program makes a binary copy of a single database instance. Greenplum Database uses it for tasks such as creating a standby master instance, or recovering a mirror segment when a full copy is needed. Do not use this utility to back up Greenplum Database segment instances because it does not produce MPP-consistent backups.	gpinitstandby, gprecoverseg
pg_controldata	Not used in Greenplum Database	gpstate
pg_ctl	This program is called by gpstart and gpstop when starting or stopping a Greenplum Database array. It is used internally to stop and start the individual segment instances and the master instance in parallel and with the correct options.	gpstart, gpstop
pg_resetxlog	DO NOT USE Warning: This program might cause data loss or cause data to become unavailable. If this program is used, the Tanzu Greenplum cluster is not supported. The cluster must be reinitialized and restored by the customer.	N/A
postgres	The postgres executable is the actual PostgreSQL server process that processes queries.	The main postgres process (postmaster) creates other postgres subprocesses and postgres session as needed to handle client connections.
postmaster	postmaster starts the postgres database server listener process that accepts client connections. In Greenplum Database, a postgres database listener process runs on the Greenplum master Instance and on each Segment Instance.	In Greenplum Database, you use gpstart and gpstop to start all postmasters (postgres processes) in the system at once in the correct order and with the correct options.