You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@impala.apache.org by la...@apache.org on 2026/07/22 19:12:01 UTC
(impala) 01/03: IMPALA-14156: [DOCS] Documentation for query options
This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/impala.git
commit 407be0e24e0ac1422f762f790de378e15b01cc7a
Author: m-sanjana19 <ma...@gmail.com>
AuthorDate: Mon Jun 22 22:30:32 2026 +0530
IMPALA-14156: [DOCS] Documentation for query options
Adds documentation for the following query options, following the
existing descriptions in ImpalaService.thrift:
- COMPUTE_PROCESSING_COST
- PROCESSING_COST_MIN_THREADS
- MAX_FRAGMENT_INSTANCES_PER_NODE
Change-Id: I435c5eb65d049558eb6ec3fea1bc1572cba0669d
Reviewed-on: http://gerrit.cloudera.org:8080/24492
Tested-by: Impala Public Jenkins <im...@cloudera.com>
Reviewed-by: Peter Rozsa <pr...@cloudera.com>
Reviewed-by: Noemi Pap-Takacs <np...@cloudera.com>
---
docs/impala.ditamap | 3 ++
docs/topics/impala_compute_processing_cost.xml | 48 ++++++++++++++++++++++
.../impala_max_fragment_instances_per_node.xml | 47 +++++++++++++++++++++
docs/topics/impala_processing_cost_min_threads.xml | 47 +++++++++++++++++++++
4 files changed, 145 insertions(+)
diff --git a/docs/impala.ditamap b/docs/impala.ditamap
index ea9c1b15d..5e6a54685 100644
--- a/docs/impala.ditamap
+++ b/docs/impala.ditamap
@@ -193,6 +193,7 @@ under the License.
<topicref rev="2.10.0 IMPALA-3200" href="topics/impala_buffer_pool_limit.xml"/>
<topicref href="topics/impala_compression_codec.xml"/>
<topicref href="topics/impala_compute_stats_min_sample_size.xml"/>
+ <topicref href="topics/impala_compute_processing_cost.xml"/>
<topicref href="topics/impala_debug_action.xml"/>
<topicref rev="2.9.0" href="topics/impala_decimal_v2.xml"/>
<topicref rev="3.2.0" href="topics/impala_default_file_format.xml"/>
@@ -222,6 +223,7 @@ under the License.
<topicref href="topics/impala_live_progress.xml"/>
<topicref href="topics/impala_live_summary.xml"/>
<topicref href="topics/impala_max_errors.xml"/>
+ <topicref href="topics/impala_max_fragment_instances_per_node.xml"/>
<topicref rev="3.1 IMPALA-6847" href="topics/impala_max_mem_estimate_for_admission.xml"/>
<topicref rev="2.5.0" href="topics/impala_max_num_runtime_filters.xml"/>
<topicref href="topics/impala_max_result_spooling_mem.xml"/>
@@ -247,6 +249,7 @@ under the License.
<topicref href="topics/impala_parquet_read_page_index.xml"/>
<topicref href="topics/impala_parquet_write_page_index.xml"/>
<topicref rev="2.6.0 IMPALA-3286" href="topics/impala_prefetch_mode.xml"/>
+ <topicref rev="2.6.0 IMPALA-3286" href="topics/impala_processing_cost_min_threads.xml"/>
<topicref href="topics/impala_query_timeout_s.xml"/>
<topicref href="topics/impala_refresh_updated_hms.xml"/>
<topicref rev="2.7.0" href="topics/impala_replica_preference.xml"/>
diff --git a/docs/topics/impala_compute_processing_cost.xml b/docs/topics/impala_compute_processing_cost.xml
new file mode 100644
index 000000000..8542165c5
--- /dev/null
+++ b/docs/topics/impala_compute_processing_cost.xml
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
+<concept id="impala_compute_processing_cost" rev="5.0.0">
+ <title>COMPUTE_PROCESSING_COST Query Option</title>
+ <titlealts audience="PDF">
+ <navtitle>COMPUTE PROCESSING COST</navtitle>
+ </titlealts>
+ <prolog>
+ <metadata>
+ <data name="Category" value="Impala"/>
+ <data name="Category" value="Impala Query Options"/>
+ <data name="Category" value="Performance"/>
+ <data name="Category" value="Developers"/>
+ <data name="Category" value="Data Analysts"/>
+ </metadata>
+ </prolog>
+ <conbody>
+ <p>The <codeph>COMPUTE_PROCESSING_COST</codeph> query option determines whether the query
+ planner evaluates the CPU processing cost of a query.</p>
+ <p>When you enable this query option, the query planner estimates the CPU processing cost of
+ each query fragment. The query planner uses this estimate to adjust the degree of parallelism,
+ which represents the number of fragment instances scheduled per executor node. This cost-based
+ parallelism adjustment improves resource utilization compared to using a fixed degree of
+ parallelism.</p>
+ <p conref="../shared/impala_common.xml#common/type_boolean"/>
+ <p conref="../shared/impala_common.xml#common/default_false"/>
+ <p><b>Added in</b>: <keyword keyref="impala43" id="IMPALA-11604"/></p>
+ <p conref="../shared/impala_common.xml#common/usage_notes_blurb"/>
+ </conbody>
+</concept>
diff --git a/docs/topics/impala_max_fragment_instances_per_node.xml b/docs/topics/impala_max_fragment_instances_per_node.xml
new file mode 100644
index 000000000..bff784019
--- /dev/null
+++ b/docs/topics/impala_max_fragment_instances_per_node.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
+<concept id="impala_max_fragment_instances_per_node">
+
+ <title>MAX_FRAGMENT_INSTANCES_PER_NODE Query Option</title>
+ <titlealts audience="PDF"><navtitle>MAX FRAGMENT INSTANCES PER NODE</navtitle></titlealts>
+ <prolog>
+ <metadata>
+ <data name="Category" value="Impala"/>
+ <data name="Category" value="Impala Query Options"/>
+ <data name="Category" value="Performance"/>
+ <data name="Category" value="Developers"/>
+ <data name="Category" value="Data Analysts"/>
+ </metadata>
+ </prolog>
+ <conbody>
+ <p>The <codeph>MAX_FRAGMENT_INSTANCES_PER_NODE</codeph> query option sets the maximum number of
+ fragment instances per node that the processing cost algorithm assigns to a query
+ fragment.</p>
+ <p>The recommended practice is to set this query option to a value lower than or equal to the
+ number of physical cores in an executor node. This query option is ignored if the selected
+ executor group has a lower <codeph>max-query-cpu-core-per-node-limit</codeph> configuration,
+ or if the <codeph>PROCESSING_COST_MIN_THREADS</codeph> query option has a higher value.</p>
+ <p conref="../shared/impala_common.xml#common/type_integer"/>
+ <p><b>Allowed values:</b> Integers in the range [1, 128].</p>
+ <p><b>Default:</b> 128</p>
+ <p><b>Added in:</b><keyword keyref="impala43" id="IMPALA-12091"/></p>
+ </conbody>
+</concept>
diff --git a/docs/topics/impala_processing_cost_min_threads.xml b/docs/topics/impala_processing_cost_min_threads.xml
new file mode 100644
index 000000000..7983f07d9
--- /dev/null
+++ b/docs/topics/impala_processing_cost_min_threads.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
+<concept id="impala_processing_cost_min_threads" rev="5.0.0">
+ <title>PROCESSING_COST_MIN_THREADS Query Option</title>
+ <titlealts audience="PDF">
+ <navtitle>PROCESSING COST MIN THREADS</navtitle>
+ </titlealts>
+ <prolog>
+ <metadata>
+ <data name="Category" value="Impala"/>
+ <data name="Category" value="Impala Query Options"/>
+ <data name="Category" value="Performance"/>
+ <data name="Category" value="Developers"/>
+ <data name="Category" value="Data Analysts"/>
+ </metadata>
+ </prolog>
+ <conbody>
+ <p>The <codeph>PROCESSING_COST_MIN_THREADS</codeph> query option sets the minimum number of
+ fragment instances per node that the processing cost algorithm assigns to a query
+ fragment.</p>
+ <p>The recommended practice is to set this query option to a value lower than or equal to the
+ number of physical cores in an executor node.</p>
+ <p conref="../shared/impala_common.xml#common/type_integer"/>
+ <p><b>Allowed values:</b> Integers in the range [1, 128].</p>
+ <p><b>Default:</b> 1</p>
+ <p><b>Added in:</b>
+ <keyword keyref="impala43" id="IMPALA-11604"/></p>
+ </conbody>
+</concept>