setup_plugin_for_backup

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

setup_plugin_for_backup

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

Synopsis

plugin_executable setup_plugin_for_backup plugin_config_file local_backup_dir

Description

gpbackup invokes the setup_plugin_for_backup plugin command on the master and all segment hosts during gpbackup initialization phase.

The setup_plugin_for_backup command should perform the activities necessary to initialize the remote storage system before backup begins. Set up activities may include creating remote directories, validating connectivity to the remote storage system, checking disks, and so forth.

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) to which gpbackup will write backup files. gpbackup creates this local directory.

Exit Code

The setup_plugin_for_backup 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, gpbackup displays the contents of stderr to the user.