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: update warnings about enable-ttl (#8856) #8913

Merged
merged 5 commits into from
Apr 7, 2022
Merged

TiKV config: update warnings about enable-ttl (#8856) #8913

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f94ec89
TiKV config: update warnings about `enable-ttl`
en-jin19 Apr 6, 2022
ebc20a7
Update tikv-configuration-file.md
en-jin19 Apr 6, 2022
05620ca
revise the order
en-jin19 Apr 6, 2022
fb2bae4
Update tikv-configuration-file.md
en-jin19 Apr 6, 2022
4279cc4
Apply suggestions from code review
en-jin19 Apr 6, 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
11 changes: 5 additions & 6 deletions tikv-configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,14 +368,13 @@ TiKV 配置文件比命令行参数支持更多的选项。你可以在 [etc/con

### `enable-ttl`

+ TTL 即 Time to live。数据超过 TTL 时间后会被自动删除。用户需在客户端写入请求中指定 TTL。不指定 TTL 即表明相应数据不会被自动删除。
+ 默认值：false

> **警告：**
>
> TTL 暂时只适用于 RawKV 接口。由于所涉及底层数据格式不同，你只能在新建集群时设置该功能。
> **禁止**在已有集群上修改该项配置，否则会导致启动报错。
> **禁止**在有 TiDB 节点的集群中使用该参数，以免导致数据写坏等严重后果。
> - 你**只能**在部署新的 TiKV 集群时将 `enable-ttl` 的值设置为 `true` 或 `false`，**不能**在已有的 TiKV 集群中修改该配置项的值。由于该配置项为 `true` 和 `false` 的 TiKV 集群所存储的数据格式不相同，如果你在已有的 TiKV 集群中修改该配置项的值，会造成不同格式的数据存储在同一个集群，导致重启对应的 TiKV 集群时 TiKV 报 "can't enable ttl on a non-ttl instance" 错误。
> - 你**只能**在 TiKV 集群中使用 `enable-ttl`，**不能**在有 TiDB 节点的集群中使用该配置项（即在此类集群中把 `enable-ttl` 设置为 `true`），否则会导致数据损坏、TiDB 集群升级失败等严重后果。

+ TTL 即 Time to live。数据超过 TTL 时间后会被自动删除。用户需在客户端写入请求中指定 TTL。不指定 TTL 即表明相应数据不会被自动删除。
+ 默认值：false

### `ttl-check-poll-interval`

Expand Down