cleanup_plugin_for_restore
Plugin command to clean up a storage plugin after restore.
Synopsis
<plugin_executable> cleanup_plugin_for_restore <plugin_config_file> <local_backup_dir> <scope>
<plugin_executable> cleanup_plugin_for_restore <plugin_config_file> <local_backup_dir> <scope> <contentID>
Description
gprestore
invokes the cleanup_plugin_for_restore
plugin command when a gprestore
operation completes, both in success and failure cases. The scope argument specifies the execution scope. gprestore
will invoke the command with each of the scope values.
The cleanup_plugin_for_restore
implementation should perform the actions necessary to clean up the remote storage system after a restore. Clean up activities may include removing remote directories or temporary files created during the restore, 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 (master and segments) from which gprestore
reads backup files.
- When scope is
master
, 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. - 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:
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 segment
.
- When scope is
master
, 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_restore
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.