KingbaseES物理备份恢复命令选项.pdf

KingbaseES 物理备份恢复命令选项 金仓数据库管理系统 KingbaseES 文档版本：V9（V009R001C001B0024） 发布日期：2023 年 10 月 12 日 北京人大金仓信息技术股份有限公司 目 目 录 录 第 1 章 前言 2 1.1 适用读者 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.2 相关文档 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.3 术语 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4 手册约定 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 第 2 章 概述 6 第 3 章 archive-get 命令 8 3.1 3.2 3.3 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.1.1 --archive-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.2.2 --cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.2.3 --cmd-ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.2.4 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.2.5 --db-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.2.6 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.2.7 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.2.8 --process-max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.2.9 --protocol-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.2.10 --sck-keep-alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 3.2.11 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 3.2.12 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 3.2.13 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 3.2.14 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 3.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 3.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 3.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 I 目 录 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.4.1 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.4.3 --repo-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.4.4 --repo-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.4.5 --repo-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.4.6 --repo-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.4.7 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Stanza 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.5.1 --kb-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.5.2 --kb-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.3.5 3.4 3.5 第 4 章 archive-push 命令 4.1 4.2 4.3 4.4 16 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 4.1.1 --archive-header-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 4.1.2 --archive-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 4.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 4.2.2 --cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 4.2.3 --cmd-ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 4.2.4 --compress-level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 4.2.5 --compress-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4.2.6 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4.2.7 --db-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4.2.8 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4.2.9 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.2.10 --process-max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.2.11 --protocol-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.2.12 --sck-keep-alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.2.13 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.2.14 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.2.15 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.2.16 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 4.4.1 22 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . II 4.5 目 录 4.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 4.4.3 --repo-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 4.4.4 --repo-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 4.4.5 --repo-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 4.4.6 --repo-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 4.4.7 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Stanza 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 4.5.1 --kb-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 4.5.2 --kb-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 第 5 章 backup 命令 5.1 5.2 24 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 5.1.1 --archive-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 5.1.2 --archive-copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 5.1.3 --archive-mode-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 5.1.4 --archive-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 5.1.5 --backup-from . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 5.1.6 --backup-standby . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 5.1.7 --band-width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 5.1.8 --checksum-page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 5.1.9 --expire-auto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 5.1.10 --non-archived-space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 5.1.11 --resume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 5.1.12 --start-fast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 5.1.13 --type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 5.1.14 --alert-command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 5.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 5.2.2 --cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 5.2.3 --cmd-ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 5.2.4 --compress-level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 5.2.5 --compress-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 5.2.6 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 5.2.7 --db-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 5.2.8 --delta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 5.2.9 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 5.2.10 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 5.2.11 --process-max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 5.2.12 --protocol-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 5.2.13 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 5.2.14 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 5.2.15 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 III 5.3 5.4 5.5 目 录 5.2.16 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 5.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 5.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 5.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 5.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 5.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 5.4.1 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 5.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 5.4.3 --repo-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 5.4.4 --repo-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 5.4.5 --repo-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 5.4.6 --repo-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 5.4.7 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 5.4.8 --repo-retention-diff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 5.4.9 --repo-retention-full . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 5.4.10 --repo-retention-history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Stanza 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 5.5.1 --kb-database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 5.5.2 --kb-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 5.5.3 --kb-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 5.5.4 --kb-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 5.5.5 --kb-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 5.5.6 --kb-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 5.5.7 --kb-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 5.5.8 --kb-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 5.5.9 --kb-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 第 6 章 check 命令 6.1 6.2 37 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 6.1.1 --archive-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 6.1.2 --archive-mode-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 6.1.3 --archive-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 6.1.4 --backup-standby . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 6.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 6.2.2 --cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 6.2.3 --cmd-ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 6.2.4 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 6.2.5 --db-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 6.2.6 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 IV 6.3 6.4 6.5 目 录 6.2.7 --protocol-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 6.2.8 --sck-keep-alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 6.2.9 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 6.2.10 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 6.2.11 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 6.2.12 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 6.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 6.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 6.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 6.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 6.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 6.4.1 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 6.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 6.4.3 --repo-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 6.4.4 --repo-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 6.4.5 --repo-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 6.4.6 --repo-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 6.4.7 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Stanza 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 6.5.1 --kb-database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 6.5.2 --kb-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 6.5.3 --kb-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 6.5.4 --kb-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 6.5.5 --kb-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 6.5.6 --kb-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 6.5.7 --kb-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 6.5.8 --kb-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 6.5.9 --kb-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 第 7 章 expire 命令 7.1 7.2 46 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 7.1.1 --set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 7.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 7.2.2 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 7.2.3 --dry-run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 7.2.4 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 7.2.5 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 7.2.6 --sck-keep-alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 7.2.7 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 V 7.3 7.4 目 录 7.2.8 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 7.2.9 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 7.2.10 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 7.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 7.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 7.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 7.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 7.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 7.4.1 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 7.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 7.4.3 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 7.4.4 --repo-retention-diff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 7.4.5 --repo-retention-full . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 7.4.6 --repo-retention-history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 第 8 章 help 命令 52 第 9 章 info 命令 53 9.1 9.2 9.3 9.4 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 9.1.1 --output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 9.1.2 --set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 9.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 9.2.2 --cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 9.2.3 --cmd-ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 9.2.4 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 9.2.5 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 9.2.6 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 9.2.7 --protocol-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 9.2.8 --sck-keep-alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 9.2.9 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 9.2.10 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 9.2.11 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 9.2.12 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 9.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 9.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 9.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 9.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 9.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 VI 目 录 9.4.1 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 9.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 9.4.3 --repo-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 9.4.4 --repo-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 9.4.5 --repo-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 9.4.6 --repo-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 9.4.7 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 第 10 章 restore 命令 60 10.1 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 10.1.1 --archive-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 10.1.2 --force . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 10.1.3 --link-all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 10.1.4 --link-map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 10.1.5 --set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 10.1.6 --tablespace-map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 10.1.7 --tablespace-map-all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 10.1.8 --target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 10.1.9 --target-action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 10.1.10 --target-exclusive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 10.1.11 --target-timeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 10.1.12 --type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 10.2 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 10.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 10.2.2 --cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 10.2.3 --cmd-ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 10.2.4 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 10.2.5 --delta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 10.2.6 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 10.2.7 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 10.2.8 --process-max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 10.2.9 --protocol-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 10.2.10 --sck-keep-alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 10.2.11 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 10.2.12 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 10.2.13 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 10.2.14 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 10.3 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 10.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 10.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 10.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 10.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 VII 目 录 10.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 10.4 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 10.4.1 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 10.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 10.4.3 --repo-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 10.4.4 --repo-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 10.4.5 --repo-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 10.4.6 --repo-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 10.4.7 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 10.5 Stanza 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 10.5.1 --kb-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 10.5.2 --kb-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 第 11 章 stanza-create 命令 70 11.1 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 11.1.1 --backup-standby . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 11.2 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 11.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 11.2.2 --cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 11.2.3 --cmd-ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 11.2.4 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 11.2.5 --db-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 11.2.6 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 11.2.7 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 11.2.8 --protocol-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 11.2.9 --sck-keep-alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 11.2.10 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 11.2.11 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 11.2.12 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 11.2.13 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 11.3 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 11.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 11.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 11.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 11.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 11.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 11.4 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 11.4.1 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 11.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 11.4.3 --repo-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 11.4.4 --repo-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 11.4.5 --repo-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 VIII 目 录 11.4.6 --repo-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 11.4.7 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 11.5 Stanza 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 11.5.1 --kb-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 11.5.2 --kb-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 11.5.3 --kb-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 11.5.4 --kb-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 11.5.5 --kb-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 11.5.6 --kb-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 11.5.7 --kb-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 11.5.8 --kb-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 第 12 章 stanza-delete 命令 79 12.1 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 12.1.1 --force . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 12.2 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 12.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 12.2.2 --cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 12.2.3 --cmd-ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 12.2.4 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 12.2.5 --db-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 12.2.6 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 12.2.7 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 12.2.8 --protocol-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 12.2.9 --sck-keep-alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 12.2.10 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 12.2.11 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 12.2.12 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 12.2.13 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 12.3 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 12.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 12.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 12.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 12.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 12.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 12.4 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 12.4.1 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 12.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 12.4.3 --repo-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 12.4.4 --repo-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 12.4.5 --repo-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 12.4.6 --repo-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 IX 目 录 12.4.7 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 12.5 Stanza 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 12.5.1 --kb-database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 12.5.2 --kb-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 12.5.3 --kb-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 12.5.4 --kb-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 12.5.5 --kb-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 12.5.6 --kb-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 12.5.7 --kb-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 12.5.8 --kb-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 12.5.9 --kb-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 第 13 章 stanza-upgrade 命令 88 13.1 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 13.1.1 --backup-standby . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 13.2 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 13.2.1 --buffer-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 13.2.2 --cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 13.2.3 --cmd-ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 13.2.4 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 13.2.5 --db-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 13.2.6 --io-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 13.2.7 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 13.2.8 --protocol-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 13.2.9 --sck-keep-alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 13.2.10 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 13.2.11 --tcp-keep-alive-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 13.2.12 --tcp-keep-alive-idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 13.2.13 --tcp-keep-alive-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 13.3 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 13.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 13.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 13.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 13.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 13.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 13.4 Repository 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 13.4.1 --repo-cipher-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 13.4.2 --repo-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 13.4.3 --repo-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 13.4.4 --repo-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 13.4.5 --repo-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 13.4.6 --repo-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 X 目 录 13.4.7 --repo-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 13.5 Stanza 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 13.5.1 --kb-database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 13.5.2 --kb-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 13.5.3 --kb-host-cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 13.5.4 --kb-host-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 13.5.5 --kb-host-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 13.5.6 --kb-host-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 13.5.7 --kb-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 13.5.8 --kb-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 13.5.9 --kb-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 第 14 章 start 命令 97 14.1 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 14.1.1 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 14.1.2 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 14.1.3 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 14.2 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 14.2.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 14.2.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 14.2.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 14.2.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 14.2.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 第 15 章 stop 命令 100 15.1 Command 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 15.1.1 --force . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 15.2 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 15.2.1 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 15.2.2 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 15.2.3 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 15.3 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 15.3.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 15.3.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 15.3.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 15.3.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 15.3.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 第 16 章 verify 命令 103 16.1 General 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 16.1.1 --config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 16.1.2 --lock-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 16.1.3 --stanza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 XI 目 录 16.2 Log 选项 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 16.2.1 --log-level-console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 16.2.2 --log-level-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 16.2.3 --log-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 16.2.4 --log-subprocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 16.2.5 --log-timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 第 17 章 version 命令 106 版权声明 107 服务周期承诺 108 XII 目 录 本文档为 sys_rman 工具的命令选项。 1 第 1 章 前言 1 第 章 前言 本文档描述了 KingbaseES 物理备份与恢复 (sys_rman 工具) 的命令选项。 前言部分包含以下主题： • 适用读者 • 相关文档 • 术语 • 手册约定 1.1 适用读者 KinbaseES 物理备份工具手册适用于所有使用 KingbaseES 的数据库管理员 (DBAs)，应用程序开发者，安全管 理员，系统运维或管理人员。 1.2 相关文档 有关 KingbaseES 物理备份还原工具手册关联技术的更多信息，请参阅以下资源： • 《高可用概述》 • 《KingbaseES 高可用常见故障恢复指南》 • 《KingbaseES 备份与恢复工具手册》 1.3 术语 2 第 1 章 前言 术语 定义 物理备份 physical backup，指对数据库数据文件和日志文件的复制，从一个物理位置拷贝到另一个物理 位置，基于操作系统下的物理文件为单位进行。 逻辑备份 logical backup，指在联机状态下导出或导入数据库中用户创建的数据库对象信息，包含表、视 图、数据、存储过程等，以 SQL 语句为基础进行。 预写式日志 Write Ahead Log，WAL 日志，KingbaseES 对数据库理论中 REDO 概念的实现。 检查点 CheckPoint 检查点是 KingbaseES 事务序列中的点，数据库系统将保证该点之前的所有 WAL 日志对应的内容都更新到数据文件中。 表空间 表空间允许数据库管理员在文件系统中定义用来存放数据库对象的文件位置；表空间中的数据 对象将实际存储于指定的位置，与默认的数据对象存储位置不同。 时间点恢复 Point-In-Time-Recover，时间点恢复，KingbaseES 支持使用物理备份加连续归档的 WAL 日 志，将数据库恢复到指定时间点。 备份集 backup set，指一次备份的所有备份内容的集合。 全量备份 full backup. 针对所有需要的文件进行的一次备份。当还原时，不需要额外的依赖，通过此备 份集即可还原数据文件到备份时的状态。 差异备份 differential backup, 属于选择性备份，仅选择上一次全量备份后，发生了变化的文件。优点是 节省了一定的空间，相比于全量备份。缺点是还原时，需要本次差异备份集及其依赖的全量备 份集。 增量备份 file incremental backup，属于选择性备份，仅选择上一次全量或差异或增量备份后，发生了变 化的文件。优点是更加地节省空间。缺点是还原时，需要本次增量备份集以及前次备份集、再 前次备份集、直到串行依赖到一次全量备份集。 块增量备份 page incremental backup，属于选择性备份，在上一次全量或差异或增量备份后时间线未发生 改变的情况下，仅选择上一次全量或差异或增量备份后，发生了变化的表文件的数据块和其他 发生了变化的非表文件。优点是更加地节省空间。缺点是还原时，需要本次块增量备份集以及 前次备份集、再前次备份集、直到串行依赖到一次全量备份集；并且依赖 ktrack 插件。 Stanza 是一个字符串标签，用来具名化若干备份还原信息；是一个定义备份还原所需信息的包裹，是 一个包含若干个配置参数的集合。一般来说，stanza 的名称用来标识一个集群。 Tool 备份还原工具 sys_rman，在部署架构中表示工具逻辑上的角色。 Ktrack KingbaseES 数据库服务器的插件，用来持续追踪记录发生改变的表文件的数据块。 REPO 节点 仓库节点，实际存储备份文件的服务器节点，要求安装 KingbaseES 软件，详见如何搭建 REPO 节点章节。 见续表 3 第 1 章 前言 表 1.3.1 – 续表 术语 定义 DB 节点 数据库节点，实际运行数据库实例的服务器节点，要求运行 KingbaseES 软件；根据场景需 要，DB 节点可以兼任 REPO 节点。 REPO_PATH 仓库节点的实际存储备份的文件夹。 KB_DATA 数据库节点的 data 目录。 1.4 手册约定 本文档中可能出现“注意、提示、警告、另请参阅”等标志，它们所代表的含义如下： 注意: 用于突出重要/关键信息、最佳实践等。 提示: 用于突出小窍门、捷径等。 警告: 用于传递设备或环境安全警示信息，若不避免，可能会导致设备损坏、数据丢失、设备性能降低或其 它不可预知的结果。 另请参阅: 用于突出参考、参阅等。 以下程序代码书写约定适用于本文档： 符号 说明 [] 表示包含一个或多个可选项。不需要输入中括号本身。 {} 表示包含两个以上（含两个）的候选，必须在其中选取一个。不需要输入花括号本身。 | 分割中括号或者花括号中的两个或两个以上选项。不需要输入“|”本身。 ... 表示其之前的元素可以被重复。 斜体 表示占位符或者需要提供特定值的变量。 见续表 4 第 1 章 前言 表 1.4.1 – 续表 符号 说明 大写 表示系统提供的元素，以便与用户定义的元素相互区分。除出现在方括号中的元素外，应当按 照顺序逐字输入。当然，部分元素在系统中是大小写不敏感的，因此用户可以根据系统说明以 小写形式输入。 小写 表示由用户提供的元素。 5 第 2 章 概述 2 第 章 概述 sys_rman 工具包含若干命令，每个命令完成独立的功能。每个命令支持若干的选项，参考手册详细描述所有的 选项。 基本格式如下： sys_rman --option1=aaa --option2=bbb 命令行指定的选项在本次运行过程中覆盖配置文件中的设定值，但不实际修改配置文件。 布尔型的选项，在命令行中支持使用 no- 前缀来指定相应的否定选项。 命令 简介 使用范围 archive-get 在 KingbaseES 恢复阶段，数据库进程调用；一般位于 king- DB 节点 base.auto.conf 配置文件中 archive-push 在 KingbaseES 运行阶段，数据库进程调用；位于数据库配置选项 DB 节点 archive-command 中 backup 执行物理备份 REPO 节点 check 对 sys_rman 配置文件和数据库环境进行检查 REPO 节点 expire 清理过期的备份集 REPO 节点 help 查看帮助信息 DB 节点和 REPO 节点 info 查看备份集的列表 DB 节点和 REPO 节点 restore 执行物理还原 DB 节点 stanza-create 创建数据库对象的备份配置环境 REPO 节点 stanza-delete 删除数据库对象的备份配置环境 REPO 节点 见续表 6 第 2 章 概述 表 2.1 – 续表 命令 简介 使用范围 stanza-upgrade 更新数据库对象的备份配置环境 REPO 节点 start 去除停止标识 REPO 节点 stop 设置停止标识 REPO 节点 verify 查看备份集的文件存储情况 REPO 节点 version 查看工具的版本 DB 节点和 REPO 节点 7 第 3 章 ARCHIVE-GET 命令 3 第 章 archive-get 命令 archive-get 命令用于将归档的 WAL 文件从 REPO 目录拷贝到数据库实例的 DATA 目录下。 该命令由 KingbaseES 实例在恢复期间调用，通过 kingbase.auto.conf 配置文件中的 restore_comand 命令来配 置。 不推荐手动执行。 3.1 Command 选项 3.1.1 --archive-timeout 单个 WAL 文件传输的超时时间，以秒为单位。 此超时时间将应用于 archive-get、archive-push、check、backup 命令中。 默认值：60 允许范围：0.1 - 86400 举例：--archive-timeout=30 3.2 General 选项 3.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 8 第 3 章 ARCHIVE-GET 命令 默认值：1MiB 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 3.2.2 --cmd 指定 sys_rman 命令的全路径位置，或者指向外部包装脚本。 例如，在 kingbase 恢复的过程中，restore_command 中使用 archive-get 命令时，可以使用外部包装脚本。 NOTE: 包装脚本具有一定的不确定性，不推荐使用。 举例：--cmd=/var/lib/pgsql/bin/sys_rman_wrapper.sh 3.2.3 --cmd-ssh 指定 ssh 客户端的二进制文件位置。 默认: ssh 举例: --cmd-ssh=/usr/bin/ssh 3.2.4 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 3.2.5 --db-timeout database 单个操作命令的超时时间，以秒为单位。 此超时时间应用于 sys_rman 工具对数据库进行的各种操作，包含 sys_start_backup 和 sys_stop_backup 等需 要一定时间的操作。所以，超时时间应该设置为适当的时间。 NOTE： db-timeout 的时间应该短于 protocol-timeout 的时间。 默认: 1800 允许范围: 0.1-604800 9 第 3 章 ARCHIVE-GET 命令 举例：--db-timeout=600 3.2.6 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 允许范围: 0.1-3600 举例: --io-timeout=120 3.2.7 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 3.2.8 --process-max 并发运行的最大进程数。 应用于拷贝文件、压缩等核心过程。 适当的设置可以提高备份或还原的效率，太高的设置会影响数据库实例本身的性能。 建议以 CPU 内核数设置最大进程数。 默认: 1 可选范围: 1-999 举例: --process-max=4 3.2.9 --protocol-timeout sys_rman 协议超时时间，应用于 sys_rman 进程之间通讯协议，包含本地和远程进程。 NOTE：protocol-timeout 应该大于 db-timeout 的时间。 默认: 1830 10 第 3 章 ARCHIVE-GET 命令 允许范围: 0.1-604800 举例: --protocol-timeout=630 3.2.10 --sck-keep-alive Socket 心跳机制，允许在 socket 连接上启动心跳机制。 默认: y 举例: --no-sck-keep-alive 3.2.11 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 3.2.12 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 3.2.13 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 3.2.14 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 11 第 3 章 ARCHIVE-GET 命令 3.3 Log 选项 3.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 3.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 12 第 3 章 ARCHIVE-GET 命令 3.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 3.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 3.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 3.4 Repository 选项 3.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 3.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 13 第 3 章 ARCHIVE-GET 命令 举例: --repo1-host=repo1.domain.com 3.4.3 --repo-host-cmd 设置 REPO 节点上 sys_rman 工具的全路径位置。 推荐在 REPO 节点和 DB 节点，sys_rman 位于相同的路径之下；如果不一样，可以通过此选项来设置不同的工 具位置。 举例: --repo1-host-cmd=/usr/lib/backrest/bin/sys_rman 3.4.4 --repo-host-config 设置 REPO 节点上的配置文件的全路径位置。 推荐在 REPO 节点和 DB 节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配 置文件。 举例: --repo1-host-config=/conf/sys_rman/sys_rman.conf 3.4.5 --repo-host-port 设置 REPO 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --repo1-host-port=25 3.4.6 --repo-host-user 设置 REPO 节点的操作系统用户名。 举例: --repo1-host-user=repo-user 3.4.7 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 14 第 3 章 ARCHIVE-GET 命令 3.5 Stanza 选项 3.5.1 --kb-host 设置 DB 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 DB 节点和 REPO 节点之间，预先建立好 SSH 免密登录。 举例: --kb1-host=db1.domain.com 3.5.2 --kb-path 设置 DB 节点的 data 全路径，要求设置全路径地址，不使用相对路径。 举例: --kb1-path=/data/db 15 第4章 4 第 章 ARCHIVE-PUSH 命令 archive-push 命令 archive-push 命令用于将 DATA 目录下的 WAL 文件归档到 REPO 目录下。 该命令应该配置在 KingbaseES 的配置文件中，构成 archive-command 命令，其调用时机由 KingbaseES 内核控 制。 不推荐手动执行。 4.1 Command 选项 4.1.1 --archive-header-check 开启在归档 WAL 时，对 WAL 日志的 KingbaseES version/system-id 进行检查。 默认: y 举例: --no-archive-header-check 4.1.2 --archive-timeout 单个 WAL 文件传输的超时时间，以秒为单位。 此超时时间将应用于 archive-get、archive-push、check、backup 命令中。 默认值：60 允许范围：0.1 - 86400 举例：--archive-timeout=30 16 第4章 ARCHIVE-PUSH 命令 4.2 General 选项 4.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 默认值：1MiB 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 4.2.2 --cmd 指定 sys_rman 命令的全路径位置，或者指向外部包装脚本。 例如，在 kingbase 恢复的过程中，restore_command 中使用 archive-get 命令时，可以使用外部包装脚本。 NOTE: 包装脚本具有一定的不确定性，不推荐使用。 举例：--cmd=/var/lib/pgsql/bin/sys_rman_wrapper.sh 4.2.3 --cmd-ssh 指定 ssh 客户端的二进制文件位置。 默认: ssh 举例: --cmd-ssh=/usr/bin/ssh 4.2.4 --compress-level 设置压缩级别；数字越高，压缩度越高，节约空间，消耗时间；数字越低，压缩度越低，消耗空间，节约时间。 仅在--compress-type=gz 时，有效。 默认：6 允许范围: 0-9 举例: --compress-level=9 17 第4章 ARCHIVE-PUSH 命令 4.2.5 --compress-type 设置压缩类型，目前支持 none 和 gz。 none 表示不压缩 gz 表示使用 gzip 压缩格式 默认: gz 举例: --compress-type=none 4.2.6 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 4.2.7 --db-timeout database 单个操作命令的超时时间，以秒为单位。 此超时时间应用于 sys_rman 工具对数据库进行的各种操作，包含 sys_start_backup 和 sys_stop_backup 等需 要一定时间的操作。所以，超时时间应该设置为适当的时间。 NOTE： db-timeout 的时间应该短于 protocol-timeout 的时间。 默认: 1800 允许范围: 0.1-604800 举例：--db-timeout=600 4.2.8 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 允许范围: 0.1-3600 举例: --io-timeout=120 18 第4章 ARCHIVE-PUSH 命令 4.2.9 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 4.2.10 --process-max 并发运行的最大进程数。 应用于拷贝文件、压缩等核心过程。 适当的设置可以提高备份或还原的效率，太高的设置会影响数据库实例本身的性能。 建议以 CPU 内核数设置最大进程数。 默认: 1 可选范围: 1-999 举例: --process-max=4 4.2.11 --protocol-timeout sys_rman 协议超时时间，应用于 sys_rman 进程之间通讯协议，包含本地和远程进程。 NOTE：protocol-timeout 应该大于 db-timeout 的时间。 默认: 1830 允许范围: 0.1-604800 举例: --protocol-timeout=630 4.2.12 --sck-keep-alive Socket 心跳机制，允许在 socket 连接上启动心跳机制。 默认: y 举例: --no-sck-keep-alive 19 第4章 ARCHIVE-PUSH 命令 4.2.13 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 4.2.14 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 4.2.15 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 4.2.16 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 4.3 Log 选项 4.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 20 第4章 ARCHIVE-PUSH 命令 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 4.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 4.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 4.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 21 第4章 ARCHIVE-PUSH 命令 4.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 4.4 Repository 选项 4.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 4.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 举例: --repo1-host=repo1.domain.com 4.4.3 --repo-host-cmd 设置 REPO 节点上 sys_rman 工具的全路径位置。 推荐在 REPO 节点和 DB 节点，sys_rman 位于相同的路径之下；如果不一样，可以通过此选项来设置。 举例: --repo1-host-cmd=/usr/lib/backrest/bin/sys_rman 4.4.4 --repo-host-config 设置 REPO 节点上的配置文件的全路径位置。 推荐在 REPO 节点和 DB 节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配 置文件。 22 第4章 ARCHIVE-PUSH 命令 举例: --repo1-host-config=/conf/sys_rman/sys_rman.conf 4.4.5 --repo-host-port 设置 REPO 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --repo1-host-port=25 4.4.6 --repo-host-user 设置 REPO 节点的操作系统用户名。 举例: --repo1-host-user=repo-user 4.4.7 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 4.5 Stanza 选项 4.5.1 --kb-host 设置 DB 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 DB 节点和 REPO 节点之间，预先建立好 SSH 免密登录。 举例: --kb1-host=db1.domain.com 4.5.2 --kb-path 设置 DB 节点的 data 全路径，要求设置全路径地址，不使用相对路径。 举例: --kb1-path=/data/db 23 第 5 章 BACKUP 命令 5 第 章 backup 命令 backup 命令用于开始一次物理备份。 sys_rman 工具没有内置的定时任务备份机制，需要通过系统的 CRON 或者其他机制来完成定时任务。 5.1 Command 选项 5.1.1 --archive-check 开启归档 WAL 检查。 开启后，工具在备份过程中将确保 WAL 文件已经归档到 REPO 的 archive 目录下。 强烈推荐开启，确保备份集支持 PITR 功能。 默认: y 举例: --no-archive-check 5.1.2 --archive-copy 开启拷贝 WAL 到备份集。 开启后，工具将拷贝备份过程中的 WAL 文件到 REPO 的 backup 目录下；这将保证备份集自身包含备份期间的 WAL 日志。 推荐在备份时间段具有大量业务开展的系统开启拷贝选项。 默认: n 举例: --archive-copy 24 第 5 章 BACKUP 命令 5.1.3 --archive-mode-check 开启对 KingbaseES 数据库实例的 archive_mode 的检查。 开启后，工具将对 archive_mode=always 的实例报错退出，不进行备份。 如果关闭此检查，请确保主机备机针对同一个 WAL 文件，只有一份 WAL 归档到 REPO 的 archive 目录。 默认: y 举例: --no-archive-mode-check 5.1.4 --archive-timeout 单个 WAL 文件传输的超时时间，以秒为单位。 此超时时间将应用于 archive-get、archive-push、check、backup 命令中。 默认值：60 允许范围：0.1 - 86400 举例：--archive-timeout=30 5.1.5 --backup-from 指定备份数据文件的来源 可选范围，auto / single-pro auto : 优先寻找主机，然后寻找备机 single-pro：强制寻找当前节点 默认：auto 举例：--backup-from=single-pro 5.1.6 --backup-standby 开启从备机拷贝数据文件的功能。 开启后，主备集群环境中，备份时将从备机拷贝数据文件，减少对主机性能的影响。 默认: n 举例: --backup-standby 25 第 5 章 BACKUP 命令 5.1.7 --band-width 开启对备份过程的限速 单位固定为 MB/s ，0 表示不限速 可选范围：0 ~ 9999 默认：0 举例: --band-width=10 5.1.8 --checksum-page 开启对 KingbaseES 数据文件中的数据块进行校验和检查。 当 KingbaseES 数据库开启数据块校验和时，工具自动开启检查。 NOTE： 如果检查失败，并不终止备份过程，日志输出告警，备份集记录告警。 默认：y 举例: --no-checksum-page 5.1.9 --expire-auto 开启附加的备份完成后清理过期备份集。 开启后，在一次备份动作完成后自动清理过期的备份集，根据设置的保留数目。 默认: y 举例: --no-expire-auto 5.1.10 --non-archived-space 指定备份前预先检查未归档 WAL 日志的阈值。 超过此阈值，备份前给出警告 WARN 日志； 不超过阈值，备份去给出信息 INFO 日志。 单位固定为 MB 可选范围 128 ~ 1024 默认：1024 举例：--non-archive-space=128 26 第 5 章 BACKUP 命令 5.1.11 --resume 开启延续前一次备份中断失败的备份集的功能。 开启后，本次备份将延续前一次残留的备份集。 默认: y 举例: --no-resume 5.1.12 --start-fast 开启快速启动备份的功能。 开启后，备份开始阶段将强制生成一个 CheckPoint； 不开启，备份将等待一个常规 CheckPoint。 默认: n 举例: --start-fast 5.1.13 --type 指定备份的类型。 支持以下类型： full 全量备份，不依赖已有备份集； diff 差异备份，依赖前一个全量备份集； incr 增量备份，依赖前一个备份集； page 块增量备份，依赖前一个备份集。 默认: incr 举例: --type=full 5.1.14 --alert-command 备份结束时针对无效页执行自定义命令，如回显或记录信息，或发送告警邮件等。 27 第 5 章 BACKUP 命令 5.2 General 选项 5.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 默认值：1MiB 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 5.2.2 --cmd 指定 sys_rman 命令的全路径位置，或者指向外部包装脚本。 例如，在 kingbase 恢复的过程中，restore_command 中使用 archive-get 命令时，可以使用外部包装脚本。 NOTE: 包装脚本具有一定的不确定性，不推荐使用。 举例：--cmd=/var/lib/pgsql/bin/sys_rman_wrapper.sh 5.2.3 --cmd-ssh 指定 ssh 客户端的二进制文件位置。 默认: ssh 举例: --cmd-ssh=/usr/bin/ssh 5.2.4 --compress-level 设置压缩级别；数字越高，压缩度越高，节约空间，消耗时间；数字越低，压缩度越低，消耗空间，节约时间。 仅在--compress-type=gz 时，有效。 默认：6 允许范围: 0-9 举例: --compress-level=9 28 第 5 章 BACKUP 命令 5.2.5 --compress-type 设置压缩类型，目前支持 none 和 gz。 none 表示不压缩 gz 表示使用 gzip 压缩格式 默认: gz 举例: --compress-type=none 5.2.6 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 5.2.7 --db-timeout database 单个操作命令的超时时间，以秒为单位。 此超时时间应用于 sys_rman 工具对数据库进行的各种操作，包含 sys_start_backup 和 sys_stop_backup 等需 要一定时间的操作。所以，超时时间应该设置为适当的时间。 NOTE： db-timeout 的时间应该短于 protocol-timeout 的时间。 默认: 1800 允许范围: 0.1-604800 举例：--db-timeout=600 5.2.8 --delta 开启通过目标文件的 checksum 来判断是否拷贝。 开启后，备份时根据文件的 checksum 来判断是否拷贝文件； 开启后，还原时根据文件的 checksum 来判断是否覆盖文件。 默认: n 举例: --delta 29 第 5 章 BACKUP 命令 5.2.9 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 允许范围: 0.1-3600 举例: --io-timeout=120 5.2.10 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 5.2.11 --process-max 并发运行的最大进程数。 应用于拷贝文件、压缩等核心过程。 适当的设置可以提高备份或还原的效率，太高的设置会影响数据库实例本身的性能。 建议以 CPU 内核数设置最大进程数。 默认: 1 可选范围: 1-999 举例: --process-max=4 5.2.12 --protocol-timeout sys_rman 协议超时时间，应用于 sys_rman 进程之间通讯协议，包含本地和远程进程。 NOTE：protocol-timeout 应该大于 db-timeout 的时间。 默认: 1830 允许范围: 0.1-604800 举例: --protocol-timeout=630 30 第 5 章 BACKUP 命令 5.2.13 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 5.2.14 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 5.2.15 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 5.2.16 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 5.3 Log 选项 5.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 31 第 5 章 BACKUP 命令 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 5.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 5.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 5.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 32 第 5 章 BACKUP 命令 5.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 5.4 Repository 选项 5.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 5.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 举例: --repo1-host=repo1.domain.com 5.4.3 --repo-host-cmd 设置 REPO 节点上 sys_rman 工具的全路径位置。 推荐在 REPO 节点和 DB 节点，sys_rman 位于相同的路径之下；如果不一样，可以通过此选项来设置。 举例: --repo1-host-cmd=/usr/lib/backrest/bin/sys_rman 5.4.4 --repo-host-config 设置 REPO 节点上的配置文件的全路径位置。 推荐在 REPO 节点和 DB 节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配 置文件。 33 第 5 章 BACKUP 命令 举例: --repo1-host-config=/conf/sys_rman/sys_rman.conf 5.4.5 --repo-host-port 设置 REPO 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --repo1-host-port=25 5.4.6 --repo-host-user 设置 REPO 节点的操作系统用户名。 举例: --repo1-host-user=repo-user 5.4.7 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 5.4.8 --repo-retention-diff 设置保留历史差异备份集的数量。 在 expire 命令执行时，超过此数量的差异备份集将被清理。 允许范围: 1-9999999 举例: --repo1-retention-diff=3 5.4.9 --repo-retention-full 设置保留历史全量备份集的数量。 在 expire 命令执行时，超过此数量的全量备份集将被清理。 允许范围: 1-9999999 举例: --repo1-retention-full=3 34 第 5 章 BACKUP 命令 5.4.10 --repo-retention-history 设置备份集概要信息的保留天数。 备份集概要信息，不包含数据文件，仅包含备份集的重要标识和记录信息。 默认永久保留，单个备份集的概要信息小于 80K。 设置为 0，表示仅保留为过期的备份集。 设置为天数，清理已经过期的且备份时间超过了天数的备份集概要信息。 允许范围: 0-9999999 举例: --repo1-retention-history=365 5.5 Stanza 选项 5.5.1 --kb-database 设置 KingbaseES 实例的默认数据库名称。 默认: test 举例: --kb1-database=new_default_database 5.5.2 --kb-host 设置 DB 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 DB 节点和 REPO 节点之间，预先建立好 SSH 免密登录。 举例: --kb1-host=db1.domain.com 5.5.3 --kb-host-cmd 设置 DB 节点的 sys_rman 工具全路径。 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-cmd=/usr/bin/sys_rman 5.5.4 --kb-host-config 设置 DB 节点的 sys_rman 配置文件全路径。 35 第 5 章 BACKUP 命令 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-config=/sys_rman/sys_rman.conf 5.5.5 --kb-host-port 设置 DB 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --kb1-host-port=25 5.5.6 --kb-host-user 设置 DB 节点的操作系统用户名。 举例: --kb1-host-user=db-user 5.5.7 --kb-path 设置 DB 节点的 data 全路径，要求设置全路径地址，不使用相对路径。 举例: --kb1-path=/data/db 5.5.8 --kb-port 设置 DB 节点的 KingbaseES 实例工作端口。 默认: 54321 允许范围: 0-65535 举例: --kb1-port=65432 5.5.9 --kb-user 设置 DB 节点的 KingbaseES 数据库用户。 举例: --kb1-user=kingbase 36 第 6 章 CHECK 命令 6 第 章 check 命令 check 命令常用于实际备份之前检查环境和配置。 check 命令将执行 switch wal 并等待 WAL 文件归档到 REPO 目录下。 6.1 Command 选项 6.1.1 --archive-check 开启归档 WAL 检查。 开启后，工具在备份过程中将确保 WAL 文件已经归档到 REPO 目录下。 强烈推荐开启，确保备份集支持 PITR 功能。 默认: y 举例: --no-archive-check 6.1.2 --archive-mode-check 开启对 KingbaseES 数据库实例的 archive_mode 的检查。 开启后，工具将对 archive_mode=always 的实例报错退出，不进行备份。 如果关闭此检查，请确保主机备机针对同一个 WAL 文件，只有一份 WAL 归档到 REPO 的 archive 目录。 默认: y 举例: --no-archive-mode-check 6.1.3 --archive-timeout 单个 WAL 文件传输的超时时间，以秒为单位。 37 第 6 章 CHECK 命令 此超时时间将应用于 archive-get、archive-push、check、backup 命令中。 默认值：60 允许范围：0.1 - 86400 举例：--archive-timeout=30 6.1.4 --backup-standby 开启从备机拷贝数据文件的功能。 开启后，主备集群环境中，备份时将从备机拷贝数据文件，减少对主机性能的影响。 默认: n 举例: --backup-standby 6.2 General 选项 6.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 默认值：1MiB 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 6.2.2 --cmd 设置 sys_rman 命令的全路径位置，或者指向外部包装脚本。 例如，在 kingbase 恢复的过程中，restore_command 中使用 archive-get 命令时，可以使用外部包装脚本。 NOTE: 包装脚本具有一定的不确定性，不推荐使用。 举例：--cmd=/var/lib/pgsql/bin/sys_rman_wrapper.sh 38 第 6 章 CHECK 命令 6.2.3 --cmd-ssh 设置 ssh 客户端的二进制文件位置。 默认: ssh 举例: --cmd-ssh=/usr/bin/ssh 6.2.4 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 6.2.5 --db-timeout database 单个操作命令的超时时间，以秒为单位。 此超时时间应用于 sys_rman 工具对数据库进行的各种操作，包含 sys_start_backup 和 sys_stop_backup 等需 要一定时间的操作。所以，超时时间应该设置为适当的时间。 NOTE： db-timeout 的时间应该短于 protocol-timeout 的时间。 默认: 1800 允许范围: 0.1-604800 举例：--db-timeout=600 6.2.6 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 允许范围: 0.1-3600 举例: --io-timeout=120 39 第 6 章 CHECK 命令 6.2.7 --protocol-timeout sys_rman 协议超时时间，应用于 sys_rman 进程之间通讯协议，包含本地和远程进程。 NOTE：protocol-timeout 应该大于 db-timeout 的时间。 默认: 1830 允许范围: 0.1-604800 举例: --protocol-timeout=630 6.2.8 --sck-keep-alive Socket 心跳机制，允许在 socket 连接上启动心跳机制。 默认: y 举例: --no-sck-keep-alive 6.2.9 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseESKingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整 体，包含若干 DB 节点。 举例: --stanza=kingbase 6.2.10 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 6.2.11 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 40 第 6 章 CHECK 命令 6.2.12 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 6.3 Log 选项 6.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 6.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 41 第 6 章 CHECK 命令 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 6.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 6.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 6.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 6.4 Repository 选项 6.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 42 第 6 章 CHECK 命令 6.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 举例: --repo1-host=repo1.domain.com 6.4.3 --repo-host-cmd 设置 REPO 节点上 sys_rman 工具的全路径位置。 推荐在 REPO 节点和 DB 节点，sys_rman 位于相同的路径之下；如果不一样，可以通过此选项来设置。 举例: --repo1-host-cmd=/usr/lib/backrest/bin/sys_rman 6.4.4 --repo-host-config 设置 REPO 节点上的配置文件的全路径位置。 推荐在 REPO 节点和 DB 节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配 置文件。 举例: --repo1-host-config=/conf/sys_rman/sys_rman.conf 6.4.5 --repo-host-port 设置 REPO 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --repo1-host-port=25 6.4.6 --repo-host-user 设置 REPO 节点的操作系统用户名。 举例: --repo1-host-user=repo-user 6.4.7 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 43 第 6 章 CHECK 命令 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 6.5 Stanza 选项 6.5.1 --kb-database 设置 KingbaseES 实例的默认数据库名称。 默认: test 举例: --kb1-database=new_default_database 6.5.2 --kb-host 设置 DB 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 DB 节点和 REPO 节点之间，预先建立好 SSH 免密登录。 举例: --kb1-host=db1.domain.com 6.5.3 --kb-host-cmd 设置 DB 节点的 sys_rman 工具全路径。 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-cmd=/usr/bin/sys_rman 6.5.4 --kb-host-config 设置 DB 节点的 sys_rman 配置文件全路径。 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-config=/sys_rman/sys_rman.conf 6.5.5 --kb-host-port 设置 DB 节点的 SSH 端口。 默认：22 44 第 6 章 CHECK 命令 允许范围: 0-65535 举例: --kb1-host-port=25 6.5.6 --kb-host-user 设置 DB 节点的操作系统用户名。 举例: --kb1-host-user=db-user 6.5.7 --kb-path 设置 DB 节点的 data 全路径，要求设置全路径地址，不使用相对路径。 举例: --kb1-path=/data/db 6.5.8 --kb-port 设置 DB 节点的 KingbaseES 实例工作端口。 默认: 54321 允许范围: 0-65535 举例: --kb1-port=65432 6.5.9 --kb-user 设置 DB 节点的 KingbaseES 数据库用户。 举例: --kb1-user=kingbase 45 第 7 章 EXPIRE 命令 7 第 章 expire 命令 expire 命令用来清除已有的备份集。 默认情况下，每一次备份命令将隐含地触发一次 expire 动作。 7.1 Command 选项 7.1.1 --set 设置清除特定的备份集。 NOTE：备份集及其关联的备份集都将被清除。 举例: --set=20210131-153358F_20210131-153401I 7.2 General 选项 7.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 默认值：1MiB 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 46 第 7 章 EXPIRE 命令 7.2.2 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 7.2.3 --dry-run 开启清除备份集的模拟模式。 此模式不删除实际文件，仅用于测试清除命令。 默认: n 举例: --dry-run 7.2.4 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 允许范围: 0.1-3600 举例: --io-timeout=120 7.2.5 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 7.2.6 --sck-keep-alive Socket 心跳机制，允许在 socket 连接上启动心跳机制。 默认: y 举例: --no-sck-keep-alive 47 第 7 章 EXPIRE 命令 7.2.7 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 7.2.8 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 7.2.9 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 7.2.10 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 7.3 Log 选项 7.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 48 第 7 章 EXPIRE 命令 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 7.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 7.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 7.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 49 第 7 章 EXPIRE 命令 7.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 7.4 Repository 选项 7.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 7.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 举例: --repo1-host=repo1.domain.com 7.4.3 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 7.4.4 --repo-retention-diff 设置保留历史差异备份集的数量。 50 第 7 章 EXPIRE 命令 在 expire 命令执行时，超过此数量的差异备份集将被清理。 允许范围: 1-9999999 举例: --repo1-retention-diff=3 7.4.5 --repo-retention-full 设置保留历史全量备份集的数量。 在 expire 命令执行时，超过此数量的全量备份集将被清理。 允许范围: 1-9999999 举例: --repo1-retention-full=3 7.4.6 --repo-retention-history 设置备份集概要信息的保留天数。 备份集概要信息，不包含数据文件，仅包含备份集的重要标识和记录信息。 默认永久保留，单个备份集的概要信息小于 80K。 设置为 0，表示仅保留为过期的备份集。 设置为天数，清理已经过期的且备份时间超过了天数的备份集概要信息。 允许范围: 0-9999999 举例: --repo1-retention-history=365 51 第8章 HELP 命令 8 第 章 help 命令 工具提供了三个层次的帮助信息。 Ø sys_rman help 列举出工具的命令 Ø sys_rman help 列举出指定命令的所有选项 Ø sys_rman help 列举出指定命令的指定选项的详细信息 52 第 9 章 INFO 命令 9 第 章 info 命令 info 命令用来查看已有的备份集。 9.1 Command 选项 9.1.1 --output 指定查看命令的输出格式。 支持以下格式： text 直接阅读的格式 json 程序阅读的格式 默认: text 举例: --output=json 9.1.2 --set 指定查看命令关注的备份集。 默认情况下，查看命令列举出所有的备份集。 举例: --set=20150131-153358F_20150131-153401I 9.2 General 选项 9.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 53 第 9 章 INFO 命令 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 默认值：1MiB 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 9.2.2 --cmd 设置 sys_rman 命令的全路径位置，或者指向外部包装脚本。 例如，在 kingbase 恢复的过程中，restore_command 中使用 archive-get 命令时，可以使用外部包装脚本。 NOTE: 包装脚本具有一定的不确定性，不推荐使用。 举例：--cmd=/var/lib/pgsql/bin/sys_rman_wrapper.sh 9.2.3 --cmd-ssh 设置 ssh 客户端的二进制文件位置。 默认: ssh 举例: --cmd-ssh=/usr/bin/ssh 9.2.4 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 9.2.5 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 54 第 9 章 INFO 命令 允许范围: 0.1-3600 举例: --io-timeout=120 9.2.6 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 9.2.7 --protocol-timeout sys_rman 协议超时时间，应用于 sys_rman 进程之间通讯协议，包含本地和远程进程。 NOTE：protocol-timeout 应该大于 db-timeout 的时间。 默认: 1830 允许范围: 0.1-604800 举例: --protocol-timeout=630 9.2.8 --sck-keep-alive Socket 心跳机制，允许在 socket 连接上启动心跳机制。 默认: y 举例: --no-sck-keep-alive 9.2.9 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 55 第 9 章 INFO 命令 9.2.10 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 9.2.11 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 9.2.12 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 9.3 Log 选项 9.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 56 第 9 章 INFO 命令 9.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 9.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 9.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 9.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 57 第 9 章 INFO 命令 9.4 Repository 选项 9.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 9.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 举例: --repo1-host=repo1.domain.com 9.4.3 --repo-host-cmd 设置 REPO 节点上 sys_rman 工具的全路径位置。 推荐在 REPO 节点和 DB 节点，sys_rman 位于相同的路径之下；如果不一样，可以通过此选项来设置。 举例: --repo1-host-cmd=/usr/lib/backrest/bin/sys_rman 9.4.4 --repo-host-config 设置 REPO 节点上的配置文件的全路径位置。 推荐在 REPO 节点和 DB 节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配 置文件。 举例: --repo1-host-config=/conf/sys_rman/sys_rman.conf 9.4.5 --repo-host-port 设置 REPO 节点的 SSH 端口。 默认：22 58 第 9 章 INFO 命令 允许范围: 0-65535 举例: --repo1-host-port=25 9.4.6 --repo-host-user 设置 REPO 节点的操作系统用户名。 举例: --repo1-host-user=repo-user 9.4.7 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 59 第 10 章 RESTORE 命令 第 10章 restore 命令 restore 命令将还原数据库实例，并设置数据库实例第一次启动时的恢复参数。 10.1 Command 选项 10.1.1 --archive-mode 设置还原后的 KingbaseES 数据库的 archive_mode。 支持以下配置： off 还原后强制设置为 off preserve 还原后保留备份时的设置 默认: preserve 举例: --archive-mode=off 10.1.2 --force 设置还原时强制覆盖目标 DATA 目录已有的文件。 默认: n 举例: --force 10.1.3 --link-all 开启对 DATA 目录下软链接的保留。 开启式，还原后的 DATA 目录下保留所有的软链接； 默认时，还原后的 DATA 目录下去除软链接，生成实际文件或文件夹。 60 第 10 章 RESTORE 命令 默认: n 举例: --link-all 10.1.4 --link-map 设置软链接在还原后指向新的目录。 本选项可以多次配置。 举例: --link-map=sys_wal=/data/sys_wal 10.1.5 --set 设置还原时选择指定的备份集。 不指定时工具将选择最新的备份集。 默认: latest 举例: --set=20210131-153358F_20210131-153401I 10.1.6 --tablespace-map 设置表空间在还原后实际指向新的目标文件夹。 该选项可以多次设置。 举例: --tablespace-map=ts_01=/db/ts_01 10.1.7 --tablespace-map-all 设置所有表空间在还原后实际指向新的目标文件夹。 举例: --tablespace-map-all=/data/tablespace 10.1.8 --target 设置还原后恢复行为的目标。 根据还原时选项--type 的不同，--target 选项可以是时间、标签、xid、lsn 等。 举例: --target=2015-01-30 14:15:11 EST 61 第 10 章 RESTORE 命令 10.1.9 --target-action 设置还原后恢复完毕之后的数据库实例状态。 支持以下选项： pause 当恢复到指定目标后暂停数据库实例 promote 当恢复到指定目标后，数据库进入读写状态并切换时间线。 shutdown 当恢复到指定目标后关闭数据库实例 NOTE： 此选项仅在数据库实例的配置 hot_standby=on 生效；如果没有此配置，数据库实例将进入读写状态并切换时间 线。 默认: pause 举例: --target-action=promote 10.1.10 --target-exclusive 设置是否在还原后的恢复阶段包含--target 指定的内容。 默认是包含等于 --target 的内容。 举例说明: --type=xid --target=1007 将恢复到等于 1007 的内容 --type=xid --target=1007 --target-exclusive 将恢复到小于 1007 的内容 默认: n 举例: --target-exclusive 10.1.11 --target-timeline 设置还原后用于恢复的时间线。 更多信息请参考 KingbaseES 手册中的 recovery_target_timeline 选项。 举例: --target-timeline=3 10.1.12 --type 指定还原时的恢复目标类型。 支持以下选项： 62 第 10 章 RESTORE 命令 default - 恢复到归档 WAL 日志的末尾 immediate - 不拉取归档的 WAL 日志 lsn - 恢复到--target 指定 lsn name - 恢复到--target 指定备份标记点 (backup_label) xid - 恢复到--target 指定 xid time - 恢复到--target 指定自然时间 preserve - 保留原有的 kingbase.auto.conf 文件 standby - 在 kingbase.auto.conf 中增加 standby_mode=on none - 不产生 kingbase.auto.conf 文件 默认: default 举例: --type=xid 10.2 General 选项 10.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 默认值：1MiB 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 10.2.2 --cmd 设置 sys_rman 命令的全路径位置，或者指向外部包装脚本。 例如，在 kingbase 恢复的过程中，restore_command 中使用 archive-get 命令时，可以使用外部包装脚本。 NOTE: 包装脚本具有一定的不确定性，不推荐使用。 举例：--cmd=/var/lib/pgsql/bin/sys_rman_wrapper.sh 63 第 10 章 RESTORE 命令 10.2.3 --cmd-ssh 设置 ssh 客户端的二进制文件位置。 默认: ssh 举例: --cmd-ssh=/usr/bin/ssh 10.2.4 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 10.2.5 --delta 开启通过目标文件的 checksum 来判断是否拷贝。 开启后，备份时根据文件的 checksum 来判断是否拷贝文件； 开启后，还原时根据文件的 checksum 来判断是否覆盖文件。 默认: n 举例: --delta 10.2.6 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 允许范围: 0.1-3600 举例: --io-timeout=120 10.2.7 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 64 第 10 章 RESTORE 命令 举例: --lock-path=/backup/db/lock 10.2.8 --process-max 并发运行的最大进程数。 应用于拷贝文件、压缩等核心过程。 适当的设置可以提高备份或还原的效率，太高的设置会影响数据库实例本身的性能。 建议以 CPU 内核数设置最大进程数。 默认: 1 可选范围: 1-999 举例: --process-max=4 10.2.9 --protocol-timeout sys_rman 协议超时时间，应用于 sys_rman 进程之间通讯协议，包含本地和远程进程。 NOTE：protocol-timeout 应该大于 db-timeout 的时间。 默认: 1830 允许范围: 0.1-604800 举例: --protocol-timeout=630 10.2.10 --sck-keep-alive Socket 心跳机制，允许在 socket 连接上启动心跳机制。 默认: y 举例: --no-sck-keep-alive 10.2.11 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 65 第 10 章 RESTORE 命令 10.2.12 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 10.2.13 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 10.2.14 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 10.3 Log 选项 10.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 66 第 10 章 RESTORE 命令 10.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 10.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 10.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 10.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 67 第 10 章 RESTORE 命令 10.4 Repository 选项 10.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 10.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 举例: --repo1-host=repo1.domain.com 10.4.3 --repo-host-cmd 设置 REPO 节点上 sys_rman 工具的全路径位置。 推荐在 REPO 节点和 DB 节点，sys_rman 位于相同的路径之下；如果不一样，可以通过此选项来设置。 举例: --repo1-host-cmd=/usr/lib/backrest/bin/sys_rman 10.4.4 --repo-host-config 设置 REPO 节点上的配置文件的全路径位置。 推荐在 REPO 节点和 DB 节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配 置文件。 举例: --repo1-host-config=/conf/sys_rman/sys_rman.conf 10.4.5 --repo-host-port 设置 REPO 节点的 SSH 端口。 默认：22 68 第 10 章 RESTORE 命令 允许范围: 0-65535 举例: --repo1-host-port=25 10.4.6 --repo-host-user 设置 REPO 节点的操作系统用户名。 举例: --repo1-host-user=repo-user 10.4.7 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 10.5 Stanza 选项 10.5.1 --kb-host 设置 DB 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 DB 节点和 REPO 节点之间，预先建立好 SSH 免密登录。 举例: --kb1-host=db1.domain.com 10.5.2 --kb-path 设置 DB 节点的 data 全路径，要求设置全路径地址，不使用相对路径。 举例: --kb1-path=/data/db 69 第 11 章 STANZA-CREATE 命令 11章 stanza-create 命令 第 stanza 是 sys_rman 工具对 KingbaseES 实例的标签标识，开始备份之前，必须先创建 stanza。 11.1 Command 选项 11.1.1 --backup-standby 开启从备机拷贝数据文件的功能。 开启后，主备集群环境中，备份时将从备机拷贝数据文件，减少对主机性能的影响。 默认: n 举例: --backup-standby 11.2 General 选项 11.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 默认值：1MiB 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 70 第 11 章 STANZA-CREATE 命令 11.2.2 --cmd 设置 sys_rman 命令的全路径位置，或者指向外部包装脚本。 例如，在 kingbase 恢复的过程中，restore_command 中使用 archive-get 命令时，可以使用外部包装脚本。 NOTE: 包装脚本具有一定的不确定性，不推荐使用。 举例：--cmd=/var/lib/pgsql/bin/sys_rman_wrapper.sh 11.2.3 --cmd-ssh 设置 ssh 客户端的二进制文件位置。 默认: ssh 举例: --cmd-ssh=/usr/bin/ssh 11.2.4 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 11.2.5 --db-timeout database 单个操作命令的超时时间，以秒为单位。 此超时时间应用于 sys_rman 工具对数据库进行的各种操作，包含 sys_start_backup 和 sys_stop_backup 等需 要一定时间的操作。所以，超时时间应该设置为适当的时间。 注意: db-timeout 的时间应该短于 protocol-timeout 的时间。 默认: 1800 允许范围: 0.1-604800 举例：--db-timeout=600 71 第 11 章 STANZA-CREATE 命令 11.2.6 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 允许范围: 0.1-3600 举例: --io-timeout=120 11.2.7 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 11.2.8 --protocol-timeout sys_rman 协议超时时间，应用于 sys_rman 进程之间通讯协议，包含本地和远程进程。 注意: protocol-timeout 应该大于 db-timeout 的时间。 默认: 1830 允许范围: 0.1-604800 举例: --protocol-timeout=630 11.2.9 --sck-keep-alive Socket 心跳机制，允许在 socket 连接上启动心跳机制。 默认: y 举例: --no-sck-keep-alive 72 第 11 章 STANZA-CREATE 命令 11.2.10 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 11.2.11 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 11.2.12 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 11.2.13 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 11.3 Log 选项 11.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 73 第 11 章 STANZA-CREATE 命令 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 11.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 11.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 11.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 74 第 11 章 STANZA-CREATE 命令 11.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 11.4 Repository 选项 11.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 11.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 举例: --repo1-host=repo1.domain.com 11.4.3 --repo-host-cmd 设置 REPO 节点上 sys_rman 工具的全路径位置。 推荐在 REPO 节点和 DB 节点，sys_rman 位于相同的路径之下；如果不一样，可以通过此选项来设置。 举例: --repo1-host-cmd=/usr/lib/backrest/bin/sys_rman 11.4.4 --repo-host-config 设置 REPO 节点上的配置文件的全路径位置。 推荐在 REPO 节点和 DB 节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配 置文件。 75 第 11 章 STANZA-CREATE 命令 举例: --repo1-host-config=/conf/sys_rman/sys_rman.conf 11.4.5 --repo-host-port 设置 REPO 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --repo1-host-port=25 11.4.6 --repo-host-user 设置 REPO 节点的操作系统用户名。 举例: --repo1-host-user=repo-user 11.4.7 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 11.5 Stanza 选项 --kb-database 设置 KingbaseES 实例的默认数据库名称。 默认: test 举例: --kb1-database=new_default_database 11.5.1 --kb-host 设置 DB 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 DB 节点和 REPO 节点之间，预先建立好 SSH 免密登录。 举例: --kb1-host=db1.domain.com 76 第 11 章 STANZA-CREATE 命令 11.5.2 --kb-host-cmd 设置 DB 节点的 sys_rman 工具全路径。 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-cmd=/usr/bin/sys_rman 11.5.3 --kb-host-config 设置 DB 节点的 sys_rman 配置文件全路径。 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-config=/sys_rman/sys_rman.conf 11.5.4 --kb-host-port 设置 DB 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --kb1-host-port=25 11.5.5 --kb-host-user 设置 DB 节点的操作系统用户名。 举例: --kb1-host-user=db-user 11.5.6 --kb-path 设置 DB 节点的 data 全路径，要求设置全路径地址，不使用相对路径。 举例: --kb1-path=/data/db 11.5.7 --kb-port 设置 DB 节点的 KingbaseES 实例工作端口。 默认: 54321 允许范围: 0-65535 77 第 11 章 STANZA-CREATE 命令 举例: --kb1-port=65432 11.5.8 --kb-user 设置 DB 节点的 KingbaseES 数据库用户。 举例: --kb1-user=kingbase 78 第 12 章 STANZA-DELETE 命令 12章 stanza-delete 命令 第 删除一个 stanza，将删除其关联的所有备份集。 删除 stanza 的流程： 停止数据库实例 执行 sys_rman stop 命令 执行 sys_rman stanza-delete 命令 12.1 Command 选项 12.1.1 --force 开启强制删除指定的 stanza。 默认: n 举例: --no-force 12.2 General 选项 12.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 默认值：1MiB 79 第 12 章 STANZA-DELETE 命令 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 12.2.2 --cmd 设置 sys_rman 命令的全路径位置，或者指向外部包装脚本。 例如，在 kingbase 恢复的过程中，restore_command 中使用 archive-get 命令时，可以使用外部包装脚本。 注意: 包装脚本具有一定的不确定性，不推荐使用。 举例：--cmd=/var/lib/pgsql/bin/sys_rman_wrapper.sh 12.2.3 --cmd-ssh 设置 ssh 客户端的二进制文件位置。 默认: ssh 举例: --cmd-ssh=/usr/bin/ssh 12.2.4 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 12.2.5 --db-timeout database 单个操作命令的超时时间，以秒为单位。 此超时时间应用于 sys_rman 工具对数据库进行的各种操作，包含 sys_start_backup 和 sys_stop_backup 等需 要一定时间的操作。所以，超时时间应该设置为适当的时间。 注意: db-timeout 的时间应该短于 protocol-timeout 的时间。 默认: 1800 允许范围: 0.1-604800 举例：--db-timeout=600 80 第 12 章 STANZA-DELETE 命令 12.2.6 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 允许范围: 0.1-3600 举例: --io-timeout=120 12.2.7 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 12.2.8 --protocol-timeout sys_rman 协议超时时间，应用于 sys_rman 进程之间通讯协议，包含本地和远程进程。 NOTE：protocol-timeout 应该大于 db-timeout 的时间。 默认: 1830 允许范围: 0.1-604800 举例: --protocol-timeout=630 12.2.9 --sck-keep-alive Socket 心跳机制，允许在 socket 连接上启动心跳机制。 默认: y 举例: --no-sck-keep-alive 12.2.10 --stanza Stanza 标签选项。 81 第 12 章 STANZA-DELETE 命令 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 12.2.11 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 12.2.12 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 12.2.13 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 12.3 Log 选项 12.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 82 第 12 章 STANZA-DELETE 命令 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 12.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 12.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 12.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 83 第 12 章 STANZA-DELETE 命令 12.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 12.4 Repository 选项 12.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 12.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 举例: --repo1-host=repo1.domain.com 12.4.3 --repo-host-cmd 设置 REPO 节点上 sys_rman 工具的全路径位置。 推荐在 REPO 节点和 DB 节点，sys_rman 位于相同的路径之下；如果不一样，可以通过此选项来设置。 举例: --repo1-host-cmd=/usr/lib/backrest/bin/sys_rman 12.4.4 --repo-host-config 设置 REPO 节点上的配置文件的全路径位置。 推荐在 REPO 节点和 DB 节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配 置文件。 84 第 12 章 STANZA-DELETE 命令 举例: --repo1-host-config=/conf/sys_rman/sys_rman.conf 12.4.5 --repo-host-port 设置 REPO 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --repo1-host-port=25 12.4.6 --repo-host-user 设置 REPO 节点的操作系统用户名。 举例: --repo1-host-user=repo-user 12.4.7 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 12.5 Stanza 选项 12.5.1 --kb-database 设置 KingbaseES 实例的默认数据库名称。 默认: test 举例: --kb1-database=new_default_database 12.5.2 --kb-host 设置 DB 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 DB 节点和 REPO 节点之间，预先建立好 SSH 免密登录。 85 第 12 章 STANZA-DELETE 命令 举例: --kb1-host=db1.domain.com 12.5.3 --kb-host-cmd 设置 DB 节点的 sys_rman 工具全路径。 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-cmd=/usr/bin/sys_rman 12.5.4 --kb-host-config 设置 DB 节点的 sys_rman 配置文件全路径。 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-config=/sys_rman/sys_rman.conf 12.5.5 --kb-host-port 设置 DB 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --kb1-host-port=25 12.5.6 --kb-host-user 设置 DB 节点的操作系统用户名。 举例: --kb1-host-user=db-user 12.5.7 --kb-path 设置 DB 节点的 data 全路径，要求设置全路径地址，不使用相对路径。 举例: --kb1-path=/data/db 86 第 12 章 STANZA-DELETE 命令 12.5.8 --kb-port 设置 DB 节点的 KingbaseES 实例工作端口。 默认: 54321 允许范围: 0-65535 举例: --kb1-port=65432 12.5.9 --kb-user 设置 DB 节点的 KingbaseES 数据库用户。 举例: --kb1-user=kingbase 87 第 13 章 STANZA-UPGRADE 命令 13章 stanza-upgrade 命令 第 当数据库实例升级或者 sys_rman.conf 配置有了变化后，使用 stanza-upgrade 命令更新 stanza 的备份配置。 13.1 Command 选项 13.1.1 --backup-standby 开启从备机拷贝数据文件的功能。 开启后，主备集群环境中，备份时将从备机拷贝数据文件，减少对主机性能的影响。 默认: n 举例: --backup-standby 13.2 General 选项 13.2.1 --buffer-size 通用的 I/O buffer 容量，该容量应用于磁盘 IO 和网络 IO 的拷贝、压缩、加密及其他操作。 单位默认为字节，推荐使用 KiB, MiB, GiB, TiB, PiB 等后缀，均以 1024 为阶梯。 举例来说，5368709120 == 5GiB == 5GB == 5g 。 分数不被允许，比如 2.5MiB 不允许，可以使用 2560KiB 代替。 默认值：1MiB 允许范围：16KiB,32KiB,64KiB,128KiB,256KiB,512KiB,1MiB,2MiB,4MiB,8MiB,16MiB 举例：--buffer-size=2MiB 88 第 13 章 STANZA-UPGRADE 命令 13.2.2 --cmd 设置 sys_rman 命令的全路径位置，或者指向外部包装脚本。 例如，在 kingbase 恢复的过程中，restore_command 中使用 archive-get 命令时，可以使用外部包装脚本。 注意: 包装脚本具有一定的不确定性，不推荐使用。 举例：--cmd=/var/lib/pgsql/bin/sys_rman_wrapper.sh 13.2.3 --cmd-ssh 设置 ssh 客户端的二进制文件位置。 默认: ssh 举例: --cmd-ssh=/usr/bin/ssh 13.2.4 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 13.2.5 --db-timeout database 单个操作命令的超时时间，以秒为单位。 此超时时间应用于 sys_rman 工具对数据库进行的各种操作，包含 sys_start_backup 和 sys_stop_backup 等需 要一定时间的操作。所以，超时时间应该设置为适当的时间。 注意: db-timeout 的时间应该短于 protocol-timeout 的时间。 默认: 1800 允许范围: 0.1-604800 举例：--db-timeout=600 89 第 13 章 STANZA-UPGRADE 命令 13.2.6 --io-timeout I/O 超时时间，应用于建立连接、读、写操作等。 请注意，超时的范围，并不是指整个读写操作的完成，而是读写有进展；读写如果毫无进展且持续了设定的时 间，则认为是 I/O 超时。 默认: 60 允许范围: 0.1-3600 举例: --io-timeout=120 13.2.7 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 13.2.8 --protocol-timeout sys_rman 协议超时时间，应用于 sys_rman 进程之间通讯协议，包含本地和远程进程。 NOTE：protocol-timeout 应该大于 db-timeout 的时间。 默认: 1830 允许范围: 0.1-604800 举例: --protocol-timeout=630 13.2.9 --sck-keep-alive Socket 心跳机制，允许在 socket 连接上启动心跳机制。 默认: y 举例: --no-sck-keep-alive 13.2.10 --stanza Stanza 标签选项。 90 第 13 章 STANZA-UPGRADE 命令 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 13.2.11 --tcp-keep-alive-count TCP 心跳次数设置，如果心跳信息丢失的数目超过了这个设置，工具认为此连接已经断开。 允许范围: 1-32 举例: --tcp-keep-alive-count=3 13.2.12 --tcp-keep-alive-idle TCP 心跳消息间隔时间，以秒为单位。 允许范围: 1-3600 举例: --tcp-keep-alive-idle=60 13.2.13 --tcp-keep-alive-interval TCP 心跳消息重试时间，以秒为单位。 允许范围: 1-900 举例: --tcp-keep-alive-interval=30 13.3 Log 选项 13.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 91 第 13 章 STANZA-UPGRADE 命令 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 13.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 13.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 13.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 92 第 13 章 STANZA-UPGRADE 命令 13.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 13.4 Repository 选项 13.4.1 --repo-cipher-type 开启备份仓库的加密存储。 支持以下选项： none 备份仓库不加密 aes-256-cbc 备份仓库使用 Advanced Encryption Standard 加密 默认: none 举例: --repo1-cipher-type=aes-256-cbc 13.4.2 --repo-host REPO 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 REPO 节点和 DB 节点之间，预先建立好 SSH 免密登录。 举例: --repo1-host=repo1.domain.com 13.4.3 --repo-host-cmd 设置 REPO 节点上 sys_rman 工具的全路径位置。 推荐在 REPO 节点和 DB 节点，sys_rman 位于相同的路径之下；如果不一样，可以通过此选项来设置。 举例: --repo1-host-cmd=/usr/lib/backrest/bin/sys_rman 13.4.4 --repo-host-config 设置 REPO 节点上的配置文件的全路径位置。 推荐在 REPO 节点和 DB 节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配 置文件。 93 第 13 章 STANZA-UPGRADE 命令 举例: --repo1-host-config=/conf/sys_rman/sys_rman.conf 13.4.5 --repo-host-port 设置 REPO 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --repo1-host-port=25 13.4.6 --repo-host-user 设置 REPO 节点的操作系统用户名。 举例: --repo1-host-user=repo-user 13.4.7 --repo-path 设置 REPO 节点的实际存储目录。 可以是 REPO 节点的本地存储，可以是网络存储的本地挂载点。 物理备份和归档的 WAL 日志都将存储到此目录下。 举例: --repo1-path=/backup/db/repo 13.5 Stanza 选项 13.5.1 --kb-database 设置 KingbaseES 实例的默认数据库名称。 默认: test 举例: --kb1-database=new_default_database 13.5.2 --kb-host 设置 DB 节点的 IP 地址或主机名。 如果使用 SSH 访问的方式，在 DB 节点和 REPO 节点之间，预先建立好 SSH 免密登录。 94 第 13 章 STANZA-UPGRADE 命令 举例: --kb1-host=db1.domain.com 13.5.3 --kb-host-cmd 设置 DB 节点的 sys_rman 工具全路径。 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-cmd=/usr/bin/sys_rman 13.5.4 --kb-host-config 设置 DB 节点的 sys_rman 配置文件全路径。 不推荐设置，仅在特殊场景下适用。 举例: --kb1-host-config=/sys_rman/sys_rman.conf 13.5.5 --kb-host-port 设置 DB 节点的 SSH 端口。 默认：22 允许范围: 0-65535 举例: --kb1-host-port=25 13.5.6 --kb-host-user 设置 DB 节点的操作系统用户名。 举例: --kb1-host-user=db-user 13.5.7 --kb-path 设置 DB 节点的 data 全路径，要求设置全路径地址，不使用相对路径。 举例: --kb1-path=/data/db 95 第 13 章 STANZA-UPGRADE 命令 13.5.8 --kb-port 设置 DB 节点的 KingbaseES 实例工作端口。 默认: 54321 允许范围: 0-65535 举例: --kb1-port=65432 13.5.9 --kb-user 设置 DB 节点的 KingbaseES 数据库用户。 举例: --kb1-user=kingbase 96 第 14 章 START 命令 14章 start 命令 第 start 命令将移除 stop 命令放置的停止标识，允许执行 sys_rman 工具的其他命令。 start 命令本身不包含其他备份或恢复行为。 14.1 General 选项 14.1.1 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 14.1.2 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 14.1.3 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 97 第 14 章 START 命令 14.2 Log 选项 14.2.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 14.2.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 98 第 14 章 START 命令 14.2.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 14.2.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 14.2.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 99 第 15 章 第 STOP 命令 15章 stop 命令 工具执行 stop 命令后，放置文件标识，阻止再次执行 sys_rman 工具的其他命令。 正在运行中的 sys_rman 进程间继续运行，stop 标识阻止新的 sys_rman 进程。 15.1 Command 选项 15.1.1 --force 设置强制关闭正在运行中的 sys_rman 进程，发送 TERM 信号给进程。 默认: n 举例: --force 15.2 General 选项 15.2.1 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 15.2.2 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 100 第 15 章 STOP 命令 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 15.2.3 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 15.3 Log 选项 15.3.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 15.3.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 101 第 15 章 STOP 命令 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 15.3.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 15.3.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 15.3.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 102 第 16 章 VERIFY 命令 16章 verify 命令 第 工具检查备份集的内容。 16.1 General 选项 16.1.1 --config sys_rman 工具的主要配置文件。 命令行指定的选项优先于配置文件中的设定值。 举例: --config=/conf/sys_rman/sys_rman.conf 16.1.2 --lock-path sys_rman 工具排斥锁路径。 工具为了避免同样的环境下同时运行，将设置一个文件标识锁，lock-path 用来指定文件锁的路径。 默认: /tmp/sys_rman 举例: --lock-path=/backup/db/lock 16.1.3 --stanza Stanza 标签选项。 Stanza 标签用来标识一个 KingbaseES 实例或集群，对 sys_rman 工具来说，一个标签对应于一个整体，包含若 干 DB 节点。 举例: --stanza=kingbase 103 第 16 章 VERIFY 命令 16.2 Log 选项 16.2.1 --log-level-console 屏幕输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: warn 举例: --log-level-console=error 16.2.2 --log-level-file 日志文件输出日志级别。 支持以下日志级别： off - 无任何日志（不推荐） error - 只记录 error 级别 warn - 记录 warning、error 级别 info - 记录 info、warning、error 级别 detail- 记录 detail、info、warning、error 级别 debug - 记录 debug、detail、info、warning、error 级别 trace - 记录 trace、debug、detail、info、warning、error 级别 默认: info 举例: --log-level-file=debug 104 第 16 章 VERIFY 命令 16.2.3 --log-path 工具的日志文件存放路径。 默认: /var/log/sys_rman 举例: --log-path=/backup/db/log 16.2.4 --log-subprocess 开启记录子进程日志到日志文件，日志级别引用--log-level-file。 默认: n 举例: --log-subprocess 16.2.5 --log-timestamp 开启在屏幕日志和文件日志中添加时间戳。 默认: y 举例: --no-log-timestamp 105 第 17 章 第 VERSION 命令 17章 version 命令 显示工具的版本信息。 106 版权声明 版权声明 北京人大金仓信息技术股份有限公司（简称：人大金仓）版权所有，并保留对本手册及本声明的一切权利。 未得到人大金仓的书面许可，任何人不得以任何方式或形式对本手册内的任何部分进行复制、摘录、备份、修 改、传播、翻译成其他语言、将其全部或部分用于商业用途。 免责声明 本手册内容依据现有信息制作，由于产品版本升级或其他原因，其内容有可能变更。人大金仓保留在没有任何通 知或者提示的情况下对手册内容进行修改的权利。 本手册仅作为使用指导，人大金仓在编写本手册时已尽力保证其内容准确可靠，但并不确保手册内容完全没有错 误或遗漏，本手册中的所有信息也不构成任何明示或暗示的担保。 技术支持 • 人大金仓官方网站：http://www.kingbase.com.cn/ • 人大金仓文档中心：http://help.kingbase.com.cn/ • 全国服务热线：400-601-1188 • 人大金仓技术支持与反馈信箱：support@kingbase.com.cn 107 服务周期承诺 服务周期承诺 由于市场需求在不断变化，技术创新和发展的进程不断加剧，产品的版本更迭不可避免。人大金仓对于产品版本 生命周期的有效管理，有助于您提前规划项目，更好地从产品服务终止上过渡。 表 1: KingbaseES 产品生命周期里程碑 关键里程碑点 定义 产品发布日期 产品正式发布版本，即 GA（general availability）版本的发布日期。 停止销售日期 正式停止销售的日期，版本停止接受订单日。该日之后，产品将不再销售。 停止功能升级日期 在该日期之后，不再提供新特性和新硬件支持。但依旧提供错误修复、安全修复、功 能维护等服务。 停止功能维护日期 在该日期之后，不再维护功能，修复问题。但依旧提供安全修复等服务 停止安全维护日期 在该日期之后，不再发布补丁版本修复中高风险漏洞，仅提供有限的支持。 产品服务终止日期 停止提供产品服务和支持的日期。包括软件维护版本，缺陷修复，以及针对该产品的 所有服务支持（包括服务热线和远程/现场支持）。 服务周期策略 金仓数据库管理系统 KingbaseES 产品确保以下的服务周期： 1）产品自发布之日起至产品停止功能升级（包含新特性、新硬件支持）之日不少于 5 年。 2）产品停止功能升级之日起至产品停止功能维护（主要包括问题修复）之日不少于 4 年。 3）产品功能维护停止之日起至产品停止安全维护（包括中高风险漏洞修复）之日不少于 2 年。 服务终止策略 金仓数据库管理系统 KingbaseES 产品确保在销售后，至少提供 6 年的服务支持。 注意: 人大金仓将会综合各方因素来确定产品服务终止日期。并将在实际产品服务终止日期之前至少 90 天，通过公 108 服务周期承诺 开方式宣布产品服务终止日期。 109