Skip to content

Commit

Permalink
add the memory requirements for TiKV IME (pingcap#20440)
Browse files Browse the repository at this point in the history
  • Loading branch information
qiancai authored Mar 4, 2025
1 parent db54503 commit 6f3959b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 3 additions & 1 deletion tikv-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -2513,7 +2513,9 @@ TiKV MVCC in-memory engine (IME) configuration items related to the storage laye
> You can configure this configuration item in the configuration file, but cannot query it via SQL statements.
+ Whether to enable the in-memory engine to accelerate multi-version queries. For more information about the in-memory engine, see [TiKV MVCC In-Memory Engine](/tikv-in-memory-engine.md)
+ Default value: `false` (indicating the in-memory engine is disabled)
+ Default value: `false` (in-memory engine is disabled)
+ It is recommended to configure at least 8 GiB of memory for the TiKV node, with 32 GiB or more for optimal performance.
+ If the available memory for the TiKV node is insufficient, the in-memory engine will not be enabled even if this configuration item is set to `true`. In such cases, check the TiKV log file for messages containing `"in-memory engine is disabled because"` to learn why the in-memory engine is not enabled.

### `capacity` <span class="version-mark">New in v8.5.0</span>

Expand Down
2 changes: 2 additions & 0 deletions tikv-in-memory-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ To enable the TiKV MVCC in-memory engine (IME), you need to adjust the [TiKV con
```toml
[in-memory-engine]
# This parameter is the switch for the in-memory engine feature, which is disabled by default. You can set it to true to enable it.
# It is recommended to configure at least 8 GiB of memory for the TiKV node, with 32 GiB or more for optimal performance.
# If the available memory for the TiKV node is insufficient, the in-memory engine will not be enabled even if this configuration item is set to true. In such cases, check the TiKV log file for messages containing "in-memory engine is disabled because" to learn why the in-memory engine is not enabled.
enable = false

# This parameter controls the memory size available to the in-memory engine.
Expand Down

0 comments on commit 6f3959b

Please sign in to comment.