IMPALA-6483: [DOCS] Document the new EXEC_TIME_LIMIT_S query option

Change-Id: I7a83aa42e6fffc7cb71112936129a0f1917ec2fd
Reviewed-on: http://gerrit.cloudera.org:8080/10043
Reviewed-by: Tim Armstrong <tarmstr...@cloudera.com>
Tested-by: Impala Public Jenkins <impala-public-jenk...@cloudera.com>


Project: http://git-wip-us.apache.org/repos/asf/impala/repo
Commit: http://git-wip-us.apache.org/repos/asf/impala/commit/e53bf279
Tree: http://git-wip-us.apache.org/repos/asf/impala/tree/e53bf279
Diff: http://git-wip-us.apache.org/repos/asf/impala/diff/e53bf279

Branch: refs/heads/master
Commit: e53bf279b07bd66c4371185eaec1f9a33261bf30
Parents: fef527d
Author: Alex Rodoni <arod...@cloudera.com>
Authored: Wed Apr 11 20:20:00 2018 -0700
Committer: Impala Public Jenkins <impala-public-jenk...@cloudera.com>
Committed: Sat Apr 14 16:32:55 2018 +0000

----------------------------------------------------------------------
 docs/impala.ditamap                      |  1 +
 docs/impala_keydefs.ditamap              |  1 +
 docs/shared/impala_common.xml            |  8 +++
 docs/topics/impala_exec_time_limit_s.xml | 93 +++++++++++++++++++++++++++
 4 files changed, 103 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/impala/blob/e53bf279/docs/impala.ditamap
----------------------------------------------------------------------
diff --git a/docs/impala.ditamap b/docs/impala.ditamap
index e6c9c09..08b69ca 100644
--- a/docs/impala.ditamap
+++ b/docs/impala.ditamap
@@ -186,6 +186,7 @@ under the License.
           <topicref rev="2.5.0" 
href="topics/impala_disable_streaming_preaggregations.xml"/>
           <topicref href="topics/impala_disable_unsafe_spills.xml"/>
           <topicref href="topics/impala_exec_single_node_rows_threshold.xml"/>
+          <topicref href="topics/impala_exec_time_limit_s.xml"/>
           <topicref href="topics/impala_explain_level.xml"/>
           <topicref href="topics/impala_hbase_cache_blocks.xml"/>
           <topicref href="topics/impala_hbase_caching.xml"/>

http://git-wip-us.apache.org/repos/asf/impala/blob/e53bf279/docs/impala_keydefs.ditamap
----------------------------------------------------------------------
diff --git a/docs/impala_keydefs.ditamap b/docs/impala_keydefs.ditamap
index 0a2ac82..fb60e14 100644
--- a/docs/impala_keydefs.ditamap
+++ b/docs/impala_keydefs.ditamap
@@ -10783,6 +10783,7 @@ under the License.
   <keydef href="topics/impala_disable_streaming_preaggregations.xml" 
keys="disable_streaming_preaggregations"/>
   <keydef href="topics/impala_disable_unsafe_spills.xml" 
keys="disable_unsafe_spills"/>
   <keydef href="topics/impala_exec_single_node_rows_threshold.xml" 
keys="exec_single_node_rows_threshold"/>
+  <keydef href="topics/impala_exec_time_limit_s.xml" keys="exec_time_limit_s"/>
   <keydef href="topics/impala_explain_level.xml" keys="explain_level"/>
   <keydef href="topics/impala_hbase_cache_blocks.xml" 
keys="hbase_cache_blocks"/>
   <keydef href="topics/impala_hbase_caching.xml" keys="hbase_caching"/>

http://git-wip-us.apache.org/repos/asf/impala/blob/e53bf279/docs/shared/impala_common.xml
----------------------------------------------------------------------
diff --git a/docs/shared/impala_common.xml b/docs/shared/impala_common.xml
index 192e766..12d7d4e 100644
--- a/docs/shared/impala_common.xml
+++ b/docs/shared/impala_common.xml
@@ -2901,6 +2901,14 @@ flight_num:           INT32 SNAPPY DO:83456393 
FPO:83488603 SZ:10216514/11474301
         <b>Internal details:</b> Represented in memory as a byte array with 
the minimum size needed to represent
         each value.
       </p>
+      <p rev="3.0" id="added_in_30">
+        <b>Added in:</b>
+        <keyword keyref="impala30_full"/>
+      </p>
+      <p rev="2.12.0" id="added_in_212">
+        <b>Added in:</b>
+        <keyword keyref="impala212_full"/>
+      </p>
 
       <p rev="2.11.0" id="added_in_2110">
         <b>Added in:</b> <keyword keyref="impala2_11_0"/>

http://git-wip-us.apache.org/repos/asf/impala/blob/e53bf279/docs/topics/impala_exec_time_limit_s.xml
----------------------------------------------------------------------
diff --git a/docs/topics/impala_exec_time_limit_s.xml 
b/docs/topics/impala_exec_time_limit_s.xml
new file mode 100644
index 0000000..a0320b8
--- /dev/null
+++ b/docs/topics/impala_exec_time_limit_s.xml
@@ -0,0 +1,93 @@
+<?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.12.0" id="exec_time_limit_s">
+
+  <title>EXEC_TIME_LIMIT_S Query Option (<keyword keyref="impala212_full"/> or 
higher only)</title>
+
+  <titlealts audience="PDF">
+
+    <navtitle>EXEC_TIME_LIMIT_S</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="Developers"/>
+      <data name="Category" value="Data Analysts"/>
+    </metadata>
+  </prolog>
+
+  <conbody>
+
+    <p rev="2.12.0">
+      The <codeph>EXEC_TIME_LIMIT_S</codeph> query option sets a time limit on 
query execution.
+      If a query is still executing when time limit expires, it is 
automatically canceled. The
+      option is intended to prevent runaway queries that execute for much 
longer than intended.
+    </p>
+
+    <p>
+      For example, an Impala administrator could set a default value of
+      <codeph>EXEC_TIME_LIMIT_S=3600</codeph> for a resource pool to 
automatically kill queries
+      that execute for longer than one hour (see
+      <xref href="impala_admission.xml#admission_control"/> for information 
about default query
+      options). Then, if a user accidentally runs a large query that executes 
for more than one
+      hour, it will be automatically killed after the time limit expires to 
free up resources.
+      Users can override the default value per query or per session if they do 
not want the
+      default <codeph>EXEC_TIME_LIMIT_S</codeph> value to apply to a specific 
query or a
+      session.
+    </p>
+
+    <note>
+      <p>
+        The time limit only starts once the query is executing. Time spent 
planning the query,
+        scheduling the query, or in admission control is not counted towards 
the execution time
+        limit. <codeph>SELECT</codeph> statements are eligible for automatic 
cancellation until
+        the client has fetched all result rows. DML queries are eligible for 
automatic
+        cancellation until the DML statement has finished.
+      </p>
+    </note>
+
+    <p conref="../shared/impala_common.xml#common/syntax_blurb"/>
+
+<codeblock>SET EXEC_TIME_LIMIT_S=<varname>seconds</varname>;</codeblock>
+
+    <p>
+      <b>Type:</b> numeric
+    </p>
+
+    <p>
+      <b>Default:</b> 0 (no time limit )
+    </p>
+
+    <p conref="../shared/impala_common.xml#common/added_in_212"/>
+
+    <p conref="../shared/impala_common.xml#common/related_info"/>
+
+    <p>
+      <xref href="impala_timeouts.xml#timeouts"/>
+    </p>
+
+  </conbody>
+
+</concept>

Reply via email to