Utility Reference

A newer version of this documentation is available. Use the version menu above to view the most up-to-date release of the Greenplum 6.x documentation.

Utility Reference

The command-line 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.

Several utilities are installed when you install the Greenplum Database server. These utilities reside in $GPHOME/bin. Other utilities must be downloaded from Pivotal Network and installed separately. These include:

Additionally, the Pivotal Greenplum Client and Loader Tools is a separate download from Pivotal Network that includes selected utilities from the Greenplum Database server installation that you can install on a client system.

Greenplum Database provides the following utility programs. Superscripts identify those utilities that require separate downloads, as well as those utilities that are also installed with the Client and Loader Tools Packages. (See the Note following the table.) All utilities are installed when you install the Greenplum Database server, unless specifically identified by a superscript.

analyzedb

clusterdb

createdb3

createlang3

createuser3

dropdb3

droplang3

dropuser3

gpactivatestandby

gpaddmirrors

gpbackup_manager1

gpbackup1

gpcheckcat

gpcheckperf

gpconfig

gpcopy2

gpdeletesystem

gpexpand

gpfdist3

gpinitstandby

gpinitsystem

gpkafka4

gpload3

gplogfilter

gpmapreduce

gpmapreduce.yaml

gpmovemirrors

gppkg

gprecoverseg

gpreload

gprestore1

gpscp

gpss4

gpssh

gpssh-exkeys

gpstart

gpstate

gpstop

pg_config

pg_dump3

pg_dumpall3

pg_restore

pgbouncer

pgbouncer.ini

plcontainer

plcontainer Configuration File

psql3

pxf

pxf cluster

reindexdb

vacuumdb

Note:

1 The utility program can be obtained from the Greenplum Backup and Restore tile on Pivotal Network.

2 The utility program can be obtained from the Greenplum Data Copy Utility tile on Pivotal Network.

3 The utility program is also installed with the Greenplum Client and Loader Tools Packages for Linux and Windows. You can obtain these packages from the Greenplum Database Greenplum Clients filegroup on Pivotal Network.

4The utility program is also installed with the Greenplum Client and Loader Tools Package for Linux. You can obtain the most up-to-date version of the Greenplum Streaming Server and Greenplum-Kafka Integration from Pivotal Network.