setup_plugin_for_restore

A newer version of this documentation is available. Click here to view the most up-to-date release of the Greenplum 4.x documentation.

setup_plugin_for_restore

Plugin command to initialize a storage plugin for the restore operation.

Synopsis

plugin_executable setup_plugin_for_restore plugin_config_file local_backup_dir

Description

gprestore invokes the setup_plugin_for_restore plugin command on the master and all segment hosts during gprestore initialization phase.

The setup_plugin_for_restore command should perform the activities necessary to initialize the remote storage system before a restore operation begins. Set up activities may include creating remote directories, validating connectivity to the remote storage system, etc.

Arguments

plugin_config_file
The absolute path to the plugin configuration YAML file.
local_backup_dir
The local directory on the Greenplum Database host (master and segments) from which gprestore reads backup files. setup_plugin_for_restore must create this directory if it does not already exist.

Exit Code

The setup_plugin_for_restore command must exit with a value of 0 on success, non-zero if an error occurs. In the case of a non-zero exit code, gprestore displays the contents of stderr to the user.