金仓数据库KingbaseES物理备份恢复命令选项（stanza-delete命令）

目录

12.1. Command 选项 ¶

12.1.1. --force ¶

12.2. General 选项 ¶

12.2.1. --buffer-size ¶

12.2.2. --cmd ¶

12.2.3. --cmd-ssh ¶

12.2.4. --config ¶

12.2.5. --db-timeout ¶

12.2.6. --io-timeout ¶

12.2.7. --lock-path ¶

12.2.8. --protocol-timeout ¶

12.2.9. --sck-keep-alive ¶

12.2.10. --stanza ¶

12.2.11. --tcp-keep-alive-count ¶

12.2.12. --tcp-keep-alive-idle ¶

12.2.13. --tcp-keep-alive-interval ¶

12.3. Log 选项 ¶

12.3.1. --log-level-console ¶

12.3.2. --log-level-file ¶

12.3.3. --log-path ¶

12.3.4. --log-subprocess ¶

12.3.5. --log-timestamp ¶

12.4. Repository 选项 ¶

12.4.1. --repo-cipher-type ¶

12.4.2. --repo-host ¶

12.4.3. --repo-host-cmd ¶

12.4.4. --repo-host-config ¶

12.4.5. --repo-host-port ¶

12.4.6. --repo-host-user ¶

12.4.7. --repo-path ¶

12.5. Stanza 选项 ¶

12.5.1. --kb-database ¶

12.5.2. --kb-host ¶

12.5.3. --kb-host-cmd ¶

12.5.4. --kb-host-config ¶

12.5.5. --kb-host-port ¶

12.5.6. --kb-host-user ¶

12.5.7. --kb-path ¶

12.5.8. --kb-port ¶

12.5.9. --kb-user ¶

---

删除一个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

允许范围：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命令时，可以使用外部包装脚本。

NOTE:

包装脚本具有一定的不确定性，不推荐使用。

举例：--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等需要一定时间的操作。所以，超时时间应该设置为适当的时间。

NOTE：

db-timeout的时间应该短于protocol-timeout的时间。

默认: 1800

允许范围: 0.1-604800

举例：--db-timeout=600

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标签选项。

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级别

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

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节点，配置文件位于相同的路径之下；如果不一样，可以通过此选项来设置不同的配置文件。

举例: --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免密登录。

举例: --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

12.5.8. --kb-port ¶

设置DB节点的KingbaseES实例工作端口。

默认: 54321

允许范围: 0-65535

举例: --kb1-port=65432

12.5.9. --kb-user ¶

设置DB节点的KingbaseES数据库用户。

举例: --kb1-user=kingbase