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

add the memory requirements for TiKV IME #19968

Merged
merged 2 commits into from
Mar 4, 2025
Merged

add the memory requirements for TiKV IME #19968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8184e7
add the memory requirements for TiKV IME
qiancai Mar 3, 2025
64b6f32
update descriptions
qiancai Mar 3, 2025
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
2 changes: 2 additions & 0 deletions tikv-configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2517,6 +2517,8 @@ TiKV MVCC 内存引擎 (In-Memory Engine) 在 TiKV 存储层相关的配置项

+ 是否开启内存引擎以加速多版本查询。关于内存引擎的详细信息，参见 [TiKV MVCC 内存引擎](/tikv-in-memory-engine.md)。
+ 默认值：false（即关闭内存引擎）
+ 建议 TiKV 节点至少配置 8 GiB 内存，推荐配置 32 GiB 或更多内存以获得更佳性能。
+ 如果 TiKV 可用内存过低，即使将该配置项设置为 `true`，内存引擎也不会被启用。此时，你可以在 TiKV 的日志文件中查找与 `"in-memory engine is disabled because"` 相关的日志信息，以判断为何内存引擎未能启用。

### `capacity` <span class="version-mark">从 v8.5.0 版本开始引入</span>

Expand Down
2 changes: 2 additions & 0 deletions tikv-in-memory-engine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ TiKV MVCC 内存引擎在内存中缓存最近写入的 MVCC 版本，并实现
```toml
[in-memory-engine]
# 该参数为内存引擎功能的开关，默认为 false，调整为 true 即可开启。
# 建议 TiKV 节点至少配置 8 GiB 内存，推荐配置 32 GiB 或更多内存以获得更佳性能。
# 如果 TiKV 可用内存过低，即使将该配置项设置为 true，内存引擎也不会被启用。此时，你可以在 TiKV 的日志文件中查找与 "in-memory engine is disabled because" 相关的日志信息，以判断为何内存引擎未能启用。
enable = false

# 该参数控制内存引擎可使用的内存大小。默认值为系统内存的 10%，同时最大值为 5 GiB，
Expand Down