参数说明
通用参数
-u, --user TEXT
指定用户名称。缺省值为gbase。
-p, --port INTEGER
指定连接端口号。
-c, --cluster TEXT
指定集群名称。缺省值为gbase。
-l, --dcs_url TEXT
必选项。指定DCS 节点连接地址。格式为http://host:ip。
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
50
--help
显示命令帮助信息。
以下显示各命令特定参数的描述。
add 命令参数
指定添加节点的类型,可选值为coordinator、datanode、dcs、gtm、server。
coordinator
-r, --role TEXT
协调器角色可以设置为master 或slave,如果设置为slave,则协调器将只读sql 语句路
由到复制的数据节点。
-s, --sync_mode TEXT
仅当协调器角色设置为从属时有效。如果设置为synccoordinator,则将只读sql 语句路
由到synchronousreplicated 数据节点,否则协调器可以将只读语句路由到异步replacated 数
据节点。
--agent_host TEXT
datanode
--agent_host TEXT
设置gha 代理地址。
gtm
--agent_host TEXT
设置gha 代理地址。
server
backup 和restore 命令参数
指定备份/恢复范围类型,可选值为all、dcs、topo。
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
51
all
-p, --config TEXT
必选项。指定配置文件所在的路径。
create 命令参数
-P, --path TEXT
必选项。指定包文件路径。
-v, --version TEXT
必选项。指定包文件的版本号。
expand 和shrink 命令参数
datanode
指定扩容或缩容数据节点。
-u, --uuid TEXT
必选项。指定uuid。
-j, --parallel_jobs INTEGER
指定可并行进行任务的数量。
当用户指定的并行度数值大于0 时,gs_redis 工具并行度参数使用用户指定的数值;但
当用户不指定-j 参数或并行度小于1 时,gs_redis 的并行度参数使用默认规则数值。
get 命令参数
constant
获取集群的常量信息。
expand
获取集群的扩容信息。
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
52
service
获取DCS 管理的集群名称。
sync-priority
获取集群的同步备节点信息。
sync-strict
获取集群的强同步信息。
install 命令参数
-p, --config TEXT
必选项。指定yml 配置文件的路径。
-f, --force_install / -F, --no-force_install
指定此项,表示不检查旧集群是否存在,而强制安装集群。
install-dcs 命令参数
-e, --exist / -E, --no-exist
指定此项,表示不检查DCS 集群是否存在,执行安装。
monitor 命令参数
-H, --humanreadable / -h, --no-humanreadable
若指定该项,则以表格形式显示信息。
-I, --internaloption / -i, --not-internaloption
显示不同状态的内部专用选项。
prepare 命令参数
-t, --cluster_type TEXT
指定集群类型。可选值:multiple-nodes、single-inst。默认为multiple-nodes。
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
53
rollback 和upgrade 命令参数
-t, --type TEXT
指定回退或升级的类型,可选all、ha、app。
set 命令参数
constant
设置集群常量参数。
coordinator
设置集群CN 节点参数。
datanode
设置集群DN 节点参数。
gtm
设置集群GTM 节点参数。
start 和stop 命令参数
all
启动/停止集群所有节点,包括GTM、CN、DN 节点。
coordinator
启动/停止CN 节点。
datanode
启动/停止DN 节点。
gtm
启动/停止GTM 节点。
server
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
54
启动/停止Server 节点。
uninstall 命令参数
-f, --force / -F, --no-force
若指定此项,则当没有gha server 节点时强制卸载集群。无论集群处于running 还是
stopped 状态都能够进行卸载操作。