restore_file

Plugin command to move a backup file from the remote storage system.

Synopsis

<plugin_executable> restore_file <plugin_config_file> <file_to_restore>

Description

gprestore invokes the restore_file plugin command on the coordinator and each segment host for the file that gprestore will read from a backup directory on local disk.

The restore_file command should process and move the file from the remote storage system to file_to_restore on the local host.

Arguments

plugin_config_file

The absolute path to the plugin configuration YAML file.

file_to_restore

The absolute path to which to move a backup file from the remote storage system.

Exit Code

The restore_file 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.