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

TiKV config: add warnings about enable-ttl (#8069) #8234

Merged
merged 13 commits into from
Apr 15, 2022
Merged

TiKV config: add warnings about enable-ttl (#8069) #8234

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5a42fbd
TiKV config: add warnings about `enable-ttl`
en-jin19 Apr 6, 2022
a0bfdf2
revise the order of the warning part
en-jin19 Apr 6, 2022
5d2aea6
remove an extra line
en-jin19 Apr 6, 2022
6bfedf0
Update tikv-configuration-file.md
en-jin19 Apr 6, 2022
cf3e50d
revise orders
en-jin19 Apr 6, 2022
53d80fb
Apply suggestions from code review
en-jin19 Apr 6, 2022
72c1f3a
update translations according to Chinese contents
en-jin19 Apr 7, 2022
6ce0f8a
Apply suggestions from code review
en-jin19 Apr 7, 2022
1349aba
Apply suggestions from code review
en-jin19 Apr 11, 2022
e507048
Apply suggestions from code review
en-jin19 Apr 12, 2022
402f6c4
Apply suggestions from code review
en-jin19 Apr 12, 2022
28725dc
Apply suggestions from code review
en-jin19 Apr 12, 2022
67702c2
Apply suggestions from code review
en-jin19 Apr 13, 2022
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
6 changes: 5 additions & 1 deletion tikv-configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,8 +368,12 @@ Configuration items related to storage.

### `enable-ttl`

> **Warning:**
>
> - Set `enable-ttl` to `true` or `false` **ONLY WHEN** deploying a new TiKV cluster. **DO NOT** modify the value of this configuration item in an existing TiKV cluster. TiKV clusters with different `enable-ttl` values use different data formats. Therefore, if you modify the value of this item in an existing TiKV cluster, the cluster will store data in different formats, which causes the "can't enable TTL on a non-ttl" error when you restart the TiKV cluster.
> - Use `enable-ttl` **ONLY IN** a TiKV cluster. **DO NOT** use this configuration item in a cluster that has TiDB nodes (which means setting `enable-ttl` to `true` in such clusters). Otherwise, critical issues such as data corruption and the upgrade failure of TiDB clusters will occur.

+ TTL is short for "Time to live". If this item is enabled, TiKV automatically deletes data that reaches its TTL. To set the value of TTL, you need to specify it in the requests when writing data via the client. If the TTL is not specified, it means that TiKV does not automatically delete the corresponding data.
+ Note: The TTL feature is only available for the RawKV interface for now. You can only configure this feature when creating a new cluster because TTL uses different data formats in the storage layer. If you modify this item on an existing cluster, TiKV reports errors when it starts.
+ Default value: `false`

### `ttl-check-poll-interval`
Expand Down