cleanup_plugin_for_backup

Plugin command to clean up a storage plugin after backup.

Synopsis

<plugin_executable> cleanup_plugin_for_backup <plugin_config_file> <local_backup_dir> <scope>

<plugin_executable> cleanup_plugin_for_backup <plugin_config_file> <local_backup_dir> <scope> <contentID>

Description

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.

Arguments

plugin_config_file

The absolute path to the plugin configuration YAML file.

local_backup_dir

The local directory on the Greenplum Database host (coodinator and segments) to which gpbackup wrote backup files.

• When scope is coordinator, the local_backup_dir is the backup directory of the Greenplum Database coordinator.
• When scope is segment, the local_backup_dir is the backup directory of a segment instance. The contentID identifies the segment instance.
• When the scope is segment_host, the local_backup_dir is an arbitrary backup directory on the host.

scope

The execution scope value indicates the host and number of times the plugin command is executed. scope can be one of these values:

• coordinator - Execute the plugin command once on the coordinator 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 coordinator or segment instance corresponding to the scope. contentID is passed only when the scope is coordinator or segment.

• When scope is coordinator, the contentID is -1.
• When scope is segment, the contentID is the content identifier of an active segment instance.

Exit Code

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