You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: br/br-pitr-manual.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -409,7 +409,8 @@ Expected output:
409
409
410
410
>**Note:**
411
411
>
412
-
> 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.
412
+
> - 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.
413
+
> - For information about checksum configuration, see [Checksum](/br/br-snapshot-manual.md#checksum).
413
414
414
415
You can run the `tiup br restore point`command to perform a PITR on a new cluster or just restore the log backup data.
For more information about snapshot backup and restore, refer to:
26
27
@@ -46,8 +47,7 @@ In the preceding command:
46
47
47
48
> **Note:**
48
49
>
49
-
> - 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.
50
-
> - 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.
50
+
> 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.
51
51
52
52
During backup, a progress bar is displayed in the terminal, as shown below. When the progress bar advances to 100%, the backup is complete.
53
53
@@ -186,7 +186,7 @@ In the preceding command:
186
186
-`--ratelimit`: The maximum speed **per TiKV** performing restore tasks. The unit is in MiB/s.
187
187
-`--log-file`: The target file where the `br` log is written.
188
188
189
-
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.
189
+
During restore, a progress bar is displayed in the terminal as shown in the following example. When the progress bar advances to 100%, the restore task is completed. After the restore is complete, if table-level [checksum](#checksum) is enabled, the BR tool performs data verification on the table to ensure logical integrity of the data. Note that file-level checksums are always performed to ensure the basic integrity of the restored files.
190
190
191
191
```shell
192
192
Split&Scatter Region <--------------------------------------------------------------------> 100.00%
@@ -311,3 +311,46 @@ tiup br restore full\
311
311
--crypter.method aes128-ctr \
312
312
--crypter.key 0123456789abcdef0123456789abcdef
313
313
```
314
+
315
+
## Checksum
316
+
317
+
Checksum is a method used by the BR tool to verify the integrity of backup and restore data. BR supports two levels of checksums:
318
+
319
+
1.**File-level checksum**: verifies the backup files themselves to ensure integrity during storage and transmission. This level of checksum is always enabled and cannot be disabled.
320
+
2.**Table-level checksum**: verifies the integrity of table data and ensures the business logic consistency of the data. This level of checksum is disabled by default, and you can enable it using a parameter.
321
+
322
+
The following sections describe how BR handles table-level checksums, balancing performance and data safety considerations.
323
+
324
+
### Backup checksum
325
+
326
+
Starting from v8.5.0, when performing full backups, the BR tool does not perform table-level checksum verification (`--checksum=false`) by default to improve backup performance. If you need to perform table-level checksums during backup, you can explicitly specify `--checksum=true`. File-level checksums are always performed to ensure the integrity of backup files.
327
+
328
+
Performing table-level checksums can verify data integrity during backup but increases backup time. In most cases, it is safe to use the default setting (that is, table-level checksum is disabled) to improve backup speed.
329
+
330
+
### Restore checksum
331
+
332
+
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.
333
+
334
+
After the restore is complete, data verification is usually performed to ensure data integrity. If the table-level checksum is disabled, the comprehensive verification of table data is skipped, which accelerates the restore process. For scenarios that require strict data integrity, you can enable the table-level checksum.
Copy file name to clipboardExpand all lines: br/use-br-command-line-tool.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,6 +62,7 @@ A `tiup br` command consists of multiple layers of sub-commands. Currently, br c
62
62
*`--tikv-max-restore-concurrency`: the maximum number of concurrent tasks per TiKV node during snapshot restore.
63
63
*`--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).
64
64
*`--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.
65
+
*`--checksum`: controls whether to perform table-level checksum verification during backup and restore. The default value is `false`, meaning that checksum verification is not performed. For more details, see [Checksum](/br/br-snapshot-manual.md#checksum).
0 commit comments