Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

br: add "tiup br debug" command (#18470) #18480

Merged
merged 3 commits into from
Aug 5, 2024
Merged

br: add "tiup br debug" command (#18470) #18480

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49d0cf2
Add temp.md
lilin90 Aug 5, 2024
61f0bca
Delete temp.md
lilin90 Aug 5, 2024
bfb7bfd
Add "tiup br debug" command descriptions
lilin90 Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions br/use-br-command-line-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,23 @@
* `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.

Check failure on line 35 in br/use-br-command-line-tool.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.Latin] Use 'such as' instead of 'and so on.'.

Raw Output:
{"message": "[PingCAP.Latin] Use 'such as' instead of 'and so on.'.", "location": {"path": "br/use-br-command-line-tool.md", "range": {"start": {"line": 35, "column": 70}}}, "severity": "ERROR"}

`tiup br backup` and `tiup br restore` include the following sub-commands:

* `full`: used to back up or restore all the cluster data.
* `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"`.
Expand Down
Loading