setup_plugin_for_restore

Plugin command to initialize a storage plugin for the restore operation.

Synopsis

<plugin_executable> setup_plugin_for_restore <plugin_config_file> <local_backup_dir> <scope>

<plugin_executable> setup_plugin_for_restore <plugin_config_file> <local_backup_dir> <scope> <contentID>

Description

gprestore invokes the setup_plugin_for_restore plugin command during gprestore initialization phase. The scope argument specifies the execution scope. gprestore will invoke the command with each of the scope values.

The setup_plugin_for_restore command should perform the activities necessary to initialize the remote storage system before a restore operation begins. Set up activities may include creating remote directories, validating connectivity to the remote storage system, etc.

Arguments

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

local_backup_dir : The local directory on the SynxDB host (master and segments) from which gprestore reads backup files. gprestore creates this local directory.

-   When scope is `master`, the local\_backup\_dir is the backup directory of the SynxDB 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 run. scope can be one of these values:

-   `master` - Run the plugin command once on the master host.
-   `segment_host` - Run the plugin command once on each of the segment hosts.
-   `segment` - Run the plugin command once for each active segment instance on the host running the segment instance. The contentID identifies the segment instance.

: The SynxDB hosts and segment instances are based on the SynxDB configuration when the back up was first initiated.

contentID : The contentID of the SynxDB 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 setup_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.