backup\_file

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

Synopsis

<plugin_executable> backup_file <plugin_config_file> <file_to_backup>

Description

gpbackup invokes the backup_file plugin command on the master and each segment host for the file that gpbackup writes to a backup directory on local disk.

The backup_file implementation should process and copy the file to the remote storage system. Do not remove the local copy of the file that you specify with file_to_backup.

Arguments

plugin_config_file : The absolute path to the plugin configuration YAML file.

file_to_backup : The absolute path to a local backup file generated by gpbackup. Do not remove the local copy of the file that you specify with file_to_backup.

Exit Code

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