[Doc] Add Variables (#62171)

This commit is contained in:
絵空事スピリット 2025-08-22 17:36:29 +08:00 committed by GitHub
parent b8bd5362f4
commit 71b51eec1f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 126 additions and 0 deletions

View File

@ -1259,3 +1259,45 @@ The StarRocks version. Cannot be changed.
* **Description**: Used to specify how columns are matched when StarRocks reads ORC files from Hive. The default value is `false`, which means columns in ORC files are read based on their ordinal positions in the Hive table definition. If this variable is set to `true`, columns are read based on their names.
* **Default**: false
* **Introduced in**: v3.1.10
### enable_phased_scheduler
* **Description**: Whether to enable multi-phased scheduling. When multi-phased scheduling is enabled, it will schedule fragments according to their dependencies. For example, the system will first schedule the fragment on the build side of a Shuffle Join, and then the fragment on the probe side (Note that, unlike stage-by-stage scheduling, phased scheduling is still under the MPP execution mode). Enabling multi-phased scheduling can significantly reduce memory usage for a large number of UNION ALL queries.
* **Default**: false
* **Introduced in**: v3.3
### phased_scheduler_max_concurrency
* **Description**: The concurrency for phased scheduler scheduling leaf node fragments. For example, the default value means that, in a large number of UNION ALL Scan queries, at most two scan fragments are allowed to be scheduled at the same time.
* **Default**: 2
* **Introduced in**: v3.3
### enable_wait_dependent_event
* **Description**: Whether Pipeline waits for a dependent operator to finish execution before continuing within the same fragment. For example, in a left join query, when this feature is enabled, the probe-side operator waits for the build-side operator to finish before it starts executing. Enabling this feature can reduce memory usage, but may increase the query latency. However, for queries reused in CTE, enabling this feature may increase memory usage.
* **Default**: false
* **Introduced in**: v3.3
### enable_topn_runtime_filter
* **Description**: Whether to enable TopN Runtime Filter. If this feature is enabled, a runtime filter will be dynamically constructed for ORDER BY LIMIT queries and pushed down to the scan for filtering.
* **Default**: true
* **Introduced in**: v3.3
### enable_partition_hash_join
* **Description**: Whether to enable adaptive Partition Hash Join.
* **Default**: true
* **Introduced in**: v3.4
### spill_enable_direct_io
* **Description**: Whether to skip Page Cache when reading or writing files for Spilling. If this feature is enabled, Spilling will use direct I/O mode to read or write files directly. Direct I/O mode can reduce the impact on the OS Page Cache, but it may cause increases in disk read/write time.
* **Default**: false
* **Introduced in**: v3.4
### spill_enable_compaction
* **Description**: Whether to enable Compaction for small files from Spilling. When this feature is enabled, it reduces memory usage for aggregation and sorting.
* **Default**: true
* **Introduced in**: v3.4

View File

@ -1242,3 +1242,45 @@ StarRocks のバージョン。変更できません。
* **説明**: StarRocks が Hive から ORC ファイルを読み取る際に列がどのように一致するかを指定するために使用されます。デフォルト値は `false` で、ORC ファイル内の列は Hive テーブル定義内の順序位置に基づいて読み取られます。この変数が `true` に設定されている場合、列は名前に基づいて読み取られます。
* **デフォルト**: false
* **導入バージョン**: v3.1.10
### enable_phased_scheduler
* **説明**: マルチフェーズスケジューリングを有効にするかどうか。マルチフェーズスケジューリングを有効にすると、フラグメントは依存関係に基づいてスケジューリングされます。例えば、システムはまず Shuffle Join の Build side のフラグメントをスケジュールし、次に Probe side のフラグメントをスケジュールします(注:ステージごとのスケジュールとは異なり、フェーズごとのスケジュールは依然として MPP 実行モード下で実行されます。マルチフェーズスケジューリングを有効にすると、多数のUNION ALLクエリにおけるメモリ使用量を大幅に削減できます。
* **デフォルト**: false
* **導入バージョン**: v3.3
### phased_scheduler_max_concurrency
* **説明**: フェーズドスケジューラーによるリーフノード フラグメントのスケジューリングにおける並列処理。例えば、デフォルト値は、多数の UNION ALL スキャン クエリにおいて、同時にスケジューリングされるスキャン フラグメントは最大で 2 つまで許可されることを意味します。
* **デフォルト**: 2
* **導入バージョン**: v3.3
### enable_wait_dependent_event
* **説明**: パイプラインが、同じフラグメント内で依存するオペレーターの実行が完了するまで待機するかどうか。例えば、Left Join クエリにおいて、この機能が有効になっている場合、Probe side オペレーターは Build side オペレーターの実行が完了するまで待機し、その後実行を開始します。この機能を有効にするとメモリ使用量を削減できますが、クエリの遅延が増加する可能性があります。ただし、CTE で再利用されるクエリの場合、この機能を有効にするとメモリ使用量が増加する可能性があります。
* **デフォルト**: false
* **導入バージョン**: v3.3
### enable_topn_runtime_filter
* **説明**: TopN Runtime Filter を有効にするかどうか。この機能を有効にすると、ORDER BY LIMIT クエリに対して動的に Runtime Filter が構築され、Scan 段階にプッシュダウンされてフィルタリングに利用されます。
* **デフォルト**: true
* **導入バージョン**: v3.3
### enable_partition_hash_join
* **説明**: 適応型 Partition Hash Join を有効にするかどうか。
* **デフォルト**: true
* **導入バージョン**: v3.4
### spill_enable_direct_io
* **説明**: Spilling 機能を使用する際、ファイルの読み書き時に Page Cache をスキップするかどうか。この機能が有効になっている場合、Spilling は直接 I/O モードを使用してファイルを直接読み書きします。直接 I/O モードは OS の Page Cache への影響を軽減できますが、ディスクの読み書き時間が延長される可能性があります。
* **デフォルト**: false
* **導入バージョン**: v3.4
### spill_enable_compaction
* **説明**: Spilling から小さなファイルに対する Compaction を有効にするかどうか。この機能を有効にすると、集約と並べ替え時のメモリ使用量を削減します。
* **デフォルト**: true
* **導入バージョン**: v3.4

View File

@ -1263,3 +1263,45 @@ MySQL 服务器的版本,取值等于 FE 参数 `mysql_server_version`。
* 描述:设置通过 Hive Catalog 读取 ORC 文件时,列的对应方式。默认值是 `false`,即按照 Hive 表中列的顺序对应。如果设置为 `true`,则按照列名称对应。
* 引入版本v3.1.10
### enable_phased_scheduler
* 描述: 是否启用多阶段调度。当启用多阶段调度时,系统将根据 Fragment 之间的依赖关系进行调度。例如,系统将首先调度 Shuffle Join 的 Build Side Fragment ,然后调度 Probe Side Fragment (注意,与分阶段调度不同,多阶段调度仍处于 MPP 执行模式下)。启用多阶段调度可显著降低大量 UNION ALL 查询的内存使用量。
* 默认值: false
* 引入版本: v3.3
### phased_scheduler_max_concurrency
* 描述: 多阶段调度器调度 Leaf Node Fragment 的并发度。例如,默认值表示在大量 UNION ALL Scan 查询中,最多允许同时调度两个 Scan Fragment。
* 默认值: 2
* 引入版本: v3.3
### enable_wait_dependent_event
* 描述: 在同一 Fragment 内Pipeline 是否等待依赖的 Operator 完成执行后再继续执行。例如,在 Left Join 查询中当启用此功能时Probe Side Operator 会在 Build Side Operator 完成执行后再开始执行。启用此功能可减少内存使用但可能增加查询延迟。然而对于在CTE中重用的查询启用此功能可能增加内存使用。
* 默认值: false
* 引入版本: v3.3
### enable_topn_runtime_filter
* 描述: 是否启用 TopN Runtime Filter。如果启用此功能对于 ORDER BY LIMIT 查询,将动态构建一个 Runtime Filter 并将其下推到 Scan 阶段进行过滤。
* 默认值: true
* 引入版本: v3.3
### enable_partition_hash_join
* 描述: 是否启用自适应 Partition Hash Join。
* 默认值: true
* 引入版本: v3.4
### spill_enable_direct_io
* 描述: 是否在 Spill 读写文件时跳过 Page Cache。如果启用此功能Spill 将使用直接 I/O 模式直接读写文件。直接 I/O 模式可以减少对操作系统 Page Cache 的影响,但可能会导致磁盘读写时间增加。
* 默认值: false
* 引入版本: v3.4
### spill_enable_compaction
* 描述: 是否对 Spill 小文件启用 Compaction。启用此功能后可减少聚合和排序操作的内存使用量。
* 默认值: true
* 引入版本: v3.4