[Doc] Fix the doc mistake related to datacache config (#63888)

Signed-off-by: trueeyu <lxhhust350@qq.com>
Signed-off-by: 絵空事スピリット <wanglichen@starrocks.com>
Co-authored-by: 絵空事スピリット <wanglichen@starrocks.com>
This commit is contained in:
trueeyu 2025-10-11 14:58:28 +08:00 committed by GitHub
parent fe3bef00d1
commit 35aa2cc5ac
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 41 additions and 244 deletions

View File

@ -277,7 +277,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
-->
<!--
##### enable_auto_adjust_pagecache
##### enable_datacache_mem_auto_adjust
- Default: true
- Type: Boolean
@ -310,7 +310,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
-->
<!--
##### pagecache_adjust_period
##### datacache_mem_adjust_period
- Default: 20
- Type: Int
@ -321,7 +321,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
-->
<!--
##### auto_adjust_pagecache_interval_seconds
##### datacache_mem_adjust_interval_seconds
- Default: 10
- Type: Int
@ -4070,40 +4070,40 @@ When this value is set to less than `0`, the system uses the product of its abso
- Description: The maximum amount of data that can be cached on a single disk. You can set it as a percentage (for example, `80%`) or a physical limit (for example, `2T`, `500G`). For example, if you use two disks and set the value of the `datacache_disk_size` parameter as `21474836480` (20 GB), a maximum of 40 GB data can be cached on these two disks. The default value is `0`, which indicates that only memory is used to cache data.
- Introduced in: -
##### datacache_auto_adjust_enable
##### enable_datacache_disk_auto_adjust
- Default: false
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable Automatic Scaling for Data Cache disk capacity. When it is enabled, the system dynamically adjusts the cache capacity based on the current disk usage rate.
- Description: Whether to enable Automatic Scaling for Data Cache disk capacity. When it is enabled, the system dynamically adjusts the cache capacity based on the current disk usage rate. This item is renamed from `datacache_auto_adjust_enable` to `enable_datacache_disk_auto_adjust` from v4.0 onwards.
- Introduced in: v3.3.0
##### datacache_disk_high_level
##### disk_high_level
- Default: 90
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The upper limit of disk usage (in percentage) that triggers the automatic scaling up of the cache capacity. When the disk usage exceeds this value, the system automatically evicts cache data from the Data Cache. From v3.4.0 onwards, the default value is changed from `80` to `90`.
- Description: The upper limit of disk usage (in percentage) that triggers the automatic scaling up of the cache capacity. When the disk usage exceeds this value, the system automatically evicts cache data from the Data Cache. From v3.4.0 onwards, the default value is changed from `80` to `90`. This item is renamed from `datacache_disk_high_level` to `disk_high_level` from v4.0 onwards.
- Introduced in: v3.3.0
##### datacache_disk_safe_level
##### disk_safe_level
- Default: 80
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The safe level of disk usage (in percentage) for Data Cache. When Data Cache performs automatic scaling, the system adjusts the cache capacity with the goal of maintaining disk usage as close to this value as possible. From v3.4.0 onwards, the default value is changed from `70` to `80`.
- Description: The safe level of disk usage (in percentage) for Data Cache. When Data Cache performs automatic scaling, the system adjusts the cache capacity with the goal of maintaining disk usage as close to this value as possible. From v3.4.0 onwards, the default value is changed from `70` to `80`. This item is renamed from `datacache_disk_safe_level` to `disk_safe_level` from v4.0 onwards.
- Introduced in: v3.3.0
##### datacache_disk_low_level
##### disk_low_level
- Default: 60
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The lower limit of disk usage (in percentage) that triggers the automatic scaling down of the cache capacity. When the disk usage remains below this value for the period specified in `datacache_disk_idle_seconds_for_expansion`, and the space allocated for Data Cache is fully utilized, the system will automatically expand the cache capacity by increasing the upper limit.
- Description: The lower limit of disk usage (in percentage) that triggers the automatic scaling down of the cache capacity. When the disk usage remains below this value for the period specified in `datacache_disk_idle_seconds_for_expansion`, and the space allocated for Data Cache is fully utilized, the system will automatically expand the cache capacity by increasing the upper limit. This item is renamed from `datacache_disk_low_level` to `disk_low_level` from v4.0 onwards.
- Introduced in: v3.3.0
##### datacache_disk_adjust_interval_seconds
@ -4142,15 +4142,6 @@ When this value is set to less than `0`, the system uses the product of its abso
- 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: false
- 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
##### datacache_eviction_policy
- Default: slru
@ -4263,7 +4254,7 @@ When this value is set to less than `0`, the system uses the product of its abso
<!--
##### datacache_max_flying_memory_mb
- Default: 256
- Default: 2
- Type: Int
- Unit: MB
- Is mutable: No
@ -4271,17 +4262,6 @@ When this value is set to less than `0`, the system uses the product of its abso
- Introduced in: -
-->
<!--
##### datacache_adaptor_enable
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: No
- Description:
- Introduced in: -
-->
<!--
##### datacache_skip_read_factor
@ -4304,17 +4284,6 @@ When this value is set to less than `0`, the system uses the product of its abso
- Introduced in: -
-->
<!--
##### datacache_engine
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description:
- Introduced in: -
-->
<!--
##### report_datacache_metrics_interval_ms
@ -4329,7 +4298,7 @@ When this value is set to less than `0`, the system uses the product of its abso
<!--
##### block_cache_enable
- Default: false
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: No
@ -4348,39 +4317,6 @@ When this value is set to less than `0`, the system uses the product of its abso
- Introduced in: -
-->
<!--
##### block_cache_disk_path
- Default: `${STARROCKS_HOME}/block_cache/`
- Type: String
- Unit: -
- Is mutable: No
- Description:
- Introduced in: -
-->
<!--
##### block_cache_meta_path
- Default: `${STARROCKS_HOME}/block_cache/`
- Type: String
- Unit: -
- Is mutable: No
- Description:
- Introduced in: -
-->
<!--
##### block_cache_block_size
- Default: 262144
- Type: Int
- Unit:
- Is mutable: No
- Description:
- Introduced in: -
-->
<!--
##### block_cache_mem_size
@ -4393,18 +4329,7 @@ When this value is set to less than `0`, the system uses the product of its abso
-->
<!--
##### block_cache_max_concurrent_inserts
- Default: 1500000
- Type: Int
- Unit:
- Is mutable: No
- Description:
- Introduced in: -
-->
<!--
##### block_cache_checksum_enable
##### datacache_direct_io_enable
- Default: false
- Type: Boolean
@ -4414,28 +4339,6 @@ When this value is set to less than `0`, the system uses the product of its abso
- Introduced in: -
-->
<!--
##### block_cache_direct_io_enable
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: No
- Description:
- Introduced in: -
-->
<!--
##### block_cache_engine
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description:
- Introduced in: -
-->
<!--
##### query_cache_num_lanes_per_driver

View File

@ -1952,40 +1952,40 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- 説明: 単一ディスクにキャッシュできるデータの最大量。パーセンテージ (例: `80%`) または物理的な制限 (例: `2T`、`500G`) として設定できます。たとえば、2 つのディスクを使用し、`datacache_disk_size` パラメータの値を `21474836480` (20 GB) に設定した場合、これらの 2 つのディスクに最大 40 GB のデータをキャッシュできます。デフォルト値は `0` で、これはメモリのみがデータをキャッシュするために使用されることを示します。
- 導入バージョン: -
##### datacache_auto_adjust_enable
##### enable_datacache_disk_auto_adjust
- デフォルト: false
- デフォルト: true
- タイプ: Boolean
- 単位: -
- 可変: はい
- 説明: Data Cache ディスク容量の自動スケーリングを有効にするかどうか。これを有効にすると、システムは現在のディスク使用率に基づいてキャッシュ容量を動的に調整します。
- 説明: Data Cache ディスク容量の自動スケーリングを有効にするかどうか。これを有効にすると、システムは現在のディスク使用率に基づいてキャッシュ容量を動的に調整します。この項目はバージョン4.0以降、`datacache_auto_adjust_enable` から `enable_datacache_disk_auto_adjust` に名称変更されました。
- 導入バージョン: v3.3.0
##### datacache_disk_high_level
##### disk_high_level
- デフォルト: 90
- タイプ: Int
- 単位: -
- 可変: はい
- 説明: キャッシュ容量の自動スケーリングをトリガーするディスク使用率 (パーセンテージ) の上限。この値を超えると、システムは Data Cache からキャッシュデータを自動的に削除します。v3.4.0 以降、デフォルト値は `80` から `90` に変更されました。
- 説明: キャッシュ容量の自動スケーリングをトリガーするディスク使用率 (パーセンテージ) の上限。この値を超えると、システムは Data Cache からキャッシュデータを自動的に削除します。v3.4.0 以降、デフォルト値は `80` から `90` に変更されました。この項目はバージョン4.0以降、`datacache_disk_high_level` から `disk_high_level` に名称変更されました。
- 導入バージョン: v3.3.0
##### datacache_disk_safe_level
##### disk_safe_level
- デフォルト: 80
- タイプ: Int
- 単位: -
- 可変: はい
- 説明: Data Cache のディスク使用率 (パーセンテージ) の安全レベル。Data Cache が自動スケーリングを実行する際、システムはディスク使用率をこの値にできるだけ近づけることを目標にキャッシュ容量を調整します。v3.4.0 以降、デフォルト値は `70` から `80` に変更されました。
- 説明: Data Cache のディスク使用率 (パーセンテージ) の安全レベル。Data Cache が自動スケーリングを実行する際、システムはディスク使用率をこの値にできるだけ近づけることを目標にキャッシュ容量を調整します。v3.4.0 以降、デフォルト値は `70` から `80` に変更されました。この項目はバージョン4.0以降、`datacache_disk_safe_level` から `disk_safe_level` に名称変更されました。
- 導入バージョン: v3.3.0
##### datacache_disk_low_level
##### disk_low_level
- デフォルト: 60
- タイプ: Int
- 単位: -
- 可変: はい
- 説明: キャッシュ容量の自動スケーリングをトリガーするディスク使用率 (パーセンテージ) の下限。ディスク使用率が `datacache_disk_idle_seconds_for_expansion` で指定された期間を超えてこの値を下回り、Data Cache に割り当てられたスペースが完全に利用される場合、システムは上限を増やしてキャッシュ容量を自動的に拡張します。
- 説明: キャッシュ容量の自動スケーリングをトリガーするディスク使用率 (パーセンテージ) の下限。ディスク使用率が `datacache_disk_idle_seconds_for_expansion` で指定された期間を超えてこの値を下回り、Data Cache に割り当てられたスペースが完全に利用される場合、システムは上限を増やしてキャッシュ容量を自動的に拡張します。この項目はバージョン4.0以降、`datacache_disk_low_level` から `disk_low_level` に名称変更されました。
- 導入バージョン: v3.3.0
##### datacache_disk_adjust_interval_seconds
@ -2024,15 +2024,6 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- 説明: Data Cache の効率を最適化するために Block Buffer を有効にするかどうか。Block Buffer が有効な場合、システムは Data Cache から Block データを読み取り、一時バッファにキャッシュし、頻繁なキャッシュ読み取りによる余分なオーバーヘッドを削減します。
- 導入バージョン: v3.2.0
##### datacache_tiered_cache_enable
- デフォルト: false
- タイプ: Boolean
- 単位: -
- 可変: いいえ
- 説明: Data Cache の階層型キャッシュモードを有効にするかどうか。階層型キャッシュモードが有効な場合、Data Cache はメモリとディスクの 2 層のキャッシュで構成されます。ディスクデータがホットデータになると、自動的にメモリキャッシュにロードされ、メモリキャッシュ内のデータがコールドになると、自動的にディスクにフラッシュされます。階層型キャッシュモードが有効でない場合、Data Cache に設定されたメモリとディスクは 2 つの独立したキャッシュスペースを形成し、異なるタイプのデータをキャッシュし、データの流れはありません。
- 導入バージョン: v3.2.5
##### datacache_eviction_policy
- デフォルト: slru

View File

@ -264,7 +264,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
-->
<!--
##### enable_auto_adjust_pagecache
##### enable_datacache_mem_auto_adjust
- 默认值true
- 类型Boolean
@ -297,7 +297,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
-->
<!--
##### pagecache_adjust_period
##### datacache_mem_adjust_period
- 默认值20
- 类型Int
@ -308,7 +308,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
-->
<!--
##### auto_adjust_pagecache_interval_seconds
##### datacache_mem_adjust_interval_seconds
- 默认值10
- 类型Int
@ -4011,40 +4011,40 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- 描述:单个磁盘缓存数据量的上限,可设为比例上限(如 `80%`)或物理上限(如 `2T`, `500G` 等)。假设系统使用了两块磁盘进行缓存,并设置 `datacache_disk_size` 参数值为 `21474836480`,即 20 GB那么最多可缓存 40 GB 的磁盘数据。默认值为 `0`,即仅使用内存作为缓存介质,不使用磁盘。
- 引入版本:-
##### datacache_auto_adjust_enable
##### enable_datacache_disk_auto_adjust
- 默认值:false
- 默认值:true
- 类型Boolean
- 单位:-
- 是否动态:是
- 描述Data Cache 磁盘容量自动调整开关,启用后会根据当前磁盘使用率动态调整缓存容量。
- 描述Data Cache 磁盘容量自动调整开关,启用后会根据当前磁盘使用率动态调整缓存容量。该参数自 v4.0 起由 `datacache_auto_adjust_enable` 更名为 `enable_datacache_disk_auto_adjust`
- 引入版本v3.3.0
##### datacache_disk_high_level
##### disk_high_level
- 默认值90
- 类型Int
- 单位:-
- 是否动态:是
- 描述:Data Cache 磁盘高水位(百分比)。当磁盘使用率高于该值时,系统自动淘汰 Data Cache 中的缓存数据。自 v3.4.0 起,该参数默认值由 `80` 变更为 `90`
- 描述:磁盘高水位(百分比)。当磁盘使用率高于该值时,系统自动淘汰 Data Cache 中的缓存数据。自 v3.4.0 起,该参数默认值由 `80` 变更为 `90`该参数自 v4.0 起由 `datacache_disk_high_level` 更名为 `disk_high_level`
- 引入版本v3.3.0
##### datacache_disk_safe_level
##### disk_safe_level
- 默认值80
- 类型Int
- 单位:-
- 是否动态:是
- 描述:Data Cache 磁盘安全水位(百分比)。当 Data Cache 进行缓存自动扩缩容时,系统将尽可能以该阈值为磁盘使用率目标调整缓存容量。自 v3.4.0 起,该参数默认值由 `70` 变更为 `80`
- 描述:磁盘安全水位(百分比)。当 Data Cache 进行缓存自动扩缩容时,系统将尽可能以该阈值为磁盘使用率目标调整缓存容量。自 v3.4.0 起,该参数默认值由 `70` 变更为 `80`该参数自 v4.0 起由 `datacache_disk_safe_level` 更名为 `disk_safe_level`
- 引入版本v3.3.0
##### datacache_disk_low_level
##### disk_low_level
- 默认值60
- 类型Int
- 单位:-
- 是否动态:是
- 描述:Data Cache 磁盘低水位(百分比)。当磁盘使用率在 `datacache_disk_idle_seconds_for_expansion` 指定的时间内持续低于该值,且用于缓存数据的空间已经写满时,系统将自动进行缓存扩容,增加缓存上限。
- 描述:磁盘低水位(百分比)。当磁盘使用率在 `datacache_disk_idle_seconds_for_expansion` 指定的时间内持续低于该值,且用于缓存数据的空间已经写满时,系统将自动进行缓存扩容,增加缓存上限。该参数自 v4.0 起由 `datacache_disk_low_level` 更名为 `disk_low_level`
- 引入版本v3.3.0
##### datacache_disk_adjust_interval_seconds
@ -4083,15 +4083,6 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- 描述:是否启用 Block Buffer 优化 Data Cache 效率。当启用 Block Buffer 时,系统会从 Data Cache 中读取完整的 Block 数据并缓存在临时 Buffer 中,从而减少频繁读取缓存带来的额外开销。
- 引入版本v3.2.0
##### datacache_tiered_cache_enable
- 默认值false
- 类型Boolean
- 单位:-
- 是否动态:否
- 描述:是否为 Data Cache 启用分层模式。当启用分层模式时Data Cache 配置的的内存和磁盘构成两级缓存,磁盘数据变为热数据时会自动载入到内存缓存,内存缓存中的数据变冷时自动落至磁盘。当不启用分层模式时,为 Data Cache 配置的内存和磁盘构成两个独立的缓存空间,并分别缓存不同类型数据,两者之间不进行数据流动。
- 引入版本v3.2.5
##### datacache_eviction_policy
- 默认值slru
@ -4204,7 +4195,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
<!--
##### datacache_max_flying_memory_mb
- 默认值256
- 默认值2
- 类型Int
- 单位MB
- 是否动态:否
@ -4212,17 +4203,6 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- 引入版本:-
-->
<!--
##### datacache_adaptor_enable
- 默认值true
- 类型Boolean
- 单位:-
- 是否动态:否
- 描述:
- 引入版本:-
-->
<!--
##### datacache_skip_read_factor
@ -4245,17 +4225,6 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- 引入版本:-
-->
<!--
##### datacache_engine
- 默认值:空字符串
- 类型String
- 单位:-
- 是否动态:否
- 描述:
- 引入版本:-
-->
<!--
##### report_datacache_metrics_interval_ms
@ -4270,7 +4239,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
<!--
##### block_cache_enable
- 默认值:false
- 默认值:true
- 类型Boolean
- 单位:-
- 是否动态:否
@ -4281,40 +4250,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
<!--
##### block_cache_disk_size
- 默认值0
- 类型Int
- 单位:
- 是否动态:否
- 描述:
- 引入版本:-
-->
<!--
##### block_cache_disk_path
- 默认值:`${STARROCKS_HOME}/block_cache/`
- 类型String
- 单位:-
- 是否动态:否
- 描述:
- 引入版本:-
-->
<!--
##### block_cache_meta_path
- 默认值:`${STARROCKS_HOME}/block_cache/`
- 类型String
- 单位:-
- 是否动态:否
- 描述:
- 引入版本:-
-->
<!--
##### block_cache_block_size
- 默认值262144
- 默认值:-1
- 类型Int
- 单位:
- 是否动态:否
@ -4325,7 +4261,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
<!--
##### block_cache_mem_size
- 默认值:2147483648
- 默认值:0
- 类型Int
- 单位:
- 是否动态:否
@ -4334,18 +4270,7 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
-->
<!--
##### block_cache_max_concurrent_inserts
- 默认值1500000
- 类型Int
- 单位:
- 是否动态:否
- 描述:
- 引入版本:-
-->
<!--
##### block_cache_checksum_enable
##### datacache_direct_io_enable
- 默认值false
- 类型Boolean
@ -4355,28 +4280,6 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- 引入版本:-
-->
<!--
##### block_cache_direct_io_enable
- 默认值false
- 类型Boolean
- 单位:-
- 是否动态:否
- 描述:
- 引入版本:-
-->
<!--
##### block_cache_engine
- 默认值:空字符串
- 类型String
- 单位:-
- 是否动态:否
- 描述:
- 引入版本:-
-->
<!--
##### query_cache_num_lanes_per_driver