From 8ec9bd6ec08b63a8f0c605c3460ae15d275b44c5 Mon Sep 17 00:00:00 2001 From: Ti Chi Robot Date: Mon, 5 Aug 2024 15:29:11 +0800 Subject: [PATCH] br: add "tiup br debug" command (#18470) (#18480) --- br/use-br-command-line-tool.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/br/use-br-command-line-tool.md b/br/use-br-command-line-tool.md index 243d8b33273b8..01ce600131fda 100644 --- a/br/use-br-command-line-tool.md +++ b/br/use-br-command-line-tool.md @@ -32,6 +32,7 @@ A `tiup br` command consists of multiple layers of sub-commands. Currently, br c * `tiup br backup`: used to back up the data of the TiDB cluster. * `tiup br log`: used to start and manage log backup tasks. * `tiup br restore`: used to restore backup data of the TiDB cluster. +* `tiup br debug`: used to parse backup metadata, check backup data, and so on. `tiup br backup` and `tiup br restore` include the following sub-commands: @@ -39,6 +40,15 @@ A `tiup br` command consists of multiple layers of sub-commands. Currently, br c * `db`: used to back up or restore a specified database of the cluster. * `table`: used to back up or restore a single table in the specified database of the cluster. +`tiup br debug` incudes the following sub-commands: + +* `checksum`: (hidden parameter) used to offline check the integrity of backup data to ensure that all backup files match the CRC64 checksum results calculated by [`ADMIN CHECKSUM TABLE`](/sql-statements/sql-statement-admin-checksum-table.md). +* `backupmeta`: used to check whether an intersection exists among backup data files. In normal cases, backup data files do not intersect. +* `decode`: used to parse the `backupmeta` metadata file of a full backup into JSON format. In addition, you can parse specific fields using the `--field` parameter. +* `encode`: used to encode the `backupmeta.json` metadata file of a full backup into the protobuf format that is used during data restore. +* `reset-pd-config-as-default`: (deprecated) used to restore the PD configurations that were changed during the data recovery process to default configurations. +* `search-log-backup`: used to search for specific key information in log backup data. + ### Common options * `--pd`: specifies the PD service address. For example, `"${PD_IP}:2379"`.