[close #239] Add gcttl and range in readme #240
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: haojinming <jinming.hao@pingcap.com>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #240 +/- ##
================================================
- Coverage 61.2595% 61.2425% -0.0170%
================================================
Files 238 238
Lines 20214 20200 -14
================================================
- Hits 12383 12371 -12
+ Misses 6691 6690 -1
+ Partials 1140 1139 -1
*This pull request uses carry forward flags. Click here to find out more.
|
Signed-off-by: haojinming <jinming.hao@pingcap.com>
Signed-off-by: haojinming <jinming.hao@pingcap.com>
pingyu
reviewed
Sep 26, 2022
br/README.md
Outdated
| --log-file="/tmp/br_backup.log | ||
| --log-file="/tmp/br_backup.log \ | ||
| --gcttl=5m \ | ||
| --start=&{START_KEY} \ |
br/README-cn.md
Outdated
| @@ -61,10 +69,14 @@ tikv-br backup raw --pd "&{PDIP}:2379" -s "local:///tmp/backup" --dst-api-versio | |||
| - `"${PDIP}:2379"`：`--pd` 的参数 | |||
| - `--dst-api-version`: 指定备份文件的 `api-version`，请见 [tikv-server config](https://docs.pingcap.com/zh/tidb/stable/tikv-configuration-file#api-version-%E4%BB%8E-v610-%E7%89%88%E6%9C%AC%E5%BC%80%E5%A7%8B%E5%BC%95%E5%85%A5) | |||
| - `v2`: `--dst-api-version` 的参数，可选参数为 `v1`，`v1ttl`，`v2`(不区分大小写)，如果不指定 `dst-api-version` 参数，则备份文件的 `api-version` 与指定 `--pd` 所属的 TiKV 集群 `api-version` 相同。 | |||
| - `gcttl`: GC 暂停时间周期。可用于确保从存量数据备份到启动 TiKV-CDC 的这段时间内，增量数据不会被 GC 清除。默认为 5 分钟。 | |||
| - `5m`: `gcttl` 的参数，数据格式为`数字 + 时间单位`, 例如 `24h` 表示 24 小时，`60m` 表示 60 分钟。 | |||
| - `start`, `end`: 用于生成需要备份的数据区间，为左闭右开区间 `[start, end)`。默认为`["", "")`， 即全部数据。 | |||
There was a problem hiding this comment.
Suggested change
| - `start`, `end`: 用于生成需要备份的数据区间，为左闭右开区间 `[start, end)`。默认为`["", "")`， 即全部数据。 | |
| - `start`, `end`: 用于指定需要备份的数据区间，为左闭右开区间 `[start, end)`。默认为`["", "")`， 即全部数据。 |
br/README.md
Outdated
| @@ -109,6 +113,10 @@ Explanations for some options in the above command are as follows: | |||
| - `"${PDIP}:2379"`: Parameter of `--pd`. | |||
| - `--dst-api-version`: The `api-version`, please see [tikv-server config](https://docs.pingcap.com/tidb/stable/tikv-configuration-file#api-version-new-in-v610). | |||
| - `v2`: Parameter of `--dst-api-version`, the optionals are `v1`, `v1ttl`, `v2`(Case insensitive). If no `dst-api-version` is specified, the `api-version` is the same with TiKV cluster of `--pd`. | |||
| - `gcttl`: The stop duration of GC. This can be used to make sure that the incremental data from backup start to TiKV-CDC take effective will NOT be deleted by GC. 5 minutes by default. | |||
| - `5m`: Paramater of `gcttl`. It's format is `number + unit`, e.g. `24h` means 24 hours, `60m` means 60 minutes. | |||
There was a problem hiding this comment.
Suggested change
| - `5m`: Paramater of `gcttl`. It's format is `number + unit`, e.g. `24h` means 24 hours, `60m` means 60 minutes. | |
| - `5m`: Paramater of `gcttl`. Its format is `number + unit`, e.g. `24h` means 24 hours, `60m` means 60 minutes. |
There was a problem hiding this comment.
Addressed all comments, PTAL, thanks.
Signed-off-by: haojinming <jinming.hao@pingcap.com>
Signed-off-by: haojinming <jinming.hao@pingcap.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: haojinming jinming.hao@pingcap.com
What problem does this PR solve?
Issue Number: close #239
Problem Description:
What is changed and how does it work?
Supply the paramater description in TiKV-BR README.md and README-cn.md
Code changes
Check List for Tests
This PR has been tested by at least one of the following methods:
Side effects
Related changes