br 命令行手册

本文介绍 br 命令的定义、组成、常用选项，以及快照备份与恢复、日志备份与 PITR (Point-in-time recovery) 功能使用的命令。

br 命令行描述

br 命令是由子命令、选项和参数组成的。子命令即不带 - 或者 -- 的字符。选项即以 - 或者 -- 开头的字符。参数即子命令或选项字符后紧跟的、并传递给命令和选项的字符。

以下是一条完整的 br 命令行：

  1. br backup full --pd "${PD_IP}:2379" \
  2. --storage "s3://backup-data/snapshot-202209081330/"

上面命令行中各部分的解释如下：

  • backup：br 的子命令。
  • full：br backup 的子命令。
  • -s 或 --storage：备份数据的存储地址选项。"s3://backup-data/snapshot-202209081330/" 是 -s 的参数值。
  • --pd：PD 访问地址选项。"${PD_IP}:2379" 是 --pd 的参数值。

命令和子命令

br 由多层命令组成。目前，br 包含的主要命令有：

  • br backup：用于备份 TiDB 集群的全量数据。
  • br log：用于启动和管理日志备份任务。
  • br restore：用于恢复备份数据到 TiDB 集群。

br backup 和 br restore 还包含这些子命令：

  • full：用于备份或恢复整个备份数据。
  • db：用于备份或恢复集群中的指定数据库。
  • table：用于备份或恢复集群指定数据库中的单张表。

常用选项

  • --pd：PD 访问地址选项，例如 "${PD_IP}:2379"。
  • -s 或 --storage：备份数据的存储地址选项。TiDB 备份恢复支持以 Amazon S3、Google Cloud Storage (GCS)、Azure Blob Storage 及 NFS 为备份存储。关于 URI 格式的详细信息，请参考外部存储服务的 URI 格式。
  • --ca：指定 PEM 格式的受信任 CA 的证书文件路径。
  • --cert：指定 PEM 格式的 SSL 证书文件路径。
  • --key：指定 PEM 格式的 SSL 证书密钥文件路径。
  • --status-addr：向 Prometheus 提供统计数据的监听地址。
  • --concurrency：备份或恢复阶段的任务并发数。
  • --compression：备份生成文件的压缩算法，支持 lz4、snappy、zstd，默认 zstd（多数情况下无须修改）。如何选择不同的压缩算法，可以参考文档。
  • --compression-level：备份选择的压缩算法对应的压缩级别，zstd 默认为 3。大多数情况下无需设置。

全量备份命令行

使用 br backup 命令来备份集群全量数据。可选择添加 full 或 table 子命令来指定备份的范围：全部集群数据 (full) 或单张表的数据 (table)。

日志备份命令行

使用 br log 命令来开启和管理日志备份任务。

恢复备份数据命令行

使用 br restore 命令来恢复备份数据。可选择添加 full、db 或 table 子命令来指定恢复操作的范围：全部集群数据 (full)、某个数据库 (db) 或某张数据表 (table)。