Skip to content

br: disable restore checksum #20847

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.

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion br/br-pitr-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,8 @@ Expected output:

> **Note:**
>
> If you specify `--full-backup-storage` as the incremental backup address for `restore point`, for restores of this backup and any previous incremental backups, you need to set the parameter `--allow-pitr-from-incremental` to `true` to make the incremental backups compatible with the subsequent log backups.
> - If you specify `--full-backup-storage` as the incremental backup address for `restore point`, for restores of this backup and any previous incremental backups, you need to set the parameter `--allow-pitr-from-incremental` to `true` to make the incremental backups compatible with the subsequent log backups.
> - For checksum configuration, refer to [Checksum](#checksum) for details on verifying data integrity during backup and restore.

You can run the `tiup br restore point` command to perform a PITR on a new cluster or just restore the log backup data.

Expand Down
47 changes: 45 additions & 2 deletions br/br-snapshot-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ This document describes the commands of TiDB snapshot backup and restore accordi
- [Restore multiple tables with table filter](#restore-multiple-tables-with-table-filter)
- [Restore execution plan bindings from the `mysql` schema](#restore-execution-plan-bindings-from-the-mysql-schema)
- [Restore encrypted snapshots](#restore-encrypted-snapshots)
- [Checksum](#checksum)

For more information about snapshot backup and restore, refer to:

Expand Down Expand Up @@ -48,7 +49,6 @@ In the preceding command:

> **Note:**
>
> - Starting from v8.5.0, the BR tool disables the table-level checksum calculation during full backups by default (`--checksum=false`) to improve backup performance.
> - The BR tool already supports self-adapting to GC. It automatically registers `backupTS` (the latest PD timestamp by default) to PD's `safePoint` to ensure that TiDB's GC Safe Point does not move forward during the backup, thus avoiding manually setting GC configurations.

During backup, a progress bar is displayed in the terminal, as shown below. When the progress bar advances to 100%, the backup is complete.
Expand Down Expand Up @@ -178,7 +178,7 @@ In the preceding command:
- `--ratelimit`: The maximum speed **per TiKV** performing restore tasks. The unit is in MiB/s.
- `--log-file`: The target file where the `br` log is written.

During restore, a progress bar is displayed in the terminal as shown below. When the progress bar advances to 100%, the restore task is completed. Then `br` will verify the restored data to ensure data security.
During restore, a progress bar is displayed in the terminal as shown below. When the progress bar advances to 100%, the restore task is completed. After the restoration is complete, if table-level checksum is enabled (see [Checksum](#checksum)), the BR tool performs table data verification to ensure the logical integrity of the data. File-level checksums are always performed to ensure the basic integrity of the restored files.

```shell
Split&Scatter Region <--------------------------------------------------------------------> 100.00%
Expand Down Expand Up @@ -287,3 +287,46 @@ tiup br restore full\
--crypter.method aes128-ctr \
--crypter.key 0123456789abcdef0123456789abcdef
```

## Checksum

Checksum is a method used by the BR tool to verify the integrity of backup and restore data. BR supports two levels of checksums:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

It might be helpful to add a brief introductory sentence before defining checksum to provide context. Make sure the documentation is easy to understand for TiDB users.1

Style Guide References

Suggested change
Checksum is a method used by the BR tool to verify the integrity of backup and restore data. BR supports two levels of checksums:
## Checksum
To ensure data integrity, BR uses checksum, a method to verify the integrity of backup and restore data. BR supports two levels of checksums:

Footnotes

  1. Make sure the documentation is easy to understand for TiDB users. (link)


1. **File-level checksum**: Verifies the backup files themselves to ensure integrity during storage and transmission. This checksum is always enabled and cannot be disabled.
2. **Table-level checksum**: Verifies the integrity of table data content and confirms the business logic consistency of the data. This checksum is disabled by default but can be enabled through parameters.
Copy link
Contributor

@BornChanger BornChanger Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. **Table-level checksum**: Verifies the integrity of table data content and confirms the business logic consistency of the data. This checksum is disabled by default but can be enabled through parameters.
2. **Table-level checksum**: Verifies the integrity of table data content and confirms the business logic consistency of the data. You can choose to enable or disable this checksum.


Balancing performance and security considerations, BR handles table-level checksums as follows:

### Backup Checksum

Starting from v8.5.0, when performing full backups, the BR tool does not calculate table-level checksums by default (`--checksum=false`) to improve backup performance. If you need to calculate table-level checksums during backup, you can explicitly specify `--checksum=true`. File-level checksums will always be calculated to ensure the integrity of backup files.

Calculating table-level checksums can verify data integrity during backup but increases backup time. In most cases, it's safe to use the default setting (no table-level checksum) to improve backup speed.

### Restore Checksum

Starting from v9.0.0, the BR tool does not perform table-level checksum verification (`--checksum=false`) by default during restore operations to improve restore performance. If you need to perform table-level checksum verification, you can explicitly specify `--checksum=true`. File-level checksum verification is always performed to ensure the basic integrity of restored data.

After restoration, data validation is usually performed to ensure data security. When table-level checksums are disabled, the comprehensive validation step for table data is skipped, thereby accelerating the restore process. For scenarios with strict data integrity requirements, you may choose to enable table-level checksums.

### Checksum Configuration Examples

Enable table-level checksums during backup:

```shell
tiup br backup full \
--pd "${PD_IP}:2379" \
--storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
--checksum=true \
--log-file backupfull.log
```

Enable table-level checksums during restore:

```shell
tiup br restore full \
--pd "${PD_IP}:2379" \
--storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
--checksum=true \
--log-file restorefull.log
```
1 change: 1 addition & 0 deletions br/use-br-command-line-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ A `tiup br` command consists of multiple layers of sub-commands. Currently, br c
* `--tikv-max-restore-concurrency`: the maximum number of concurrent tasks per TiKV node during snapshot restore.
* `--compression`: determines the compression algorithm used for generating backup files. It supports `lz4`, `snappy`, and `zstd`, with the default being `zstd` (usually no need to modify). For guidance on choosing different compression algorithms, refer to [this document](https://github.com/EighteenZi/rocksdb_wiki/blob/master/Compression.md).
* `--compression-level`: sets the compression level corresponding to the chosen compression algorithm for backup. The default compression level for `zstd` is 3. In most cases there is no need to set this option.
* `--checksum`: controls whether to perform table-level checksum verification during backup and restore. Default is `false`. For more details, refer to [Checksum](/br/br-snapshot-manual.md#checksum).

## Commands of full backup

Expand Down
Loading