Skip to content

Commit

Permalink
[Doc] Update the document to add some BE configurations related to da…
Browse files Browse the repository at this point in the history
…tacache and query pool. (#51282)

Signed-off-by: GavinMar <[email protected]>
Signed-off-by: 絵空事スピリット <[email protected]>
Co-authored-by: 絵空事スピリット <[email protected]>
  • Loading branch information
GavinMar and EsoragotoSpirit authored Sep 24, 2024
1 parent 801b191 commit a60ea58
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/en/administration/management/BE_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4008,6 +4008,33 @@ When this value is set to less than `0`, the system uses the product of its abso
- Description: The minimum effective capacity for Data Cache Automatic Scaling. If the system tries to adjust the cache capacity to less than this value, the cache capacity will be directly set to `0` to prevent suboptimal performance caused by frequent cache fills and evictions due to insufficient cache capacity.
- Introduced in: v3.3.0

##### datacache_block_buffer_enable

- Default: true
- Type: Boolean
- Unit: -
- Is mutable: No
- Description: Whether to enable Block Buffer to optimize Data Cache efficiency. When Block Buffer is enabled, the system reads the Block data from the Data Cache and caches it in a temporary buffer, thus reducing the extra overhead caused by frequent cache reads.
- Introduced in: v3.2.0

##### datacache_tiered_cache_enable

- Default: true
- Type: Boolean
- Unit: -
- Is mutable: No
- Description: Whether to enable tiered cache mode for Data Cache. When tiered cache mode is enabled, Data Cache is configured with two layers of caching, memory and disk. When disk data becomes hot data, it is automatically loaded into the memory cache, and when the data in the memory cache becomes cold, it is automatically flushed to disk. When tiered cache mode is not enabled, the memory and disk configured for Data Cache form two separate cache spaces and cache different types of data, with no data flow between them.
- Introduced in: v3.2.5

##### query_max_memory_limit_percent

- Default: 90
- Type: Int
- Unit: -
- Is mutable: No
- Description: The maximum memory that the Query Pool can use. It is expressed as a percentage of the Process memory limit.
- Introduced in: v3.1.0

<!--
##### datacache_block_size
Expand Down
27 changes: 27 additions & 0 deletions docs/zh/administration/management/BE_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3970,6 +3970,33 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- 描述:Data Cache 自动扩缩容时的最小有效容量。当需要调整的目标容量小于该值时,系统会直接将缓存空间调整为 `0`,以避免缓存空间过小导致频繁填充和淘汰带来负优化。
- 引入版本:v3.3.0

##### datacache_block_buffer_enable

- 默认值:true
- 类型:Boolean
- 单位:-
- 是否动态:否
- 描述:是否启用 Block Buffer 优化 Data Cache 效率。当启用 Block Buffer 时,系统会从 Data Cache 中读取完整的 Block 数据并缓存在临时 Buffer 中,从而减少频繁读取缓存带来的额外开销。
- 引入版本:v3.2.0

##### datacache_tiered_cache_enable

- 默认值:true
- 类型:Boolean
- 单位:-
- 是否动态:否
- 描述:是否为 Data Cache 启用分层模式。当启用分层模式时,Data Cache 配置的的内存和磁盘构成两级缓存,磁盘数据变为热数据时会自动载入到内存缓存,内存缓存中的数据变冷时自动落至磁盘。当不启用分层模式时,为 Data Cache 配置的内存和磁盘构成两个独立的缓存空间,并分别缓存不同类型数据,两者之间不进行数据流动。
- 引入版本:v3.2.5

##### query_max_memory_limit_percent

- 默认值:90
- 类型:Int
- 单位:-
- 是否动态:否
- 描述:Query Pool 能够使用的最大内存上限。以 Process 内存上限的百分比来表示。
- 引入版本:v3.1.0

<!--
##### datacache_block_size
Expand Down

0 comments on commit a60ea58

Please sign in to comment.