mirror of
https://github.com/apache/impala.git
synced 2025-12-19 09:58:28 -05:00
The recent documentation formatting changes introduced the navigation panel on the left. However, due to the length of the query options navigation title these could overlap with the documentation paragraphs. This commit removes the underscores from the navigation titles of the query options, so browsers can break them into multiple lines. Additionally, the "SET" and "Query Options for the SET Statement" pages are merged to save some more space for the query option navigation titles. Testing: - Built the documentation and tested manually Change-Id: Icec787d7a2af848aaaff65be2ecf311a5ce8fe7f Reviewed-on: http://gerrit.cloudera.org:8080/20556 Tested-by: Impala Public Jenkins <impala-public-jenkins@cloudera.com> Reviewed-by: Jason Fehr <jfehr@cloudera.com> Reviewed-by: Peter Rozsa <prozsa@cloudera.com> Reviewed-by: Tamas Mate <tmater@apache.org>
87 lines
4.4 KiB
XML
87 lines
4.4 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 rev="2.3.0" id="live_summary">
|
|
|
|
<title>LIVE_SUMMARY Query Option (<keyword keyref="impala23"/> or higher only)</title>
|
|
<titlealts audience="PDF"><navtitle>LIVE SUMMARY</navtitle></titlealts>
|
|
<prolog>
|
|
<metadata>
|
|
<data name="Category" value="Impala"/>
|
|
<data name="Category" value="Impala Query Options"/>
|
|
<data name="Category" value="Querying"/>
|
|
<data name="Category" value="Performance"/>
|
|
<data name="Category" value="Reports"/>
|
|
<data name="Category" value="impala-shell"/>
|
|
<data name="Category" value="Developers"/>
|
|
<data name="Category" value="Data Analysts"/>
|
|
</metadata>
|
|
</prolog>
|
|
|
|
<conbody>
|
|
<p rev="2.3.0"> When the <codeph>LIVE_SUMMARY</codeph> query option is set
|
|
to <codeph>TRUE</codeph>, Impala displays the same output as the
|
|
<codeph>SUMMARY</codeph> command for queries submitted through the
|
|
<cmdname>impala-shell</cmdname> command, with the measurements updated
|
|
in real time as the query progresses. When the query finishes, the final
|
|
<codeph>SUMMARY</codeph> output remains visible in the
|
|
<cmdname>impala-shell</cmdname> console output. </p>
|
|
<p>Starting in <keyword keyref="impala31"/>, the summary output also
|
|
includes the queuing status consisting of whether the query was queued and
|
|
what was the latest queuing reason.</p>
|
|
<p><b>Type:</b>
|
|
<codeph>Boolean</codeph></p>
|
|
<p><b>Default:</b>
|
|
<codeph>FALSE (0)</codeph></p>
|
|
<p conref="../shared/impala_common.xml#common/command_line_blurb"/>
|
|
<p> You can enable this query option within <cmdname>impala-shell</cmdname>
|
|
by starting the shell with the <codeph>--live_summary</codeph>
|
|
command-line option. You can still turn this setting off and on again
|
|
within the shell through the <codeph>SET</codeph> command. </p>
|
|
<p conref="../shared/impala_common.xml#common/usage_notes_blurb"/>
|
|
<p> The live summary output can be useful for evaluating long-running
|
|
queries, to evaluate which phase of execution takes up the most time, or
|
|
if some hosts take much longer than others for certain operations,
|
|
dragging overall performance down. By making the information available in
|
|
real time, this feature lets you decide what action to take even before
|
|
you cancel a query that is taking much longer than normal. </p>
|
|
<p> For example, you might see the HDFS scan phase taking a long time, and
|
|
therefore revisit performance-related aspects of your schema design such
|
|
as constructing a partitioned table, switching to the Parquet file format,
|
|
running the <codeph>COMPUTE STATS</codeph> statement for the table, and so
|
|
on. Or you might see a wide variation between the average and maximum
|
|
times for all hosts to perform some phase of the query, and therefore
|
|
investigate if one particular host needed more memory or was experiencing
|
|
a network problem. </p>
|
|
<p conref="../shared/impala_common.xml#common/live_reporting_details"/>
|
|
<p> For a simple and concise way of tracking the progress of an interactive
|
|
query, see <xref href="impala_live_progress.xml#live_progress"/>. </p>
|
|
<p conref="../shared/impala_common.xml#common/restrictions_blurb"/>
|
|
<p
|
|
conref="../shared/impala_common.xml#common/impala_shell_progress_reports_compute_stats_caveat"/>
|
|
<p
|
|
conref="../shared/impala_common.xml#common/impala_shell_progress_reports_shell_only_caveat"/>
|
|
<p conref="../shared/impala_common.xml#common/added_in_230"/>
|
|
<p
|
|
conref="../shared/impala_common.xml#common/live_progress_live_summary_asciinema"
|
|
/>
|
|
</conbody>
|
|
</concept>
|