TiDB 快照备份与恢复命令行手册

本文按备份恢复的场景介绍快照备份和恢复的命令行，包括：

如果你想了解如何进行快照备份与恢复，可以参考以下教程：

备份集群快照

执行 br backup full 命令，可以备份 TiDB 最新的或者指定时间点的快照数据。执行 br backup full --help 可获取该命令的使用帮助。

  1. br backup full \
  2.     --pd "${PD_IP}:2379" \
  3.     --backupts '2022-09-08 13:30:00' \
  4.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  5.     --ratelimit 128 \
  6.     --log-file backupfull.log

以上命令中：

  • --backupts：快照对应的物理时间点。如果该快照的数据已经被 GC，那么 br backup 命令会报错退出；如果没有指定该参数，br 命令行工具会选取备份开始的时间点所对应的快照。
  • --ratelimit：每个 TiKV 执行备份任务的速度上限（单位 MiB/s）。
  • --log-file：备份日志写入的目标文件。

快照备份与恢复命令手册 - 图1

注意

BR 工具已支持自适应 GC，会自动将 backupTS（默认是最新的 PD timestamp）注册到 PD 的 safePoint，保证 TiDB 的 GC Safe Point 在备份期间不会向前移动，即可避免手动设置 GC。

备份期间终端会显示进度条，效果如下。当进度条达到 100% 时，表示备份完成。

  1. Full Backup <---------/................................................> 17.12%.

备份 TiDB 集群指定库表的数据

br 工具支持只备份集群快照和增量数据中指定库或表的局部数据。在快照备份和增量数据备份的基础上，该功能可过滤掉不需要的数据，只备份关键业务的数据。

备份单个数据库的数据

执行 br backup db 命令，可备份集群中指定单个数据库的数据。

下面是将数据库 test 备份到 Amazon S3 的示例：

  1. br backup db \
  2.     --pd "${PD_IP}:2379" \
  3.     --db test \
  4.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  5.     --ratelimit 128 \
  6.     --log-file backuptable.log

db 子命令的选项为 --db，用来指定数据库名。其他选项的含义与备份 TiDB 集群快照相同。

备份单张表的数据

执行 br backup table 命令，可备份集群中指定单张表的数据。

下面是将表 test.usertable 备份到 Amazon S3 的示例：

  1. br backup table \
  2.     --pd "${PD_IP}:2379" \
  3.     --db test \
  4.     --table usertable \
  5.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  6.     --ratelimit 128 \
  7.     --log-file backuptable.log

table 子命令有 --db 和 --table 两个选项，分别用来指定数据库名和表名。其他选项的含义与备份 TiDB 集群快照相同。

使用表库过滤功能备份多张表的数据

如果你需要以更复杂的过滤条件来备份多个库或表，执行 br backup full 命令，并使用 --filter 或 -f 来指定表库过滤规则。

下面是将所有符合 db*.tbl* 条件的表的数据备份到 Amazon S3 的示例：

  1. br backup full \
  2.     --pd "${PD_IP}:2379" \
  3.     --filter 'db*.tbl*' \
  4.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  5.     --ratelimit 128 \
  6.     --log-file backupfull.log

备份数据加密

快照备份与恢复命令手册 - 图2

警告

当前该功能为实验特性，不建议在生产环境中使用。

br 命令行工具支持在备份端，或备份到 Amazon S3 的时候在存储服务端进行备份数据加密，你可以根据自己情况选择其中一种使用。

自 TiDB v5.3.0 起，你可配置下列参数在备份过程中实现数据加密：

  • --crypter.method：加密算法，支持 aes128-ctr、aes192-ctr 和 aes256-ctr 三种算法，缺省值为 plaintext，表示不加密
  • --crypter.key：加密密钥，十六进制字符串格式，aes128-ctr 对应 128 位（16 字节）密钥长度，aes192-ctr 为 24 字节，aes256-ctr 为 32 字节
  • --crypter.key-file：密钥文件，可直接将存放密钥的文件路径作为参数传入，此时 crypter.key 不需要配置

备份加密的示例如下：

  1. br backup full\
  2.     --pd ${PD_IP}:2379 \
  3.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  4.     --crypter.method aes128-ctr \
  5.     --crypter.key 0123456789abcdef0123456789abcdef

快照备份与恢复命令手册 - 图3

注意

  • 密钥丢失，备份的数据将无法恢复到集群中。
  • 加密功能需在 br 工具和 TiDB 集群都不低于 v5.3.0 的版本上使用，且加密备份得到的数据无法在低于 v5.3.0 版本的集群上恢复。

恢复快照备份数据

执行 br restore full 命令，可将集群恢复到快照备份对应的数据状态。

  1. br restore full \
  2.     --pd "${PD_IP}:2379" \
  3.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  4.     --ratelimit 128 \
  5.     --log-file restorefull.log

以上命令中，

  • --ratelimit：每个 TiKV 执行恢复任务的速度上限（单位 MiB/s）
  • --log-file：备份日志写入的目标文件

恢复期间终端会显示进度条，效果如下。当进度条达到 100% 时，表示恢复完成。在完成恢复后，br 工具为了确保数据安全性，还会校验恢复数据。

  1. Full Restore <---------/...............................................> 17.12%.

恢复备份数据中指定库表的数据

br 命令行工具支持只恢复备份数据中指定库/表的局部数据。该功能在恢复过程中过滤掉不需要的数据，可以用于往 TiDB 集群上恢复指定库/表的数据。

恢复单个数据库的数据

执行 br restore db 命令，可将单个数据库恢复到对应的状态。

示例：恢复 S3 中的库 test 的数据：

  1. br restore db \
  2.     --pd "${PD_IP}:2379" \
  3.     --db "test" \
  4.     --ratelimit 128 \
  5.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  6.     --log-file restore_db.log

以上命令中 --db 选项指定了需要恢复的数据库名字。其余选项的含义与恢复快照备份数据相同。

快照备份与恢复命令手册 - 图4

注意

由于备份数据的元文件 backupmeta 记录了数据库名 --db，因此只能将数据恢复到同名的数据库，否则无法恢复成功。推荐把备份文件恢复到另一个集群的同名数据库中。

恢复单张表的数据

执行 br restore table 命令，可将单张表的数据恢复到对应的状态。

下面是恢复 Amazon S3 中 test.usertable 表数据的示例：

  1. br restore table \
  2.     --pd "${PD_IP}:2379" \
  3.     --db "test" \
  4.     --table "usertable" \
  5.     --ratelimit 128 \
  6.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  7.     --log-file restore_table.log

以上命令中 --table 选项指定了需要恢复的表名。其余选项的含义与恢复单个数据库相同。

使用表库功能过滤恢复数据

如果你需要用复杂的过滤条件来恢复多个表，执行 br restore full 命令，并用 --filter 或 -f 指定使用表库过滤。

下面是恢复 Amazon S3 中符合 db*.tbl* 条件的表的数据的示例：

  1. br restore full \
  2.     --pd "${PD_IP}:2379" \
  3.     --filter 'db*.tbl*' \
  4.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  5.     --log-file restorefull.log

恢复加密的快照备份数据

快照备份与恢复命令手册 - 图5

警告

当前该功能为实验特性，不建议在生产环境中使用。

在对数据做加密备份后，恢复操作需传入相应的解密参数，解密算法或密钥不正确则无法恢复，解密参数和加密参数一致即可。解密恢复的示例如下：

  1. br restore full\
  2.     --pd "${PD_IP}:2379" \
  3.     --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
  4.     --crypter.method aes128-ctr \
  5.     --crypter.key 0123456789abcdef0123456789abcdef