Files
impala/docs/topics/impala_large_agg_mem_threshold.xml
Riza Suminto 93c64e7e9a IMPALA-13376: Add docs for AGG_MEM_CORRELATION_FACTOR etc
This patch adds documentation for AGG_MEM_CORRELATION_FACTOR and
LARGE_AGG_MEM_THRESHOLD option introduced in Apache Impala 4.4.0.

IMPALA-12548 fix behavior of AGG_MEM_CORRELATION_FACTOR. Higher value
will lower memory estimation, while lower value will result in higher
memory estimation. The documentation in ImpalaService.thrift, however,
says the opposite. This patch fix documentation in thrift file as well.

Testing:
- Run "make plain-html" in docs/ dir and confirm the output.
- Manually check with comments in
  PlannerTest.testAggNodeMaxMemEstimate()

Change-Id: I00956a50fb7616ca3c3ea2fd75fd11239a6bcd90
Reviewed-on: http://gerrit.cloudera.org:8080/21793
Tested-by: Impala Public Jenkins <impala-public-jenkins@cloudera.com>
Reviewed-by: Michael Smith <michael.smith@cloudera.com>
2024-09-24 17:10:34 +00:00

69 lines
2.5 KiB
XML

<?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="large_agg_mem_threshold" rev="4.4.0">
<title>LARGE_AGG_MEM_THRESHOLD Query Option (<keyword keyref="impala44"/> or higher only)</title>
<titlealts audience="PDF">
<navtitle>LARGE AGG MEM THRESHOLD</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 rev="4.4.0">
<indexterm audience="hidden">LARGE_AGG_MEM_THRESHOLD query option</indexterm>
The threshold for the query planner to determine whether memory estimation for an
aggregation node is large or not. Together with <codeph>AGG_MEM_CORRELATION_FACTOR</codeph>,
the planner will use this value to lower memory estimation for a large aggregation node.
</p>
<p>
Users can set this option value to 0.0 so the planner stays using the default
NDV multiplication based-estimation. See <codeph>AGG_MEM_CORRELATION_FACTOR</codeph>
documentation for more detail.
</p>
<p conref="../shared/impala_common.xml#common/type_integer"/>
<p conref="../shared/impala_common.xml#common/default_blurb"/>
<p>
<codeph>536870912</codeph> (512 MB)
</p>
<p conref="../shared/impala_common.xml#common/units_blurb"/>
<p conref="../shared/impala_common.xml#common/added_in_440"/>
<p conref="../shared/impala_common.xml#common/related_info"/>
<p>
<xref href="impala_agg_mem_correlation_factor.xml"/>
</p>
</conbody>
</concept>