You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@impala.apache.org by bo...@apache.org on 2018/11/27 11:02:54 UTC
[04/11] impala git commit: IMPALA-7634: [DOCS] Document the new
SHUTDOWN statement
IMPALA-7634: [DOCS] Document the new SHUTDOWN statement
Change-Id: I0cfe4bae1b7966980cdeececa6b959bbecb4a24a
Reviewed-on: http://gerrit.cloudera.org:8080/11872
Tested-by: Impala Public Jenkins <im...@cloudera.com>
Reviewed-by: Tim Armstrong <ta...@cloudera.com>
(cherry picked from commit 71f8d0eba33c5d5d0a0cd2d2b617ac871dbcbb8a)
Project: http://git-wip-us.apache.org/repos/asf/impala/repo
Commit: http://git-wip-us.apache.org/repos/asf/impala/commit/bd573d12
Tree: http://git-wip-us.apache.org/repos/asf/impala/tree/bd573d12
Diff: http://git-wip-us.apache.org/repos/asf/impala/diff/bd573d12
Branch: refs/heads/branch-3.1.0
Commit: bd573d1267e4e5f5d904656acadeab9e2e6c2097
Parents: 8872e8b
Author: Alex Rodoni <ar...@cloudera.com>
Authored: Fri Nov 2 17:17:40 2018 -0700
Committer: Zoltan Borok-Nagy <bo...@cloudera.com>
Committed: Tue Nov 27 11:57:35 2018 +0100
----------------------------------------------------------------------
docs/impala.ditamap | 1 +
docs/topics/impala_shutdown.xml | 222 +++++++++++++++++++++++++++++++++++
2 files changed, 223 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/impala/blob/bd573d12/docs/impala.ditamap
----------------------------------------------------------------------
diff --git a/docs/impala.ditamap b/docs/impala.ditamap
index 8eecf06..e4c35a7 100644
--- a/docs/impala.ditamap
+++ b/docs/impala.ditamap
@@ -243,6 +243,7 @@ under the License.
</topicref>
</topicref>
<topicref href="topics/impala_show.xml"/>
+ <topicref href="topics/impala_shutdown.xml"/>
<topicref href="topics/impala_truncate_table.xml"/>
<topicref href="topics/impala_update.xml"/>
<topicref href="topics/impala_upsert.xml"/>
http://git-wip-us.apache.org/repos/asf/impala/blob/bd573d12/docs/topics/impala_shutdown.xml
----------------------------------------------------------------------
diff --git a/docs/topics/impala_shutdown.xml b/docs/topics/impala_shutdown.xml
new file mode 100644
index 0000000..1677fac
--- /dev/null
+++ b/docs/topics/impala_shutdown.xml
@@ -0,0 +1,222 @@
+<?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="shutdown">
+
+ <title>SHUTDOWN Statement</title>
+
+ <titlealts audience="PDF">
+
+ <navtitle>SHUTDOWN</navtitle>
+
+ </titlealts>
+
+ <prolog>
+ <metadata>
+ <data name="Category" value="Impala"/>
+ <data name="Category" value="SQL"/>
+ <data name="Category" value="Developers"/>
+ </metadata>
+ </prolog>
+
+ <conbody>
+
+ <p>
+ The <codeph>SHUTDOWN</codeph> statement performs a graceful shutdown of Impala Daemon. The
+ Impala daemon will notify other Impala daemons that it is shutting down, wait for a grace
+ period, then shut itself down once no more queries or fragments are executing on that
+ daemon. The <codeph>--shutdown_grace_period_s</codeph> flag determines the duration of the
+ grace period in seconds.
+ </p>
+
+ <p>
+ <b>Syntax:</b>
+ </p>
+
+<codeblock>:SHUTDOWN()
+:SHUTDOWN([<varname>host_name</varname>[:<varname>port_number</varname>] )
+:SHUTDOWN(<varname>deadline</varname>)
+:SHUTDOWN([<varname>host_name</varname>[:<varname>port_number</varname>], <varname>deadline</varname>)</codeblock>
+
+ <p>
+ <b>Usage notes:</b>
+ </p>
+
+ <p>
+ All arguments are optional for <codeph>SHUTDOWN</codeph>.
+ </p>
+
+ <simpletable frame="all" id="simpletable_sly_wrf_rfb">
+
+ <sthead>
+
+ <stentry>Argument</stentry>
+
+ <stentry>Type</stentry>
+
+ <stentry>Default</stentry>
+
+ <stentry>Description</stentry>
+
+ </sthead>
+
+ <strow>
+
+ <stentry><codeph><varname>host_name</varname></codeph>
+
+ </stentry>
+
+ <stentry><codeph>STRING</codeph>
+
+ </stentry>
+
+ <stentry>The current <codeph>impalad</codeph> host</stentry>
+
+ <stentry>
+
+ <p>
+ Address of the backend to be shut down.
+ </p>
+
+ </stentry>
+
+ </strow>
+
+ <strow>
+
+ <stentry><codeph><varname>port_number</varname></codeph>
+
+ </stentry>
+
+ <stentry><codeph>INT</codeph>
+
+ </stentry>
+
+ <stentry><codeph>0</codeph> which is treated the same port as current
+ <codeph>impalad</codeph>
+
+ </stentry>
+
+ <stentry>n/a</stentry>
+
+ </strow>
+
+ <strow>
+
+ <stentry><codeph><varname>deadline</varname></codeph>
+
+ </stentry>
+
+ <stentry><codeph>INT</codeph>
+
+ </stentry>
+
+ <stentry><codeph>The value of the <codeph>--shutdown_deadline_s</codeph>
+ flag, which defaults to 1 hour.</codeph>
+
+ </stentry>
+
+ <stentry>
+
+ <p>
+ <codeph><varname>deadline</varname></codeph> must be a non-negative number,
+ specified in seconds.
+ </p>
+
+ <p>
+ The value, 0, for <varname>deadline</varname> specifies an immediate shutdown.
+ </p>
+
+ </stentry>
+
+ </strow>
+
+ </simpletable>
+
+ <p>
+ Take the following points into consideration when running the <codeph>SHUTDOWN</codeph>
+ statement:
+ </p>
+
+ <ul>
+ <li>
+ A client can shut down the
+ <xref
+ href="impala_components.xml#intro_impalad">coordinator</xref>
+ <codeph>impalad</codeph> that it is connected to via <codeph>:SHUTDOWN()</codeph>.
+ </li>
+
+ <li>
+ A client can remotely shut down another non-coordinator <codeph>impalad</codeph> via
+ <codeph>:SHUTDOWN('<varname>hostname</varname>')</codeph>.
+ </li>
+
+ <li>
+ The shutdown time limit can be overridden to force a quicker or slower shutdown by
+ specifying a deadline. The default deadline is determined by the
+ <codeph>--shutdown_deadline_s</codeph> flag, which defaults to 1 hour.
+ </li>
+
+ <li>
+ <xref href="impala_components.xml#intro_impalad">Executors</xref> can be shut down
+ without disrupting running queries. Short-running queries will finish, and long-running
+ queries will continue until a threshold time limit is reached.
+ </li>
+
+ <li>
+ If queries are submitted to a coordinator after shutdown of that coordinator has
+ started, they will fail.
+ </li>
+
+ <li>
+ Long running queries or other issues, such as stuck fragments, will slow down but not
+ prevent eventual shutdown.
+ </li>
+ </ul>
+
+ <p>
+ <b>Security considerations:</b>
+ </p>
+
+ <p>
+ The <codeph>ALL</codeph> privilege is required on the server.
+ </p>
+
+ <p conref="../shared/impala_common.xml#common/cancel_blurb_no"/>
+
+ <p>
+ <b>Examples:</b>
+ </p>
+
+<codeblock>:SHUTDOWN(); -- Shut down the current impalad with the default deadline.
+:SHUTDOWN('hostname'); -- Shut down impalad running on hostname with the default deadline.
+:SHUTDOWN(\"hostname:1234\"); -- Shut down impalad running on host at port 1234 with the default deadline.
+:SHUTDOWN(10); - Shut down the current impalad after 10 seconds.
+:SHUTDOWN('hostname', 10); - Shut down impalad running on hostname when all queries running on hostname finish, or after 10 seconds.
+:SHUTDOWN('hostname:11', 10 * 60); -- Shut down impalad running on hostname at port 11 when all queries running on hostname finish, or after 600 seconds.
+:SHUTDOWN(0); -- Perform an immdediate shutdown of the current impalad.</codeblock>
+
+ <p>
+ <b>Added in:</b> <keyword keyref="impala31"/>
+ </p>
+
+ </conbody>
+
+</concept>