setup_plugin_for_restore

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.

plugin_config_file

local_backup_dir

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

• 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.

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 or segment.

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