cleanup_plugin_for_backup
gpbackup
invokes the cleanup_plugin_for_backup
plugin command when a gpbackup
operation completes, both in success and failure cases. The scope argument specifies the execution scope. gpbackup
will invoke the command with each of the scope values.
The cleanup_plugin_for_backup
command should perform the actions necessary to clean up the remote storage system after a backup. Clean up activities may include removing remote directories or temporary files created during the backup, disconnecting from the backup service, etc.
plugin_config_file
local_backup_dir
The local directory on the Greenplum Database host (master and segments) to which gpbackup
wrote backup files.
- When scope is , the local_backup_dir is the backup directory of the Greenplum Database master.
- When scope is
segment
, the local_backup_dir is the backup directory of a segment instance. The contentID identifies the segment instance.
scope
master
- Execute the plugin command once on the master host.segment_host
- Execute the plugin command once on each of the segment hosts.segment
- Execute the plugin command once for each active segment instance on the host running the segment instance. The contentID identifies the segment instance.
The Greenplum Database hosts and segment instances are based on the Greenplum Database configuration when the back up was first initiated.
contentID
The contentID of the Greenplum Database master or segment instance corresponding to the scope. contentID is passed only when the scope is master
or .
- When scope is
segment
, the contentID is the content identifier of an active segment instance.