Skip to content

Commit aa7ab94

Browse files
JoyinqinTomShawn
andauthored
br: update docs for gc life time (pingcap#4001)
* br: update docs for gc life time * Update backup-and-restore-tool.md * Update backup-and-restore-tool.md * Apply suggestions from code review * remove note format to fix a possible display issue * make ci happy * make ci happy Co-authored-by: TomShawn <[email protected]>
1 parent 95c0b75 commit aa7ab94

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

br/backup-and-restore-tool.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ Each of the above three sub-commands might still include the following three sub
195195

196196
To back up the cluster data, use the `br backup` command. You can add the `full` or `table` sub-command to specify the scope of your backup operation: the whole cluster or a single table.
197197

198-
If the backup time might exceed the [`tikv_gc_life_time`](/garbage-collection-configuration.md#tikv_gc_life_time) configuration which is `10m0s` by default (`10m0s` means 10 minutes), increase the value of this configuration.
198+
If the BR version is earlier than v4.0.3, and the backup duration might exceed the [`tikv_gc_life_time`](/garbage-collection-configuration.md#tikv_gc_life_time) configuration which is `10m0s` by default (`10m0s` means 10 minutes), increase the value of this configuration item.
199199

200200
For example, set `tikv_gc_life_time` to `720h`:
201201

@@ -206,6 +206,8 @@ mysql -h${TiDBIP} -P4000 -u${TIDB_USER} ${password_str} -Nse \
206206
"update mysql.tidb set variable_value='720h' where variable_name='tikv_gc_life_time'";
207207
```
208208

209+
Since v4.0.3, BR automatically adapts to GC and you do not need to manually adjust the `tikv_gc_life_time` value.
210+
209211
### Back up all the cluster data
210212

211213
To back up all the cluster data, execute the `br backup full` command. To get help on this command, execute `br backup full -h` or `br backup full --help`.
@@ -265,7 +267,7 @@ br backup db \
265267
--log-file backuptable.log
266268
```
267269

268-
In the above command, `--db` specifies the name of the database to be backed up. For descriptions of other options, see [Back up all the cluster data](/br/backup-and-restore-tool.md#back-up-all-the-cluster-data).
270+
In the above command, `--db` specifies the name of the database to be backed up. For descriptions of other options, see [Back up all the cluster data](/br/backup-and-restore-tool.md#back-up-cluster-data).
269271

270272
A progress bar is displayed in the terminal during the backup. When the progress bar advances to 100%, the backup is complete. Then the BR also checks the backup data to ensure data safety.
271273

@@ -294,7 +296,7 @@ The `table` sub-command has two options:
294296
* `--db`: specifies the database name
295297
* `--table`: specifies the table name.
296298

297-
For descriptions of other options, see [Back up all cluster data](#back-up-all-the-cluster-data).
299+
For descriptions of other options, see [Back up all cluster data](#back-up-cluster-data).
298300

299301
A progress bar is displayed in the terminal during the backup operation. When the progress bar advances to 100%, the backup is complete. Then the BR also checks the backup data to ensure data safety.
300302

0 commit comments

Comments
 (0)