gpupgrade

The gpupgrade command performs an in-place upgrade of a Greenplum Database system to a new major version.

Synopsis

gpupgrade [initialize | execute | finalize | revert | config show] [<options>]

Description

The gpupgrade utility upgrades a Greenplum Database cluster to a new Greenplum Database major version, for example from Greenplum Database 5.x to Greenplum Database 6.x. You cannot use gpupgrade to upgrade Greenplum Database versions within the same major version.

The Greeplum Database cluster you are upgrading from is called the source cluster. The new version of Greenplum Database you are upgrading to is called the target cluster.

Subcommands

Initialize

gpupgrade initialize runs pre-upgrade checks, prepares the source cluster for upgrade, and initializes the target cluster.

gpupgrade initialize --file | -f <path_to_gpupgade_config> [--verbose | -v] [--help | -h] [--pg-upgrade-verbose]

Options:

• -v or --verbose outputs more detailed log messages for the initialize subcommand.
• -h or --help displays help output for the initialize subcommand.
• --pg-upgrade-verbose creates additional logging information

gpupgrade initialize logs messages in the $HOME/gpAdminLogs/gpupgrade/initialize_YYYYMMDD.log file.

See the gpupgrade Configuration File reference page for information about the configuration file parameters. See Initialize the Upgrade (gpupgrade initialize) for more information about running gpupgrade initialize.

Execute

After you have successfully run gpupgrade initialize, run gpupgrade execute to upgrade the master instance and primary segments.

gpupgrade execute [--verbose | -v] [--help | -h]

Options:

• -v or --verbose outputs more detailed log messages for the execute subcommand.
• -h or --help displays help output for the execute subcommand.

The gpupgrade execute command writes log messages in the $HOME/gpAdminLogs/gpupgrade/execute_YYYYMMDD.log file.

See Run the Upgrade (gpupgrade execute) for more information about running the gpupgrade execute command.

Finalize

gpupgrade finalize upgrades the Greenplum Database mirror segments and the standby master to the target Greenplum Database version. Once you run gpupgrade finalize you will not be able to revert the upgrade.

gpupgrade finalize [--verbose | -v] [--help | -h]

Options:

• -v or --verbose outputs more detailed log messages for the finalize subcommand.
• -h or --help displays help output for the finalize subcommand.

The gpupgrade finalize command writes log messages in the $HOME/gpAdminLogs/gpupgrade/finalize_YYYYMMDD.log file.

See Finalize the Upgrade (gpupgrade finalize) for more information about running the gpupgrade finalize command.

Revert

gpupgrade revert returns the Greenplum Database cluster to its state before running gpupgrade initialize. You may run it at any time before running gpupgrade finalize.

gpupgrade revert [--verbose | -v] [--help | -h]

Options:

• -v or --verbose outputs more detailed log messages for the revert subcommand.
• -h or --help displays help output for the revert subcommand.

The gpupgrade revert command writes log messages to the $HOME/gpAdminLogs/gpupgrade/revert_YYYYMMDD.log file. The $HOME/gpAdminLogs/gpupgrade directory is archived by appending a timestamp to the directory.

See Reverting the Upgrade (gpupgrade revert) for more information about running the gpupgrade revert command.

Config show

The config show subcommand displays the configuration parameters of the current upgrade process once gpstart initialize has started. It is useful for getting the target cluster data directory and port in order to start or connect to the target cluster.

gpupgrade config show <option>

Options

• --upgrade-id displays the upgrade ID. It identifies the temporary target cluster directories during the upgrade process and also the source cluster data directories when archiving during gpupgrade finalize or gpupgrade revert.
• --source-gphome displays the value of the source cluster $GPHOME.
• --target-gphome displays the value of the target cluster $GPHOME.
• --target-datadir displays the value of the target cluster master data directory $MASTER_DATA_DIRECTORY.
• --target-port displays the value of the target cluster $PGPORT.

See Also

Upgrade Your Cluster