Kingbase FlySync 命令行工具参考手册

Kingbase FlySync 命令行工具参考手册
北京人大金仓信息技术股份有限公司
Mar 20, 2023

目 录
1 前言 9
1.1 版权声明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.2 免责声明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.3 技术支持 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2 概述 11
3 需求可行性评估 13
3.1 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4 安装和部署 15
4.1 fspm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.1.1 主要参数说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.1.2 configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.1.2.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.1.2.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.1.3 install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.1.3.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.1.3.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.1.4 delete-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.1.4.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.1.4.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.1.5 diag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.1.5.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.1.5.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.1.6 update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.1.6.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.1.6.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.1.7 validate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.1.7.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3
4.1.7.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.1.8 validate-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.1.8.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.1.8.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.2 setupCDC.sh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.2.1 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.3 updateCDC.sh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.3.1 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.3.2 与 setupCDC.sh 区别 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.4 cleanCDC.sh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.4.1 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
5 存量数据迁移 23
5.1 ddlscan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
5.1.1 主要参数说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
5.1.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
5.2 loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.2.1 主要参数说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.2.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5.3 reload-table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
5.3.1 主要参数说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
5.3.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6 运维和监控 31
6.1 replicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.1.1 console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.1.1.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.1.1.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.1.2 start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.2.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.2.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.3 stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.3.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.3.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.4 restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.4.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.4.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.5 condrestart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.5.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.1.5.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.6 status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.6.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4
6.1.6.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.7 install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.7.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.7.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.8 installstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.8.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.8.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.9 remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.1.9.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.1.9.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.2 fsrepctl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.2.1 主要参数说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.2.1.1 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.2.2 version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.2.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.2.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.3 services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.3.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.3.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.3.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.4 kill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.4.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.4.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.2.4.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.5 capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.5.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.5.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.6 clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.6.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.6.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.7 clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.7.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.7.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2.8 configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.8.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.8.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.9 flush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.9.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.9.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.9.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.10 heartbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.10.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5
6.2.10.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.10.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.11 offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.11.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.11.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.11.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.12 offline-deferred . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.12.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.12.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.12.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.13 online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.13.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.13.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.13.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.14 perf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.14.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.14.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.15 properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.15.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.15.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.15.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.16 purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.16.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.16.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.16.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.2.17 reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.2.17.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.2.17.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.2.17.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.2.18 trigger-enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.2.18.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.2.18.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.2.18.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.2.19 trigger-disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.2.19.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.2.19.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.2.19.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.2.20 setrole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.2.20.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.2.20.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.2.20.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2.21 load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6
6.2.21.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2.21.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2.22 upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2.22.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2.22.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2.23 qs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2.23.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2.23.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.2.23.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.2.24 status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.2.24.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.2.24.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.2.24.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.25 wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.25.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.25.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.25.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.26 sync-tables min-seq max-seq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.26.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.26.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.27 failure-messages min-seq max-seq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.28 license show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.2.28.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.2.28.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.2.28.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.2.29 -from-event eventID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.2.29.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.2.29.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.3 kufl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
6.3.1 list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
6.3.1.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
6.3.1.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.3.1.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.3.2 index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.3.2.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.3.2.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.2.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.3 purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.3.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.3.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.3.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.4 info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
7
Kingbase FlySync 命令行工具参考手册
6.3.4.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.4.2 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
6.3.4.3 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
7 其他工具 51
7.1 query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
7.1.1 主要参数说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
7.1.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.2 repkeyclean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.2.1 主要参数说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.2.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.2.3 特殊字符的处理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.3 repswitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.3.1 主要参数说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.3.2 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.2.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.2.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.3 offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.3.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.3.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.4 online [node] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.4.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.4.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.5 reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.5.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.3.5.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.3.6 switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.3.6.1 作用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.3.6.2 使用方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
8 目 录
第 1 章
前言
1.1 版权声明
人大金仓版权所有，并保留对本手册及本声明的一切权利。未得到人大金仓的书面许可，任何人不得以任何
方式或形式对本手册内的任何部分进行复制、摘录、备份、修改、传播、翻译成其他语言、将其全部或部分
用于商业用途。
1.2 免责声明
本手册内容依据现有信息制作，由于产品版本升级或其他原因，其内容有可能变更。人大金仓保留在没有任
何通知或者提示的情况下对手册内容进行修改的权利。本手册仅作为使用指导，人大金仓在编写本手册时已
尽力保证其内容准确可靠，但并不确保手册内容完全没有错误或遗漏，本手册中的所有信息也不构成任何
明示或暗示的担保。
9
Kingbase FlySync 命令行工具参考手册
1.3 技术支持
• 人大金仓官方网站： http://www.kingbase.com.cn/ 您可以在官网中获得人大金仓所有产品的资讯信
息，销售联系方式
• 金仓数据同步工具子网站： http://kfs.kingbase.com.cn/ 您可以在产品子网站中获得最新的产品技术
资料、产品故障原因及问题分析、产品的应用解决方案、软件升级资料等等。
• 全国服务热线： 400-601-1188
• 人大金仓技术支持与反馈信箱： support@kingbase.com.cn
10 第 1 章 前言
第 2 章
概述
本文档列出 Kingbase FlySync 命令行管理工具的使用参数。
11
Kingbase FlySync 命令行工具参考手册
12 第 2 章 概述
第 3 章
需求可行性评估
需求可行性评估在部署前对所需要的一些信息进行自动化收集，主要包括以下内容：
• 运行环境评估
• 数据库配置评估
• 数据类型和主键信息评估
• 主键合法性评估
主要参数说明
13
Kingbase FlySync 命令行工具参考手册

参 数 名 称	参数含义
- assess	选择需要评估的项目。可填写:all、 RuntimeEnv、 DatabaseConf、 DatabaseTypeAndP Key、 Keyword
-dbtype	要评估的数据库类型。目前支持： mysql、 oracle、 kingbaseV7、 kingbase8、 mssql、 postgreSQL
-host	要评估的数据库 ip 地址
-port	数据库端口
-user	数据库用户
-pass	数据库用户密码
-db	数据库库名
- schema	要检查的数据库模式 (mysql 时与 db 值相同)
-path	报告生成的地址
- envHost	如果要进行远程环境评估，远程的 ip 得治
- envUser	如果要进行远程环境评估，远程的用户名
- envPass	如果要进行远程环境评估，远程用户的密码
- envPort	如果要进行远程环境评估，远程 ssh 端口，不填写默认为 22

使用方式如下
3.1 使用方法
./repassess -asses all -dbtype mysql -host xxx.xxx.xx.xx -port 3306 -user kfs -pass 123456 -db
test -schema test -path /home/kfs
在部署之前需确认 KingbaseES V8 的具体版本，如果为 V8R3（不含）之上的版本，需要将
安装包中 kingbase8-8.6.0.jar 拷贝到 lib 目录下，如果为 V8R3(含) 以下版本，使用安装包中
kingbase8-8.2.0.jar 拷贝到 lib 目录下。
14 第 3 章 需求可行性评估
第 4 章
安装和部署
4.1 fspm
fspm 全称为 flysync 包管理器，用来安装和配置 Kingbase FlySync 的同步服务组件，主要功能包括
• 校验配置文件的正确性
• 部署同步服务组件
• 修改同步服务组件的参数
• 升级同步服务组件
• 删除同步服务
• 重置同步服务断点信息
• 收集同步表服务的诊断信息
15
Kingbase FlySync 命令行工具参考手册
4.1.1 主要参数说明

参数名称	参数含义
-f | –force	不显示确认提示或错误停止的过程

fspm 的子命令如下
4.1.2 configure
4.1.2.1 作用
更新全局配置中的数据服务设置
4.1.2.2 使用方法
fspm configure
4.1.3 install
4.1.3.1 作用
使用当前配置和指定的选项安装 FlySync
4.1.3.2 使用方法
fspm install
4.1.4 delete-service
4.1.4.1 作用
删除本地 FlySync 服务
16 第 4 章 安装和部署
Kingbase FlySync 命令行工具参考手册
4.1.4.2 使用方法
fspm delete-service
4.1.5 diag
4.1.5.1 作用
将 FlySync 诊断信息打包到当前机器上
4.1.5.2 使用方法
fspm diag. 并有如下附加参数
--path [path] ： 会将诊断信息的 zip 文件放在指定的位置上
4.1.6 update
4.1.6.1 作用
使用 flysync.ini 配置文件信息更新已经安装的 FlySync
4.1.6.2 使用方法
fspm update
4.1.7 validate
4.1.7.1 作用
安装前进行使用 flysync.ini 配置文件进行验证
4.1.7.2 使用方法
fspm validate
4.1. fspm 17
Kingbase FlySync 命令行工具参考手册
4.1.8 validate-update
4.1.8.1 作用
更新前进行使用 flysync.ini 配置文件进行验证
4.1.8.2 使用方法
fspm validate-update
4.2 setupCDC.sh
setupCDC.sh 使用在 SQL Server 作为源端的场景中，只有使用 setupCDC.sh 脚本配置过的表，
Kingbase FlySync 才能获取增量数据，进行数据同步
setupCDC.sh 可以接受一个参数，此参数为定义 CDC 配置的配置文件名，默认的配置文件为当
前目录下 setupCDC.conf ，配置文件中可接收的参数内容如下
• service
服务名称，由用户自行指定
注意： 需要和和后面同步工具部署时的服务名称保持一致
• db_host
SQLServer 所在的机器地址和端口，默认 localhost,1433
• db_name
要同步的表所在的数据库名称
• sa_user
sa 用户的帐号名称， setupCDC.sh 脚本使用 sa 账号来创建后续的 source_user sa 账号仅
在配置时使用一次，后续不再使用
• sa_pass
sa 用户的密码；
注意： 由于 setupCDC.sh 脚本采用脚本的形式读取配置文件内容，故密码中不能含有特殊
字符；如果含有特殊字符，可以考虑临时改掉密码，待执行完 setupCDC.sh 脚本后再恢复
• source_user
同步的用户名称（会自动创建）
• source_password
同步的用户密码，同样，不能含有特殊字符
18 第 4 章 安装和部署
Kingbase FlySync 命令行工具参考手册
• delete_user
是否删除同步用户（当存在时，注意：设置为 1 时，会强制删除同步用户）一般用在重新
部署时
• specific_path
flysync.tables 文件所在的路径。 flysync.tables 文件的格式为:
schama_name<tab>table_name<tab>column_list
比如:
SCHEMA_1<tab>TABLE_1<tab>C1,C2,C3 表示 TABLE_1 的 C1、 C2、 C3 列
SCHEMA_1<tab>TABLE_1 表示 TABLE_1 的所有列
SCHEMA_1 表示 SCHEMA_1 模式下的所有表，的所有列
注意： 所有预同步表必需包含主键
• file_group_size
创建文件组最大值，不指定默认 16GB，值参照增量数据储备大小设定
4.2.1 使用方法
1. 修改 setupCDC.conf
service=sqlserver
db_host=localhost,1433
db_name=test
sa_user=sa
sa_pass=Pass123456
source_user=flysync_sqlserver
source_password=Pass123456
delete_user=1
specific_path=
file_group_size=16GB
2. 修改 flysync_tables
4.2. setupCDC.sh 19
Kingbase FlySync 命令行工具参考手册
dbo test1
dbo test2
3. 执行脚本 setupCDC.sh setupCDC.conf
注意:
• 执行 setupCDC.sh 前需要安装配置 JDK1.8+
• Linux 执行前请执行 sudo /opt/mssql/bin/mssql-conf set sqlagent.enabled true 以及 systemctl restart
mssql-server.service
• Windows 执行前请到系统服务中开启 SQL Server 的对应服务（ MSSQLSERVER、 SQLServer Agent 等
服务）
• 创建 file group，仅在文件组不存在时生效，若想更新文件组大小，需要手动删除文件组再执行
setupCDC.sh
4.3 updateCDC.sh
updateCDC.sh 修改配置文件后, 读取配置文件进行更新数据库 CDC 配置
4.3.1 使用方法
1. 修改 setupCDC.conf
2. 修改 flysync_tables
3. 执行脚本 updateCDC.sh setupCDC.conf
4.3.2 与 setupCDC.sh 区别
两者的行为：
1. setupCDC.sh：删掉现存的订阅，然后将整个模式重新订阅（如果有上次没订阅的表，本次会新订
阅），用于初次创建 CDC 或者想重新创建所有的 CDC 关系
2. updateCDC.sh: 仅处理列出来的表（当列出的表订阅清理掉，重新订阅；如果表本身就没有被订阅，
则忽略），用于仅仅想订阅某个表的 CDC 关系
20 第 4 章 安装和部署
Kingbase FlySync 命令行工具参考手册
4.4 cleanCDC.sh
cleanCDC.sh 主要作用是清除执行 ‘setupCDC.sh‘ 后产生的同步用户, 记录同步的 ‘tablenam_CT‘
表等信息
可以接受一个参数，默认的配置文件为当前目录下的 setupCDC.conf
4.4.1 使用方法
1. 修改 setupCDC.conf
2. 执行脚本 cleanCDC.sh
4.4. cleanCDC.sh 21
Kingbase FlySync 命令行工具参考手册
22 第 4 章 安装和部署
第 5 章
存量数据迁移
5.1 ddlscan
ddlscan 命令是用来帮助用户完成原系统中历史数据的一次性迁移, 负责结构搬迁
5.1.1 主要参数说明
23
Kingbase FlySync 命令行工具参考手册

参数名称	参数含义
-target.service	将要搬迁的服务名称（目标端本地的服务名称, 软件会自动查找对 应的 static 配置文件）
-service	同 -target.service 参数（兼容低版本 FS）
-source.host sourceHost	源端数据库地址
-source.port sourcePort	源端数据库端口
-source.user sourceUser	源端数据库账号
-source.pass sourcePass	源端数据库密码
-source.db sourceDb	源端数据库数据库名称（ oracle 对应服务名称）
-source.schema sourceSchema	源端数据库数据库表所在的模式名
-source.dbtype sourceDbType	源端数据库类型, 目前支持： oracle、 mysql、 mssql、 kingbase7、 kingbase8
-target.db targetDb	目标端数据库地址
-source.tables regex	要搬迁的表列表, 逗号分隔（不要加模式名, 如果需要搬迁多个模 式, 请运行多次, 不加此参数, 搬迁指定模式下所有表）
-source.rmiHost rmiHost	源端服务主机 ip
-source.rmiPort rmiPort	源端服务主机 rmi 端口, 即 rmi-port
-mgType num	搬迁类型,0/1 目标端流水线搬迁,2 源端流水线搬迁, 默认 0
-targetServiceFile file	目标端服务收集结果文件绝对目录, 默认位置 ~/service.json
-opt opt val	特殊参数, 目前只在 Oracle 到 Kingbase 搬迁中使用 -opt withoid <true|false> - 默认 false -opt dbVersion <7|8> - 默认 8.
-out file	输出 DDL CREATE 语句到指定文件
-enable-dynamic	读取 conf 目录下 dynamic 动态文件默认 false
-skipError	出错后继续执行

5.1.2 使用方法
1. 特殊模式（源端流水线）
源端流水线结构搬迁需要在数据同步环境的源端节点上运行
假设将 KingbaseES V7 中 PUBLIC 模式下的 TEST1 和 TEST2 表迁移到目标端 Kingbase V7
的 TEST 库下, 源端服务名为 kingabse7
执行命令行参数如下:
ddlscan -source.service kingbase7 -source.user SYSTEM -source.pass 123456 \
-source.db TEST -source.dbtype kingbase7 -source.host 192.168.11.44 \
-source.port 65432 -source.schema PUBLIC -source.tables TEST1,TEST2 \
-target.db TEST -source.rmiHost 192.168.11.44 -source.rmiPort 11000 \
-target.service kingbase7 -mgType 2
24 第 5 章 存量数据迁移
Kingbase FlySync 命令行工具参考手册
注意:
• 需要依赖管理控制台收集的目标端服务信息, 可以通过命令 fsrepctl services >
service.json 导出 service.json 文件, 将文件放置默认位置家目录下, 或放置其他位置,
通过 -targetServiceFile 手动指定文件位置
• 需保证源端服务状态 online
2. 极速模式/平滑模式（目标端流水线）
目标端流水线结构搬迁需要在数据同步环境的目标端节点上运行
假设将 KingbaseES V7 中 PUBLIC 模式下的 TEST1 和 TEST2 表迁移到目标端 Kingbase V7 的
TEST 库下, 目标端服务名为 kingabse7
执行命令行参数如下:
ddlscan -target.service kingbase7 -source.user SYSTEM -source.pass 123456 \
-source.db TEST -source.dbtype kingbase7 -source.host 192.168.11.44 \
-source.port 65432 -source.schema PUBLIC -source.tables TEST1,TEST2 \
-target.db TEST -mgType 0
注意: -myType 对应极速模式使用 0, 平滑模式使用 1
5.2 loader
loader 命令是用来完成原系统中历史数据的数据搬迁
5.2.1 主要参数说明
5.2. loader 25
Kingbase FlySync 命令行工具参考手册

参数名称	参数含义
-conf	指定 static-<svc>.properties 文件路径
-target.service	将要搬迁的服务名称（目标端本地的服务名称, 软件会自动查找对 应的 static 配置文件） , 同 ‘-conf‘参数
-service	同 -target.service 参数（兼容低版本 FS）
-source.service	将要搬迁的服务名称（源端端本地的服务名称, 软件会自动查找对 应的 static 配置文件）
-source.host sourceHost	源端数据库地址
-source.port sourcePort	源端数据库端口
-source.user sourceUser	源端数据库账号
-source.pass sourcePass	源端数据库密码
-source.db sourceDb	源端数据库数据库名称（ oracle 对应服务名称）
-source.dbtype sourceDbType	源端数据库类型, 目前支持： oracle、 mysql、 mssql、 kingbase7、 kingbase8
-source.schema sourceSchema	源端数据库数据库模式名, 若指定则搬迁模式下的所有表, 不需要 指定 -source.tables 参数
-source.tables regex	要搬迁的表全名（含模式名） , 逗号分隔
-source.rmiHost	源端服务主机 ip
-source.rmiPort	源端服务主机 rmi 端口, 即 rmi-port
-target.rmiHost	目标端服务主机 ip
-target.rmiPort	目标端服务主机 rmi 端口, 即 rmi-port
-mgType	搬迁类型,0 极速模式,1 平滑模式,2 特殊模式, 默认 0
-usingSplit	开启大表拆分, 默认不开启
-enable-dynamic	读取 conf 目录下 dynamic 动态文件默认 false
-maxUsedCPU num	KFS 占用 CPU 最大比例, 值为百分比, 默认 100%, 例： 100%
-readWriteRatio rNum:wNum	每个流水线读写比例配置, 默认 1:3
-sizePerBlock num	大表拆分每块大小, 默认 100, 单位 MB
-blobSize num	大对象长度大小, 默认 500, 单位 B
-validateTargetTable	检验目标端表是否存在, 默认不校验
-source.maxRowsByBlock size	批量提交的数量, 默认 1000
-clean	指定该参数则搬迁数据前清空表数据
-logLevel	设置搬迁数据日志级别

26 第 5 章 存量数据迁移
Kingbase FlySync 命令行工具参考手册
5.2.2 使用方法
1. 极速模式（目标端流水线快速搬迁）
假设将 KingbaseES V7 中 PUBLIC 模式下的 TEST1 和 TEST2 表迁移到目标端 Kingbase V7
的 TEST 库下, 目标端服务名为 kingabse7
执行命令行参数如下:
loader -source.user SYSTEM -source.pass 123456 -source.db TEST \
-source.dbtype kingbase7 -source.host 192.168.11.44 -source.port 65432 \
-source.tables PUBLIC.TEST1,PUBLIC.TEST2 -target.service kingbase7 \
-mgType 0
注意：
• 上述数据搬迁命令不会清空原有数据, 需要需要清空数据, 需要指定参数 -clean
• 初始搬迁的命令行操作, 需要在配置完数据同步, 启动后台服务, 还没有正式数据同步
时进行
• 只能在目标端执行
2. 平滑模式（目标端流水线无缝搬迁）
假设将 KingbaseES V7 中 PUBLIC 模式下的 TEST1 和 TEST2 表迁移到目标端 Kingbase V7
的 TEST 库下, 源端服务名 kingbase7, 目标端服务名为 kingabse7
执行命令行参数如下:
loader -source.service kingbase7 -source.user SYSTEM -source.pass 123456 \
-source.db TEST -source.dbtype kingbase7 -source.host 192.168.11.44 \
-source.port 65432 -source.tables PUBLIC.TEST1,PUBLIC.TEST2 \
-source.rmiHost 192.168.11.44 -source.rmiPort 11000 \
-target.rmiHost 192.168.11.45 -target.rmiPort 11000 \
-target.service kingbase7 -mgType 1
注意：
• 平滑模式搬迁过程中, 不可人为修改服务状态。若因外界原因导致服务状态异常, 需将服
务修正为 online 后再次执行搬迁
• 只能在目标端执行
3. 特殊模式（源端流水线无缝搬迁）
假设将 KingbaseES V7 中 PUBLIC 模式下的 TEST1 和 TEST2 表迁移到目标端 Kingbase V7
的 TEST 库下, 源端服务名 kingbase7, 目标端服务名为 kingabse7
执行命令行参数如下:
5.2. loader 27
Kingbase FlySync 命令行工具参考手册
loader -source.service kingbase7 -source.user SYSTEM -source.pass 123456 \
-source.db TEST -source.dbtype kingbase7 -source.host 192.168.11.44 \
-source.port 65432 -source.tables PUBLIC.TEST1,PUBLIC.TEST2 \
-source.rmiHost 192.168.11.44 -source.rmiPort 11000 \
-target.service kingbase7 -mgType 2
注意：
• 特殊模式搬迁过程中, 不可人为修改服务状态。若因外界原因导致服务状态异常, 需将服
务修正为 online 后再次执行搬迁
• 需要依赖管理控制台收集的目标端服务信息, 可以通过命令 fsrepctl services >
service.json 导出 service.json 文件, 将文件放置默认位置家目录下, 或放置其他位置,
通过 -targetServiceFile 手动指定文件位置
• 只能在源端执行
5.3 reload-table
reload-table 全称为 单表刷新, 单表刷新支持在不经过数据校验的情况下, 将源端和目标端数据不一致的表,
刷新为一致的数据, 必须在源端执行
5.3.1 主要参数说明

参数名称	参数含义
-service name	将要刷新的服务名称（源端本地的服务名称，软件会自动查找对应的 static 配置文件）
-h host	源端数据库地址
-P port	源端数据库端口
-u user	源端数据库账号
-p password	源端数据库密码
-d db	源端数据库数据库名称（ oracle 对应服务名称）
-type dbType	源端数据库类型
-t tableName	需要进行单表刷新的表全名（含模式名） , 例 schemaA.tableA
-rmiHost	源端服务主机 ip
-rmiPort	源端服务主机 rmi 端口，即 rmi-port
-help	查看命令帮助列表

28 第 5 章 存量数据迁移
Kingbase FlySync 命令行工具参考手册
5.3.2 使用方法
reload-table -type kingbase7 -d TEST -u SYSTEM -p 123456 -h 192.168.11.41 -P 65432 -t
PUBLIC.TEST -service kingbase7 –rmiHost 192.168.11.41 –rmiPort 11000
对 KingbaseES V7 TEST 数据库中 PUBLIC 模式下的 TEST1 表进行单表刷新，源端服务名
kingbase7
注意：
• 需要依赖管理控制台收集的目标端服务信息, 可以通过命令 fsrepctl services >
service.json 导出 service.json 文件, 将文件放置默认位置家目录下, 或放置其他位
置, 通过 -targetServiceFile 手动指定文件位置
• 单表刷新只能在源端执行
5.3. reload-table 29
Kingbase FlySync 命令行工具参考手册
30 第 5 章 存量数据迁移
第 6 章
运维和监控
6.1 replicator
replicator 命令是用来对同步服务的开关, 系统注册和查看状态等
replicator 的子命令如下
6.1.1 console
6.1.1.1 作用
在当前控制台中启动
6.1.1.2 使用方法
replicator console
31
Kingbase FlySync 命令行工具参考手册
6.1.2 start
6.1.2.1 作用
作为守护进程在后台启动
6.1.2.2 使用方法
replicator start
6.1.3 stop
6.1.3.1 作用
运行时停止同步服务
6.1.3.2 使用方法
replicator stop
6.1.4 restart
6.1.4.1 作用
重新启动同步服务
6.1.4.2 使用方法
replicator restart
6.1.5 condrestart
6.1.5.1 作用
仅在同步启动时重新启动同步
32 第 6 章 运维和监控
Kingbase FlySync 命令行工具参考手册
6.1.5.2 使用方法
replicator condrestart
6.1.6 status
6.1.6.1 作用
查看当前同步状态
6.1.6.2 使用方法
replicator status
6.1.7 install
6.1.7.1 作用
安装系统服务, 系统启动时自动启动同步服务, 只能使用 root 用户执行
6.1.7.2 使用方法
replicator install
6.1.8 installstart
6.1.8.1 作用
安装系统服务并后台启动同步服务, 只能使用 root 用户执行
6.1.8.2 使用方法
replicator installstart
6.1. replicator 33
Kingbase FlySync 命令行工具参考手册
6.1.9 remove
6.1.9.1 作用
卸载同步相关的系统服务, fs 只能使用 root 用户执行
6.1.9.2 使用方法
replicator remove
6.2 fsrepctl
fsrepctl 命令是用来对 FlySync 服务提供管理和控制的作用，主要功能包括
• 控制同步服务启停
• 执行备份和恢复操作
• 出现问题时跳过 KUFL 中的事件
• 获取状态和配置信息
6.2.1 主要参数说明

参数名称	参数含义
-host name	指定操作的主机 (rmi host), 必须保证 replicator service 正在运行中
-port number	指定管理的 TCP/IP 端口 (rmi port)
-service name	指定同步服务的服务名
-verbose	打印单个操作的详细信息
-retry N	按指定次数重试操作请求, 直至成功

6.2.1.1 使用方法
fsrepctl -host 192.168.1.24 -port 11000 -verbose -retry 5 status 显示信息操作的指定远程地址
同步服务状态
fsrepctl 的子命令如下
34 第 6 章 运维和监控
Kingbase FlySync 命令行工具参考手册
6.2.2 version
6.2.2.1 作用
查看 FlySync 版本
6.2.2.2 使用方法
fsrepctl version
6.2.3 services
6.2.3.1 作用
输出系统中配置的同步服务的列表以及关键参数，如 SEQ 号, 状态等
6.2.3.2 选项

名称	含义
-json	以 JSON 格式输出
-full	输出完整的服务信息

6.2.3.3 使用方法
fsrepctl services -json -full
6.2.4 kill
6.2.4.1 作用
立即退出而不关闭服务
6.2.4.2 选项

名称	含义
-y	忽略检查

6.2. fsrepctl 35
Kingbase FlySync 命令行工具参考手册
6.2.4.3 使用方法
fsrepctl kill -y
6.2.5 capabilities
6.2.5.1 作用
列出同步支持的能力
6.2.5.2 使用方法
fsrepctl capabilities
6.2.6 clear
6.2.6.1 作用
删除在同步服务中配置的任何动态属性
6.2.6.2 使用方法
fsrepctl clear
6.2.7 clients
6.2.7.1 作用
输出连接到的源端的服务列表, 只能在源端使用
6.2.7.2 使用方法
fsrepctl clients
36 第 6 章 运维和监控
Kingbase FlySync 命令行工具参考手册
6.2.8 configure
6.2.8.1 作用
重新加载 static 配置文件
6.2.8.2 使用方法
fsrepctl configure
6.2.9 flush
6.2.9.1 作用
作用在源端上, 刷新数据库的事务历史日志存放到本地磁盘 kufl 里
6.2.9.2 选项

名称	含义
-limit	指定命令行返回前等待的时间

6.2.9.3 使用方法
fsrepctl flush
6.2.10 heartbeat
6.2.10.1 作用
插入一个指定名称的心跳事件
6.2.10.2 选项

名称	含义
-name	指定心跳的事件

6.2. fsrepctl 37
Kingbase FlySync 命令行工具参考手册
6.2.10.3 使用方法
fsrepctl heartbeat -name REPLICATOR_STOP
6.2.11 offline
6.2.11.1 作用
将同步状态置为 OFFLINE
6.2.11.2 选项

名称	含义
-immediate	立即停止

6.2.11.3 使用方法
fsrepctl offline -immediate
6.2.12 offline-deferred
6.2.12.1 作用
设置一个将来的序列, 事件或者心跳作为一个触发器让同步处于停止状态
6.2.12.2 选项

名称	含义
-at-seqno	在指定 seqno offline
-at-event	在指定事件 offline
-at-heartbeat	在指定心跳 offline
-at-time	在指定时间 offline

38 第 6 章 运维和监控
Kingbase FlySync 命令行工具参考手册
6.2.12.3 使用方法
fsrepctl offline-deferred -at-heartbeat REPLICATOR_STOP, 设置一个心跳触发器, 如果有此心跳,
停止同步服务
6.2.13 online
6.2.13.1 作用
将同步状态置为 ONLINE
6.2.13.2 选项

名称	含义
-force	强制状态 ONLINE
-from-event event	从指定事件开始同步
-base-seqno x	在源端上, 使用指定的 seqno 号开始重新启动同步
-skip-seqno x,y,z	状态 ONLINE 前跳过指定的 seqno
-until-seqno seqno	定义停止同步的 seqno
-until-event event	定义停止同步的事件
-until-heartbeat [name]	定义停止同步的心跳
-until-time YYYY-MM-DD_hh:mm:ss	定义停止同步的时间
-no-checksum	ONLINE 时, 跳过 checksum 检查

6.2.13.3 使用方法
fsrepctl -service kingbase online -skip-seqno 10, 同步服务置为 online, 并跳过 seqno 号为 10
的事件
6.2.14 perf
6.2.14.1 作用
展示同步的性能信息
6.2. fsrepctl 39
Kingbase FlySync 命令行工具参考手册
6.2.14.2 使用方法
fsrepctl perf
6.2.15 properties
6.2.15.1 作用
输出同步服务 JSON 格式的配置信息
6.2.15.2 选项

名称	含义
-filter name	筛选列表
-values	筛选属性中的值

6.2.15.3 使用方法
fsrepctl properties -filter kufl -values 输出配置文件中包含 kufl 的所有值
6.2.16 purge
6.2.16.1 作用
断开除同步相关的所有数据库连接
6.2.16.2 选项

名称	含义
-y	忽略检查
-limit s	指定操作等待的时间

40 第 6 章 运维和监控
Kingbase FlySync 命令行工具参考手册
6.2.16.3 使用方法
fsrepctl purge -y
6.2.17 reset
6.2.17.1 作用
• 删除本地 KUFL 文件以及存储目录
• 从数据库里删除 FlySync 创建的模式
• 删除设置过的动态属性
6.2.17.2 选项

名称	含义
-y	忽略检查
-all	删除同步生成的 kufl 文件、 relay 日志以及数据库相关表、模式、函数和触发器等
-kufl	删除 kufl 文件和目录
-relay	删除同步生成的 relay 日志及其目录
-db	删除生成的数据库相关表、模式、函数和触发器等
-redo	oracle redo 专用, 清除 redo 读取器断点状态, 将其 LSCN 号设置成当前最新
-position	删除历史断点记录, 从当前最新记录开始解析

6.2.17.3 使用方法
fsrepctl -service kingbase reset -all -y
6.2.18 trigger-enable
6.2.18.1 作用
启用指定模式下的所有触发器, 必须指定服务名和模式
6.2. fsrepctl 41
Kingbase FlySync 命令行工具参考手册
6.2.18.2 选项

名称	含义
-schema s	指定模式

6.2.18.3 使用方法
fsrepctl -service kingbase trigger-enable -schema PUBLIC -y
6.2.19 trigger-disable
6.2.19.1 作用
禁用指定模式下的所有触发器, 必须指定服务名和模式
6.2.19.2 选项

名称	含义
-schema s	指定模式

6.2.19.3 使用方法
fsrepctl -service kingbase trigger-disable -schema PUBLIC -y
6.2.20 setrole
6.2.20.1 作用
更改同步服务的角色, 可用作源端目标端切换
6.2.20.2 选项

名称	含义
-role r	同步的角色 master | slave
-uri u	设置 master 的 url 地址, 当设置为 slave 时, 需要指定

42 第 6 章 运维和监控
Kingbase FlySync 命令行工具参考手册
6.2.20.3 使用方法
fsrepctl -service kingbase setrole -role slave -url kufl://192.168.1.2:2112/
6.2.21 load
6.2.21.1 作用
加载配置文件并启动同步服务, 必须指定服务名
6.2.21.2 使用方法
fsrepctl -service kingbase load
6.2.22 upload
6.2.22.1 作用
卸载并停止同步服务
6.2.22.2 使用方法
fsrepctl -service kingbase upload
6.2.23 qs
6.2.23.1 作用
快速简单的打印输出同步的状态信息, 主要包括:
• 在线 ONLINE 时间, 运行时间
• 同步服务名
• 同步事务量, 剩余事务所需同步时间
6.2. fsrepctl 43
Kingbase FlySync 命令行工具参考手册
6.2.23.2 选项

名称	含义
-r times	刷新指定次数显示状态

6.2.23.3 使用方法
fsrepctl qs -r 4, 显示同步状态 4 次
6.2.24 status
6.2.24.1 作用
详细的打印输出同步的状态信息, 主要包括:
• 在线 ONLINE 时间, 运行时间
• 同步服务名
• 同步事务量, 剩余事务所需同步时间
6.2.24.2 选项

名称	含义
-name	指定特定的状态信息 (channel-assignments | stages | watches | services | stores | shards | tasks)
-json	以 JSON 格式输出
-r times	刷新指定次数显示状态

• channel-assignments 分配的通道状态信息
• stages 列出同步中配置的各个阶段信息
• watches
• services 输出同步中定义的内部服务列表
• stores 显示同步存储状态列表信息, 包括 kufl 的内存存储, seqno 号, 文件大小和保留信息等
• shards
• tasks 输出同步服务中活动任务每个阶段的列表
44 第 6 章 运维和监控
Kingbase FlySync 命令行工具参考手册
6.2.24.3 使用方法
fsrepctl -service kingbase status -name channel-assignments -json 显示 kingbase 同步服务 json
格式的分配的通道信息
6.2.25 wait
6.2.25.1 作用
等待指定时间进入特定状态或者同步特定 SEQNO 号
6.2.25.2 选项

名称	含义
-state st	指定特定的状态信息
-applied seqno	指定要等待同步的 SEQNO 号
-limit	指定等待的时间

6.2.25.3 使用方法
fsrepctl wait -state ONLINE -limit 10, 等待 10s 后同步状态为 ONLINE
6.2.26 sync-tables min-seq max-seq
6.2.26.1 作用
获取指定 SEQ 号范围内所已同步的表和数量, 必须指定范围
6.2.26.2 使用方法
fsrepctl sync-tables -1 10, 查看第一条到第十条 SEQ 同步的已同步的表信息
6.2.27 failure-messages min-seq max-seq
获取指定 SEQ 号范围内所同步的出错的服务名,SEQ 号和错误信息
6.2. fsrepctl 45
Kingbase FlySync 命令行工具参考手册
6.2.28 license show
6.2.28.1 作用
显示 KFS license 信息
6.2.28.2 选项

名称	含义
-json	按 Json 格式输出

6.2.28.3 使用方法
fsrepctl license show -json
6.2.29 -from-event eventID
6.2.29.1 作用
清除断点后从指定 EVENTID 的事务开始同步 (清除断点参考 6.2.17 reset 命令)
6.2.29.2 使用方法
执行 kufl list 命令获取 EVENTID, 如下图
fsrepctl online -from-event EVENTID
46 第 6 章 运维和监控
Kingbase FlySync 命令行工具参考手册
6.3 kufl
kufl 是记录增量生成的同步中间文件, 主要功能包括
• 查看 kufl 列表
• 详细增量同步信息
• 清除已生成的 kufl 文件
• 统计 kufl 事务、文件大小
主要参数说明

参数名称	参数含义
-conf path	指定 static-<svc>.properties 文件路径
-service name	指定服务名, 多服务时必须用到, 功能同 ‘-conf path‘参数
-path file	指定 kufl 文件绝对路径

kufl 的子命令如下
6.3.1 list
6.3.1.1 作用
查看 kufl 列表, 详细信息等
6.3. kufl 47
Kingbase FlySync 命令行工具参考手册
6.3.1.2 选项

名称	含义
-low|-from	指定 SEQ 号的开始
-high|-to	指定 SEQ 号的结束
-first	第一条 kufl
-last	最后一条 kufl
-seqno	指定 seq 号输出 kufl 详细信息
-file <file_name>	指定 kufl 文件名输出 kufl 信息, 不需要加路径
-charset <charset>	指定 kufl 显示的字符编码格式
-sql	输出 kufl 里 DDL sql 语句, 不支持 DML
-hex	byte 数组和 blob 等择以十六进制输出
-specs	显示 kufl 中列的名称、类型和长度等
-headers	输出 kufl 的头文件
-json	此参数必须和 ‘-headers‘参数一起使用, 以 Json 格式输出 kufl 的头文件
-no-checksum	不进行 checksum 检查
-timezone timezone	设置 kufl TIME 时区
-sizes	显示 kufl 的大小信息及其每个事务中的行数
-sizesdetail	显示 kufl 的大小信息及其每个事务中的行数及其更多细节

6.3.1.3 使用方法
kufl -low 100 -high 200 list -timezone GMT+08 -charset UTF-8, 查看 SEQ 号 100 到 200 的 kufl
信息, 时区设为 +8 时区, 字符编码格式为 UTF-8
kufl list -seqno 8 -headers -json 查看序号为 8 的 SEQ 头文件, json 格式
kufl -file kufl.data.0000000001 list 指定 kufl 文件显示 kufl 列表
6.3.2 index
6.3.2.1 作用
查看所有 kufl 文件的列表和存储 SEQ 号范围
48 第 6 章 运维和监控
Kingbase FlySync 命令行工具参考手册
6.3.2.2 选项

名称	含义
-no-checksum	统计时忽略损坏的 kufl 事务

6.3.2.3 使用方法
kufl index -no-checksum
6.3.3 purge
6.3.3.1 作用
删除指定 SEQ 号范围内的 kufl 信息
6.3.3.2 选项

名称	含义
-low|-from	指定 SEQ 号的开始
-high|-to	指定 SEQ 号的结束
-no-checksum	统计时忽略损坏的 kufl 事务
-y	忽略检查
-first	第一条 kufl
-last	最后一条 kufl

6.3.3.3 使用方法
kufl -low 100 -high 200 purge, 删除 SEQ 号 100 到 200 的 kufl 信息
kufl -last -y -no-checksum purge, 删除最后一条 kufl 的信息
6.3.4 info
6.3.4.1 作用
查看 kufl 当前信息, 包括日志目录,SEQ 号范围, 事务数等
6.3. kufl 49
Kingbase FlySync 命令行工具参考手册
6.3.4.2 选项

名称	含义
-no-checksum	统计时忽略损坏的 kufl 事务

6.3.4.3 使用方法
kufl info -no-checksum
50 第 6 章 运维和监控
第 7 章
其他工具
7.1 query
query 命令是连接数据库执行 SQL 的命令工具
7.1.1 主要参数说明

参数名称	参数含义
-conf path	数据量连接的配置文件
-file path	需要运行 SQL 命令的文件
-password p	数据库密码
-url jdbcurl	数据库 JDBCURL
-user user	数据库用户名

51
Kingbase FlySync 命令行工具参考手册
7.1.2 使用方法
执行命令行参数如下:
query -url jdbc:kingbase8://192.168.1.2:54326/TEST -user SYSTEM -password 123456 -
,→file execute.sql
query -conf database.conf -file execute.sql
配置文件示例:
user=SYSTEM
password=123456
url=jdbc:kingbase8://192.168.1.2:54326/TEST
7.2 repkeyclean
repkeyclean 命令是用来在表无主键的场景中, 通过增加过滤器的方式, 来达到能够尽可能的正常同步无主键
的表, 两种过滤器说明如下:
• custompkey, 有唯一索引或者可定位的数据的列作为主键, 生成 Json 数据存入过滤器中
• skipeventbytype, 无索引和可定位数据的列, 过滤掉同步 UPDATE 和 DELETE 操作
7.2.1 主要参数说明

参数名称	参数含义
-dbtype	数据库类型, 例: kingbase7、 kingbase8、 mysql、 mssql、 oracle
-host	数据库 IP
-port	数据库端口
-user	数据库用户名
-pass	数据库密码
-db	数据库数据库名称（ oracle 对应服务名称）
-pattern	指定数据库模式或者表名, 不能写多个模式例： PUBLIC.TEST | PUBLIC.*, 默 认 *.* , 指的是所有模式所有表

52 第 7 章 其他工具
Kingbase FlySync 命令行工具参考手册
7.2.2 使用方法
repkeyclean -dbtype kingbase8 -host 192.168.1.10 -port 54321 -user SYSTEM -pass 123456
-db TEST -pattern PUBLIC.*
对 KingbaseES V8 TEST 数据库中 PUBLIC 模式下的所有表无主键表过滤操作
7.2.3 特殊字符的处理
如果数据库的用户名，密码，库名，模式名，表名，列名中含有特殊字符导致执行 repkeyclean
命令报错，将出现的特殊字符使用转义即可
7.3 repswitch
repswitch 全称为 双轨并行命令工具, 在双轨并行同步方案里, 进行主从角色切换, 启停和显示同步集群
信息等
7.3.1 主要参数说明

参数名称	参数含义
-conf file	双轨并行配置文件信息, 具体信息如下

[node1]
rmi_host=192.168.11.35
rmi_port=12000
[node2]
rmi_host=192.168.11.35
rmi_port=12000
如果是 IPV6 的环境，配置文件需配置为如下格式
[node1]
rmi_host=[2001:250:250:250:250:250:250:222]
rmi_port=12000
[node2]
rmi_host=[2001:250:250:250:250:250:250:223]
rmi_port=12000
repswitch 的子命令如下
7.3. repswitch 53
Kingbase FlySync 命令行工具参考手册
7.3.2 show
7.3.2.1 作用
查看同步集群服务状态信息
7.3.2.2 使用方法
repswitch –conf switch.conf show
7.3.3 offline
7.3.3.1 作用
将所有节点状态置为 offline
7.3.3.2 使用方法
repswitch -conf switch.conf offline
7.3.4 online [node]
7.3.4.1 作用
指定节点将状态置为 online
7.3.4.2 使用方法
repswitch -conf switch.conf online node1
7.3.5 reset
7.3.5.1 作用
与命令 ‘fsrepctl -service serviceName reset -all -y‘ 一致, 删除集群所有服务的 kufl 信息, 数据库
创建的表和模式等
54 第 7 章 其他工具
Kingbase FlySync 命令行工具参考手册
7.3.5.2 使用方法
repswitch -conf switch.conf reset
7.3.6 switch
7.3.6.1 作用
切换主备机器操作
7.3.6.2 使用方法
repswitch -conf switch.conf switch
7.3. repswitch 55