Utility Overview

The command-line utilities provided with Apache Cloudberry.

Apache Cloudberry uses the standard PostgreSQL client and server programs and provides additional management utilities for administering a distributed Apache Cloudberry DBMS.

Several utilities are installed when you install the Apache Cloudberry server. These utilities reside in $GPHOME/bin.

Superscripts identify those utilities that require separate downloads, as well as those utilities that are also installed with the Client and Loader Tools Packages. All utilities are installed when you install the Apache Cloudberry server, unless specifically identified by a superscript.

For more information about a utility, see the corresponding topic listed in the System Utilities section.

Reference for Client Applications

• clusterdb — cluster a database
• createdb — create a new database
• createuser — define a new user account
• dropdb — remove a database
• dropuser — remove a user account
• pg_config — retrieve information about the installed version of PostgreSQL
• pg_dump — extract a database into a script file or other archive file
• pg_dumpall — extract a database cluster into a script file
• pg_restore — restore a database from an archive file created by pg_dump
• psql — interactive terminal
• reindexdb — reindex a database
• vacuumdb — garbage-collect and analyze a database

Reference for Server Applications

• pg_checksums — enable, disable or check data checksums in a database cluster

Reference for Administrator

• analyzedb - performs ANALYZE operations on tables incrementally and concurrently
• gpaddmirrors - add mirror segments to a Apache Cloudberry system that was initially configured without mirroring
• gpbackup - create a Apache Cloudberry backup for use with the gprestore utility
• gpcheckcat - test Apache Cloudberry catalog tables for inconsistencies
• gpcheckperf - verifiy the baseline hardware performance of the specified hosts
• gpconfig - set server configuration parameters on all segments within a Apache Cloudberry system
• gpdeletesystem - delete a Apache Cloudberry system that was initialized using gpinitsystem
• gpdemo - deploy a small Apache Cloudberry cluster with segments on a single node to make a demo
• gpexpand - expand an existing Apache Cloudberry across new hosts in the system
• gpfdist - serve data files to or writes data files out from Apache Cloudberry segments
• gpinitstandby - add and/or initialize a standby coordinator host for a Apache Cloudberry system
• gpinitsystem - initialize a Apache Cloudberry system using configuration parameters specified in the gpinitsystem_config file
• gpload - run a load job as defined in a YAML formatted control file
• gplogfilter - search through Apache Cloudberry log files for specified entries
• gpmemreport - interpret the output created by the gpmemwatcher utility and generates output files in a readable format
• gpmemwatcher - track the memory usage of each process in a database cluster.
• gpmovemirrors - move mirror segment instances to new locations
• gppkg - package manager to install, upgrade, migrate, and remove extensions in .gppkg format
• gprestore - restore a database backup that was created using the gpbackup utility
• gpreload - reload table data sorting the data based on specified columns
• gprecoverseg - recover a primary or mirror segment instance that has been marked as down (if mirroring is enabled)
• gpshrink - use gpshrink to reduce the size of the cluster, saving server resources
• gpssh-exkeys - exchange SSH public keys between hosts
• gpssh - provide SSH access to multiple hosts at once
• gpstart - start a Apache Cloudberry system
• gpstate - show the status of a running Apache Cloudberry system
• gpstop - stop or restart a Apache Cloudberry system
• gpsync - copy files between multiple hosts at once
• gpactivatestandby - activate a standby coordinator host and makes it the active coordinator