diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index e4c3c4ebcec32..58c7b2a441f58 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -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` New in v8.5.0 diff --git a/tikv-in-memory-engine.md b/tikv-in-memory-engine.md index 76ffd9068ae46..bf7fbb4f1fa75 100644 --- a/tikv-in-memory-engine.md +++ b/tikv-in-memory-engine.md @@ -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.