-h, --help
含义：显示工具帮助信息；
参数类型：可选参数；
取值范围：无；
注意事项和使用限制：指定该参数直接显示帮助信息后工具退出运行。
-v, --version
含义：显示工具版本信息；
参数类型：可选参数；
取值范围：无；
注意事项和使用限制：指定该参数直接显示帮助信息后工具退出运行。
--master_mpp_ip=MASTER_MPP_IP
含义：用于指定主集群的coordinator 任一节点IP 地址；
参数类型：必选参数；
注意事项和使用限制：只支持IPV4 格式的IP 地址。
--master_mpp_gc_port=MASTER_MPP_GC_PORT
含义：用于指定主集群的coordinator 端口信息；
参数类型：可选参数；
取值范围：【default:5258，min:1，max:65536】；
GBase 8a MPP Cluster 产品手册
4 管理员指南
文档版本953（2022-04-10）
南大通用数据技术股份有限公司
586
注意事项和使用限制：如端口信息不是默认值，请指定该参数。
--master_mpp_gn_port=MASTER_MPP_GN_PORT
含义：用于指定主集群的gnode 端口信息；
参数类型：可选参数；
取值范围：【default: 5050，min:1，max:65536】；
注意事项和使用限制：如端口信息不是默认值，请指定该参数。
--slave_mpp_ip=SLAVE_MPP_IP
含义：用于指定备集群的coordinator 任一节点IP 地址；
参数类型：必选参数；
注意事项和使用限制：只支持IPV4 格式的IP 地址。
--slave_mpp_gc_port=SLAVE_MPP_GC_PORT
含义：用于指定备集群的coordinator 端口信息；
参数类型：可选参数；
取值范围：【default:5258，min:1，max:65536】；
注意事项和使用限制：如端口信息不是默认值，请指定该参数。
--slave_mpp_gn_port=SLAVE_MPP_GN_PORT
含义：用于指定备集群的gnode 端口信息；
参数类型：可选参数；
取值范围：【default: 5050，min:1，max:65536】；
注意事项和使用限制：如端口信息不是默认值，请指定该参数。
--database_user=DATABASE_USER
含义：用于指定连接主、备集群的数据库用户；
参数类型：可选参数；
注意事项和使用限制：需要具有访问‘table_list_file’中定义的表的权限，该
用户需要同时存在于主备集群。
--master_mpp_gc_pw=MASTER_MPP_GC_PW
含义：用于指定主集群的数据库用户密码；
GBase 8a MPP Cluster 产品手册
4 管理员指南
文档版本953（2022-04-10）
南大通用数据技术股份有限公司
587
--slave_mpp_gc_pw=SLAVE_MPP_GC_PW
含义：用于指定备集群的数据库用户密码；
参数类型：可选参数；
--table_list_file=TABLE_LIST_FILE
含义：用于被同步表的配置文件。
参数类型：必选参数；
注意事项和使用限制：文件名，该文件内容为需要同步的表列表，可以只有
一张表。文件内容格式为DBName.TBName，不支持vc.db.tb 格式。用换行符进行
分割，支持windows 换行符和linux 换行符，但必须统一，即文件内只能出现一种
换行符。
--table_parallel_degree=TABLE_PARALLEL_DEGREE
含义：用于指定集群间同步每次并行同步的表的数量；
参数类型：可选参数；
取值范围：【default:1，min:1, max:128】；
注意事项和使用限制：该参数需要根据主、备集群负载，业务并行度进行调
节；当作业并行度低，主备集群负载不高的情况下，可适当增大该配置参数。
--lock_table_timeout=LOCK_TABLE_TIMEOUT
含义：用于指定集群间同步工具对主集群、备集群表加锁的超时时间
参数类型：可选参数；
取值范围：【unit:second，default:600，min:1，max:3600】；
注意事项和使用限制：由于锁是用来互斥表的写操作，该参数需要根据表的
写操作最大时间进行适当延长。
--retry_times=RETRY_TIMES
含义：用于指定底层分片对分片的同步失败后的重试次数；
参数类型：可选参数；
取值范围【unit:次，default:1，min:1，max:10】
注意事项和使用限制：该参数主要取决于网络状态，在网络状态不佳（闪断、网
络阻塞）
的情况下，
会出现分片对分片的同步失败情况，
需要重试来保障同步成功，
GBase 8a MPP Cluster 产品手册
4 管理员指南
文档版本953（2022-04-10）
南大通用数据技术股份有限公司
588
需要根据网络状态进行适当的调大。
--retry_interval=RETRY_INTERVAL
含义：用于指定底层分片对分片的同步失败后的每次重试的时间间隔；
参数类型：可选参数；
取值范围：【unit:second，default:10，min:1，max:1800】；
注意事项和使用限制：该参数主要取决于网络状态，在网络状态不佳（闪断、网络
阻塞）的情况下，会出现分片对分片的同步失败情况，失败后需要等待一段时间，
期待网络恢复，然后再进行尝试，这个参数只是一个经验参数，不能确保等待一段
时间后网络一定会恢复完，并且同步成功。
--sync_mode=SYNC_MODE
含义：用于指定数据同步的模式【粗糙过滤，增量同步，全量同步】；
参数类型：可选参数；
取值范围【unit:无，default:1，min:1，max:3】。
说明
参数取值含义和使用场景的注意事项和使用限制：
粗糙过滤
含义：进行表的变更标识检查，如主备集群的表变更标识相同，直接跳过该表，不做同
步；表的变更标识不同，再做每个列级别的变更标识检查，进行增量同步；
适用场景：该参数值适用于备集群初始化完毕后，增量数据的同步，这种情况下建议使
用该参数。
增量同步
含义：不做表的变更标识检查，直接做每个列级别的变更标识检查，进行增量同步；
适用场景：该参数值适用于备集群初始化完毕后，增量数据的同步，该参数是由于版本
迭代历史原因保留，完全是为了版本兼容性。
全量同步
含义：不做任何级别的变更标识检查，直接用主机群的数据覆盖备集群的数据；
适用场景：该参数值适用于需要人为覆盖备集群的所有数据时，这种情况一般发生在如
下几种情况：
GBase 8a MPP Cluster 产品手册
4 管理员指南
文档版本953（2022-04-10）
南大通用数据技术股份有限公司
589
对备份集群的表进行过手动修改，数据已经不可信；
备集群的表数据发生损坏，需要重建修复；
备集群初始化。
--error_table_list_file=ERROR_TABLE_LIST_FILE
含义：用于指定同步失败的表存储的文件；
参数类型：可选参数；
取值范围：【default：当前目录
/${table_list_filename }_error_table_list_%Y_%m_%d-%H:%M:%S.log】；
注意事项和使用限制：文件内容格式为DBName.TBName，用换行符进行分割；可
选参数，参数默认值为当前目录，名称默认为
${table_list_filename }_error_table_list_%Y_%m_%d-%H:%M:%S.log，内容格式为
db.tb 每行一个，多行存储；该文件每次调用工具覆盖。
--log_name=LOG_NAME
含义：用于指定工具日志的存储文件；
参数类型：可选参数；
取值范围：【default：当前目录/gcluster_rsynctool_yyyy_mm_dd.log】；
注意事项和使用限制：指定的目录位置要有工具执行用户的写权限。
--log_level=LOG_LEVEL
含义：用于指定工具日志级别；
参数类型：可选参数；
取值范围【default:3，min:0，max:5】。
说明
注意事项和使用限制：
nolog level;
critical level;
error level;
warning level ;
GBase 8a MPP Cluster 产品手册
4 管理员指南
文档版本953（2022-04-10）
南大通用数据技术股份有限公司
590
info level;
debug level;
--rsync_mode=RSYNC_MODE
含义：用于指定工具调度模式；
参数类型：可选参数；
取值范围【default:2，min:0，max:2】。
说明
注意事项和使用限制：
0：主分片同步，备分片设定状态
含义：只同步备集群表的一组分片，其他备份的分片设定状态，通过集群内部的自动恢
复机制进行恢复；
适用场景：该参数值不建议使用，仅仅为了版本兼容保留；
1：主备同时同步
含义：同时同步备集群的主、备分片，单表同步的性能能够达到最大化；
适用场景：该参数值不建议使用，存在一个分片的主备都同步失败，表不可用的情况，该
参数是当初设计是为了数据安全性不高的场景。
2：先主后备同步方式.
含义：先同步备集群表的主分片，主分片同步成功后再同步备分片，确保备集群的表在
同步失败后存在一组可用分片，用来回滚同步操作；
适用场景：建议使用该参数，保证备集群表的数据安全。
--double_check
含义：用于指定是否启用回读校验；
参数类型：可选参数；
无参参数，取值范围【default:false】；
注意事项和使用限制：数据写入磁盘后，回读检查备集群表数据；该参数会降低
同步的性能，同时增加备集群的磁盘IO 消耗；可以在部署初期为了验证同步的正
确性时采用。
--slave_create_table_if_not_exists 可选参数
GBase 8a MPP Cluster 产品手册
4 管理员指南
文档版本953（2022-04-10）
南大通用数据技术股份有限公司
591
Create table if not slave mpp.[default:false]
参数使用注意事项：
该参数在启用后，
会在slave 需要建表时，
使用集群间同步工具指定的database_user
建表，如master 上的表不是由该用户建立，会导致slave 上出现异常，异常包括但
不限于：建表不成功，该表建立后权限存在问题，表的UID 不是预期的UID，资源
管理的磁盘空间限制出错等现象，所以启用该参数时，需要使用者严格按照被同步
的表都是指定的database_user 的表。
--sync_vc_name
需要同步的VC 名字。
注：
每次同步一个vc 内容，不支持同时同步多个vc 的信息；
同步的vc 要求vcname、表分布方式一致，不同步镜像表内容；
同步表时只同步表的数据信息和元数据信息，不同步其他内容。