setup_plugin_for_restore

setup_plugin_for_restore

插件命令用于初始化还原操作的存储插件。

概要

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

描述

gprestoregprestore初始化阶段调用setup_plugin_for_restore插件命令。 scope参数指定执行范围。 gprestore将使用每个scope值调用该命令。

setup_plugin_for_restore命令应在还原操作开始之前执行初始化远程存储系统所需的活动。 设置活动可能包括创建远程目录,验证与远程存储系统的连接等。

参数

plugin_config_file
插件配置YAML文件的绝对路径。
local_backup_dir
Greenplum数据库主机(master和segment)上的本地目录,gprestore从该目录读取备份文件。 gprestore创建此本地目录。
  • scopemaster时,local_backup_dir是Greenplum数据库master的备份目录。
  • scopesegment时,local_backup_dir是segment实例的备份目录。 contentID标识segment实例。
  • scopesegment_host时,local_backup_dir是主机上的任意备份目录。
scope
执行范围值表示主机和插件命令的执行次数。 scope可以是以下值之一:
  • master - 在master主机上执行一次插件命令。
  • segment_host - 在每个segment主机上执行一次plugin命令。
  • segment - 对运行segment实例的主机上的每个活动segment实例执行一次plugin命令。 contentID标识segment实例。
在首次启动备份时,Greenplum数据库master和segment实例基于Greenplum数据库配置。
contentID
与scope对应的Greenplum数据库master或segment实例的contentID。 仅当scopemastersegment时才传递contentID
  • scope值为mastercontentID值为-1
  • scope值为segmentcontentID值为活动segment实例的内容标识符。

返回值

setup_plugin_for_restore命令必须在成功时以值0退出,如果发生错误则不为零。 在非零退出代码的情况下,gprestore向用户显示stderr的内容。