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

目录

7.1. Command 选项 ¶

7.1.1. --set ¶

7.2. General 选项 ¶

7.2.1. --buffer-size ¶

7.2.2. --config ¶

7.2.3. --dry-run ¶

7.2.4. --io-timeout ¶

7.2.5. --lock-path ¶

7.2.6. --sck-keep-alive ¶

7.2.7. --stanza ¶

7.2.8. --tcp-keep-alive-count ¶

7.2.9. --tcp-keep-alive-idle ¶

7.2.10. --tcp-keep-alive-interval ¶

7.3. Log 选项 ¶

7.3.1. --log-level-console ¶

7.3.2. --log-level-file ¶

7.3.3. --log-path ¶

7.3.4. --log-subprocess ¶

7.3.5. --log-timestamp ¶

7.4. Repository 选项 ¶

7.4.1. --repo-cipher-type ¶

7.4.2. --repo-host ¶

7.4.3. --repo-path ¶

7.4.4. --repo-retention-diff ¶

7.4.5. --repo-retention-full ¶

7.4.6. --repo-retention-history ¶

---

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

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

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

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

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 ¶

设置保留历史差异备份集的数量。

在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