http://git-wip-us.apache.org/repos/asf/impala/blob/b4ad38a9/docs/build/html/topics/impala_seqfile.html ---------------------------------------------------------------------- diff --git a/docs/build/html/topics/impala_seqfile.html b/docs/build/html/topics/impala_seqfile.html index ba6d878..98fc4b9 100644 --- a/docs/build/html/topics/impala_seqfile.html +++ b/docs/build/html/topics/impala_seqfile.html @@ -1,62 +1,104 @@ +<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html - SYSTEM "about:legacy-compat"> -<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="concept"><meta name="DC.Relation" scheme="URI" content="../topics/impala_file_formats.html"><meta name="prodname" content="Impala"><meta name="prodname" content="Impala"><meta name="version" content="Impala 2.12x"><meta name="version" content="Impala 2.12x"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="seqfile"><link rel="stylesheet" type="text/css" href="../commonltr.css"><title>Using the SequenceFile File Format with Impala Tables</title></head><body id="seqfile"><main role="main"><article role="article" aria-labelledby="seqfile__sequencefile"> + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + +<meta name="copyright" content="(C) Copyright 2018" /> +<meta name="DC.rights.owner" content="(C) Copyright 2018" /> +<meta name="DC.Type" content="concept" /> +<meta name="DC.Title" content="Using the SequenceFile File Format with Impala Tables" /> +<meta name="DC.Relation" scheme="URI" content="../topics/impala_file_formats.html" /> +<meta name="prodname" content="Impala" /> +<meta name="prodname" content="Impala" /> +<meta name="version" content="Impala 3.0.x" /> +<meta name="version" content="Impala 3.0.x" /> +<meta name="DC.Format" content="XHTML" /> +<meta name="DC.Identifier" content="seqfile" /> +<link rel="stylesheet" type="text/css" href="../commonltr.css" /> +<title>Using the SequenceFile File Format with Impala Tables</title> +</head> +<body id="seqfile"> + <h1 class="title topictitle1" id="seqfile__sequencefile">Using the SequenceFile File Format with Impala Tables</h1> + <div class="body conbody"> - <p class="p"> - - Impala supports using SequenceFile data files. - </p> + <p class="p"> Impala supports using SequenceFile data files. </p> + - <table class="table"><caption><span class="table--title-label">Table 1. </span><span class="title">SequenceFile Format Support in Impala</span></caption><colgroup><col style="width:10%"><col style="width:10%"><col style="width:20%"><col style="width:30%"><col style="width:30%"></colgroup><thead class="thead"> + +<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="table" frame="border" border="1" rules="all"><caption><span class="tablecap"><span class="table--title-label">Table 1. </span>SequenceFile Format Support in Impala</span></caption><colgroup><col style="width:10%" /><col style="width:10%" /><col style="width:20%" /><col style="width:30%" /><col style="width:30%" /></colgroup><thead class="thead" style="text-align:left;"> <tr class="row"> - <th class="entry nocellnorowborder" id="seqfile__entry__1"> + <th class="entry nocellnorowborder" style="vertical-align:top;" id="d180806e77"> File Type </th> - <th class="entry nocellnorowborder" id="seqfile__entry__2"> + + <th class="entry nocellnorowborder" style="vertical-align:top;" id="d180806e80"> Format </th> - <th class="entry nocellnorowborder" id="seqfile__entry__3"> + + <th class="entry nocellnorowborder" style="vertical-align:top;" id="d180806e83"> Compression Codecs </th> - <th class="entry nocellnorowborder" id="seqfile__entry__4"> + + <th class="entry nocellnorowborder" style="vertical-align:top;" id="d180806e86"> Impala Can CREATE? </th> - <th class="entry nocellnorowborder" id="seqfile__entry__5"> + + <th class="entry cell-norowborder" style="vertical-align:top;" id="d180806e89"> Impala Can INSERT? </th> + </tr> - </thead><tbody class="tbody"> + + </thead> +<tbody class="tbody"> <tr class="row"> - <td class="entry nocellnorowborder" headers="seqfile__entry__1 "> + <td class="entry row-nocellborder" style="vertical-align:top;" headers="d180806e77 "> <a class="xref" href="impala_seqfile.html#seqfile">SequenceFile</a> </td> - <td class="entry nocellnorowborder" headers="seqfile__entry__2 "> + + <td class="entry row-nocellborder" style="vertical-align:top;" headers="d180806e80 "> Structured </td> - <td class="entry nocellnorowborder" headers="seqfile__entry__3 "> + + <td class="entry row-nocellborder" style="vertical-align:top;" headers="d180806e83 "> Snappy, gzip, deflate, bzip2 </td> - <td class="entry nocellnorowborder" headers="seqfile__entry__4 ">Yes.</td> - <td class="entry nocellnorowborder" headers="seqfile__entry__5 "> + + <td class="entry row-nocellborder" style="vertical-align:top;" headers="d180806e86 ">Yes.</td> + + <td class="entry cellrowborder" style="vertical-align:top;" headers="d180806e89 "> No. Import data by using <code class="ph codeph">LOAD DATA</code> on data files already in the right format, or use <code class="ph codeph">INSERT</code> in Hive followed by <code class="ph codeph">REFRESH <var class="keyword varname">table_name</var></code> in Impala. </td> + </tr> - </tbody></table> + + </tbody> +</table> +</div> + <p class="p toc inpage"></p> + </div> - <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/impala_file_formats.html">How Impala Works with Hadoop File Formats</a></div></div></nav><article class="topic concept nested1" aria-labelledby="ariaid-title2" id="seqfile__seqfile_create"> + + <div class="related-links"> +<div class="familylinks"> +<div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/impala_file_formats.html">How Impala Works with Hadoop File Formats</a></div> +</div> +</div><div class="topic concept nested1" aria-labelledby="ariaid-title2" id="seqfile_create"> <h2 class="title topictitle2" id="ariaid-title2">Creating SequenceFile Tables and Loading Data</h2> + <div class="body conbody"> @@ -65,14 +107,17 @@ If you do not have an existing data file to use, begin by creating one in the appropriate format. </p> + <p class="p"> <strong class="ph b">To create a SequenceFile table:</strong> </p> + <p class="p"> In the <code class="ph codeph">impala-shell</code> interpreter, issue a command similar to: </p> + <pre class="pre codeblock"><code>create table sequencefile_table (<var class="keyword varname">column_specs</var>) stored as sequencefile;</code></pre> <p class="p"> @@ -84,12 +129,14 @@ the new data. </p> + <p class="p"> For example, here is how you might create some SequenceFile tables in Impala (by specifying the columns explicitly, or cloning the structure of another table), load data through Hive, and query them through Impala: </p> + <pre class="pre codeblock"><code>$ impala-shell -i localhost [localhost:21000] > create table seqfile_table (x int) stored as sequencefile; [localhost:21000] > create table seqfile_clone like some_other_table stored as sequencefile; @@ -128,22 +175,26 @@ Returned 3 row(s) in 0.23s</code></pre> </span> </p> + </div> - </article> - <article class="topic concept nested1" aria-labelledby="ariaid-title3" id="seqfile__seqfile_compression"> + </div> + + + <div class="topic concept nested1" aria-labelledby="ariaid-title3" id="seqfile_compression"> <h2 class="title topictitle2" id="ariaid-title3">Enabling Compression for SequenceFile Tables</h2> + <div class="body conbody"> - <p class="p"> - - You may want to enable compression on existing tables. Enabling compression provides performance gains in - most cases and is supported for SequenceFile tables. For example, to enable Snappy compression, you would - specify the following additional settings when loading data through the Hive shell: - </p> + <p class="p"> You may want to enable compression on existing tables. Enabling + compression provides performance gains in most cases and is supported + for SequenceFile tables. For example, to enable Snappy compression, you + would specify the following additional settings when loading data + through the Hive shell: </p> + <pre class="pre codeblock"><code>hive> SET hive.exec.compress.output=true; hive> SET mapred.max.split.size=256000000; @@ -156,6 +207,7 @@ hive> insert overwrite table <var class="keyword varname">new_table</var> sel additional settings similar to the following: </p> + <pre class="pre codeblock"><code>hive> create table <var class="keyword varname">new_table</var> (<var class="keyword varname">your_cols</var>) partitioned by (<var class="keyword varname">partition_cols</var>) stored as <var class="keyword varname">new_format</var>; hive> SET hive.exec.dynamic.partition.mode=nonstrict; hive> SET hive.exec.dynamic.partition=true; @@ -168,6 +220,7 @@ hive> insert overwrite table <var class="keyword varname">new_table</var> par conversion, you would specify settings similar to the following: </p> + <pre class="pre codeblock"><code>hive> create table TBL_SEQ (int_col int, string_col string) STORED AS SEQUENCEFILE; hive> SET hive.exec.compress.output=true; hive> SET mapred.max.split.size=256000000; @@ -182,6 +235,7 @@ hive> INSERT OVERWRITE TABLE tbl_seq SELECT * FROM tbl;</code></pre> the following: </p> + <pre class="pre codeblock"><code>hive> CREATE TABLE tbl_seq (int_col INT, string_col STRING) PARTITIONED BY (year INT) STORED AS SEQUENCEFILE; hive> SET hive.exec.compress.output=true; hive> SET mapred.max.split.size=256000000; @@ -191,24 +245,28 @@ hive> SET hive.exec.dynamic.partition.mode=nonstrict; hive> SET hive.exec.dynamic.partition=true; hive> INSERT OVERWRITE TABLE tbl_seq PARTITION(year) SELECT * FROM tbl;</code></pre> - <div class="note note note_note"><span class="note__title notetitle">Note:</span> + <div class="note note"><span class="notetitle">Note:</span> <p class="p"> The compression type is specified in the following command: </p> + <pre class="pre codeblock"><code>SET mapred.output.compression.codec=org.apache.hadoop.io.compress.SnappyCodec;</code></pre> <p class="p"> You could elect to specify alternative codecs such as <code class="ph codeph">GzipCodec</code> here. </p> + </div> + </div> - </article> - + </div> + - <article class="topic concept nested1" aria-labelledby="ariaid-title4" id="seqfile__seqfile_performance"> + <div class="topic concept nested1" aria-labelledby="ariaid-title4" id="seqfile_performance"> <h2 class="title topictitle2" id="ariaid-title4">Query Performance for Impala SequenceFile Tables</h2> + <div class="body conbody"> <p class="p"> @@ -219,9 +277,10 @@ hive> INSERT OVERWRITE TABLE tbl_seq PARTITION(year) SELECT * FROM tbl;</code high-performance analytic queries. </p> + <p class="p"> In <span class="keyword">Impala 2.6</span> and higher, Impala queries are optimized for files stored in Amazon S3. - For Impala tables that use the file formats Parquet, RCFile, SequenceFile, + For Impala tables that use the file formats Parquet, ORC, RCFile, SequenceFile, Avro, and uncompressed text, the setting <code class="ph codeph">fs.s3a.block.size</code> in the <span class="ph filepath">core-site.xml</span> configuration file determines how Impala divides the I/O work of reading the data files. This configuration @@ -234,7 +293,11 @@ hive> INSERT OVERWRITE TABLE tbl_seq PARTITION(year) SELECT * FROM tbl;</code to 268435456 (256 MB) to match the row group size produced by Impala. </p> + </div> - </article> -</article></main></body></html> \ No newline at end of file + </div> + + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/impala/blob/b4ad38a9/docs/build/html/topics/impala_set.html ---------------------------------------------------------------------- diff --git a/docs/build/html/topics/impala_set.html b/docs/build/html/topics/impala_set.html index 314b43b..983c625 100644 --- a/docs/build/html/topics/impala_set.html +++ b/docs/build/html/topics/impala_set.html @@ -1,280 +1,211 @@ +<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html - SYSTEM "about:legacy-compat"> -<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="concept"><meta name="DC.Relation" scheme="URI" content="../topics/impala_langref_sql.html"><meta name="DC.Relation" scheme="URI" content="../topics/impala_query_options.html"><meta name="prodname" content="Impala"><meta name="prodname" content="Impala"><meta name="version" content="Impala 2.12x"><meta name="version" content="Impala 2.12x"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="set"><link rel="stylesheet" type="text/css" href="../commonltr.css"><title>SET Statement</title></head><body id="set"><main role="main"><article role="article" aria-labelledby="ariaid-title1"> + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + +<meta name="copyright" content="(C) Copyright 2018" /> +<meta name="DC.rights.owner" content="(C) Copyright 2018" /> +<meta name="DC.Type" content="concept" /> +<meta name="DC.Title" content="SET Statement" /> +<meta name="DC.Relation" scheme="URI" content="../topics/impala_langref_sql.html" /> +<meta name="DC.Relation" scheme="URI" content="../topics/impala_query_options.html" /> +<meta name="prodname" content="Impala" /> +<meta name="prodname" content="Impala" /> +<meta name="version" content="Impala 3.0.x" /> +<meta name="version" content="Impala 3.0.x" /> +<meta name="DC.Format" content="XHTML" /> +<meta name="DC.Identifier" content="set" /> +<link rel="stylesheet" type="text/css" href="../commonltr.css" /> +<title>SET Statement</title> +</head> +<body id="set"> + <h1 class="title topictitle1" id="ariaid-title1">SET Statement</h1> + + + <div class="body conbody"> <p class="p"> - - Specifies values for query options that control the runtime behavior of other statements within the same - session. + The <code class="ph codeph">SET</code> statement specifies values for query options that control the + runtime behavior of other statements within the same session. </p> + <p class="p"> - In <span class="keyword">Impala 2.5</span> and higher, <code class="ph codeph">SET</code> also defines user-specified substitution variables for - the <span class="keyword cmdname">impala-shell</span> interpreter. This feature uses the <code class="ph codeph">SET</code> command - built into <span class="keyword cmdname">impala-shell</span> instead of the SQL <code class="ph codeph">SET</code> statement. - Therefore the substitution mechanism only works with queries processed by <span class="keyword cmdname">impala-shell</span>, - not with queries submitted through JDBC or ODBC. + When issued in <code class="ph codeph">impala-shell</code>, the <code class="ph codeph">SET</code> command is + interpreted as an <code class="ph codeph">impala-shell</code> command that has differences from the SQL + <code class="ph codeph">SET</code> statement. See + <a class="xref" href="impala_shell_commands.html#shell_commands">impala-shell Command Reference</a> for the information about + the <code class="ph codeph">SET</code> command in <code class="ph codeph">impala-shell</code>. </p> - <div class="note important note_important"><span class="note__title importanttitle">Important:</span> - <p class="p"> - In <span class="keyword">Impala 2.11</span> and higher, the output of the <code class="ph codeph">SET</code> - statement changes in some important ways: - </p> - <ul class="ul"> - <li class="li"> - <p class="p"> - The options are divided into groups: <code class="ph codeph">Regular Query Options</code>, - <code class="ph codeph">Advanced Query Options</code>, <code class="ph codeph">Development Query Options</code>, and - <code class="ph codeph">Deprecated Query Options</code>. - </p> - </li> - <li class="li"> - <p class="p"> - The advanced options are intended for use in specific - kinds of performance tuning and debugging scenarios. The development options are - related to internal development of Impala or features that are not yet finalized; - these options might be changed or removed without notice. - The deprecated options are related to features that are removed or changed so that - the options no longer have any purpose; these options might be removed in future - versions. - </p> - </li> - <li class="li"> - <p class="p"> - By default, only the first two groups (regular and advanced) are - displayed by the <code class="ph codeph">SET</code> command. Use the syntax <code class="ph codeph">SET ALL</code> - to see all groups of options. - </p> - </li> - <li class="li"> - <p class="p"> - <span class="keyword cmdname">impala-shell</span> options and user-specified variables are always displayed - at the end of the list of query options, after all appropriate option groups. - </p> - </li> - <li class="li"> - <p class="p"> - When the <code class="ph codeph">SET</code> command is run through the JDBC or ODBC interfaces, - the result set has a new third column, <code class="ph codeph">level</code>, indicating which - group each option belongs to. The same distinction of <code class="ph codeph">SET</code> - returning the regular and advanced options, and <code class="ph codeph">SET ALL</code> - returning all option groups, applies to JDBC and ODBC also. - </p> - </li> - </ul> - </div> <p class="p"> <strong class="ph b">Syntax:</strong> </p> -<pre class="pre codeblock"><code>SET [<var class="keyword varname">query_option</var>=<var class="keyword varname">option_value</var>] + +<pre class="pre codeblock"><code>SET <span class="ph">SET ALL</span> +SET <var class="keyword varname">query_option</var>=<var class="keyword varname">option_value</var> +SET <var class="keyword varname">query_option</var>="" </code></pre> <p class="p"> - <code class="ph codeph">SET</code> and <code class="ph codeph">SET ALL</code> with no arguments return a - result set consisting of all the applicable query options and their current values. + <code class="ph codeph">SET</code> and <code class="ph codeph">SET ALL</code> with no arguments return a result set + consisting of all the applicable query options and their current values. </p> - <p class="p"> - The query option name and any string argument values are case-insensitive. - </p> <p class="p"> - Each query option has a specific allowed notation for its arguments. Boolean options can be enabled and - disabled by assigning values of either <code class="ph codeph">true</code> and <code class="ph codeph">false</code>, or - <code class="ph codeph">1</code> and <code class="ph codeph">0</code>. Some numeric options accept a final character signifying the unit, - such as <code class="ph codeph">2g</code> for 2 gigabytes or <code class="ph codeph">100m</code> for 100 megabytes. See - <a class="xref" href="impala_query_options.html#query_options">Query Options for the SET Statement</a> for the details of each query option. + The <var class="keyword varname">query_option</var> and <var class="keyword varname">option_value</var> are + case-insensitive. </p> - <p class="p"> - <strong class="ph b">Setting query options during impala-shell invocation:</strong> - </p> <p class="p"> - In <span class="keyword">Impala 2.11</span> and higher, you can use one or more command-line options - of the form <code class="ph codeph">--query_option=<var class="keyword varname">option</var>=<var class="keyword varname">value</var></code> - when running the <span class="keyword cmdname">impala-shell</span> command. The corresponding query option settings - take effect for that <span class="keyword cmdname">impala-shell</span> session. + Unlike the <code class="ph codeph">impala-shell</code> command version of <code class="ph codeph">SET</code>, when + used as a SQL statement, the string values for <var class="keyword varname">option_value</var> need to be + quoted, e.g. <code class="ph codeph">SET option="new_value"</code>. </p> - <p class="p"> - <strong class="ph b">User-specified substitution variables:</strong> - </p> <p class="p"> - In <span class="keyword">Impala 2.5</span> and higher, you can specify your own names and string substitution values - within the <span class="keyword cmdname">impala-shell</span> interpreter. Once a substitution variable is set up, - its value is inserted into any SQL statement in that same <span class="keyword cmdname">impala-shell</span> session - that contains the notation <code class="ph codeph">${var:<var class="keyword varname">varname</var>}</code>. - Using <code class="ph codeph">SET</code> in an interactive <span class="keyword cmdname">impala-shell</span> session overrides - any value for that same variable passed in through the <code class="ph codeph">--var=<var class="keyword varname">varname</var>=<var class="keyword varname">value</var></code> - command-line option. + The <code class="ph codeph">SET <var class="keyword varname">query_option</var> = ""</code> statement unsets the value + of the <var class="keyword varname">query_option</var> in the current session, reverting it to the default + state. In <code class="ph codeph">impala-shell</code>, use the <code class="ph codeph">UNSET</code> command to set a + query option to it default. </p> - <p class="p"> - For example, to set up some default parameters for report queries, but then override those default - within an <span class="keyword cmdname">impala-shell</span> session, you might issue commands and statements such as - the following: - </p> - -<pre class="pre codeblock"><code> --- Initial setup for this example. -create table staging_table (s string); -insert into staging_table values ('foo'), ('bar'), ('bletch'); - -create table production_table (s string); -insert into production_table values ('North America'), ('EMEA'), ('Asia'); -quit; - --- Start impala-shell with user-specified substitution variables, --- run a query, then override the variables with SET and run the query again. -$ impala-shell --var=table_name=staging_table --var=cutoff=2 -... <var class="keyword varname">banner message</var> ... -[localhost:21000] > select s from ${var:table_name} order by s limit ${var:cutoff}; -Query: select s from staging_table order by s limit 2 -+--------+ -| s | -+--------+ -| bar | -| bletch | -+--------+ -Fetched 2 row(s) in 1.06s - -[localhost:21000] > set var:table_name=production_table; -Variable TABLE_NAME set to production_table -[localhost:21000] > set var:cutoff=3; -Variable CUTOFF set to 3 - -[localhost:21000] > select s from ${var:table_name} order by s limit ${var:cutoff}; -Query: select s from production_table order by s limit 3 -+---------------+ -| s | -+---------------+ -| Asia | -| EMEA | -| North America | -+---------------+ -</code></pre> <p class="p"> - The following example shows how <code class="ph codeph">SET ALL</code> with no parameters displays - all user-specified substitution variables, and how <code class="ph codeph">UNSET</code> removes - the substitution variable entirely: + Each query option has a specific allowed notation for its arguments. See + <a class="xref" href="impala_query_options.html#query_options">Query Options for the SET Statement</a> for the details of each query + option. </p> -<pre class="pre codeblock"><code> -[localhost:21000] > set all; -Query options (defaults shown in []): -ABORT_ON_ERROR: [0] -COMPRESSION_CODEC: [] -DISABLE_CODEGEN: [0] -... - -Advanced Query Options: -APPX_COUNT_DISTINCT: [0] -BUFFER_POOL_LIMIT: [] -DEFAULT_JOIN_DISTRIBUTION_MODE: [0] -... - -Development Query Options: -BATCH_SIZE: [0] -DEBUG_ACTION: [] -DECIMAL_V2: [0] -... - -Deprecated Query Options: -ABORT_ON_DEFAULT_LIMIT_EXCEEDED: [0] -ALLOW_UNSUPPORTED_FORMATS: [0] -DEFAULT_ORDER_BY_LIMIT: [-1] -... - -Shell Options - LIVE_PROGRESS: False - LIVE_SUMMARY: False - -Variables: - CUTOFF: 3 - TABLE_NAME: staging_table - -[localhost:21000] > unset var:cutoff; -Unsetting variable CUTOFF -[localhost:21000] > select s from ${var:table_name} order by s limit ${var:cutoff}; -Error: Unknown variable CUTOFF -</code></pre> - - <p class="p"> - See <a class="xref" href="impala_shell_running_commands.html">Running Commands and SQL Statements in impala-shell</a> for more examples of using the - <code class="ph codeph">--var</code>, <code class="ph codeph">SET</code>, and <code class="ph codeph">${var:<var class="keyword varname">varname</var>}</code> - substitution technique in <span class="keyword cmdname">impala-shell</span>. - </p> <p class="p"> <strong class="ph b">Usage notes:</strong> </p> + <p class="p"> - <code class="ph codeph">MEM_LIMIT</code> is probably the most commonly used query option. You can specify a high value to - allow a resource-intensive query to complete. For testing how queries would work on memory-constrained - systems, you might specify an artificially low value. + In <span class="keyword">Impala 2.11</span> and higher, the outputs of the <code class="ph codeph">SET</code> + and <code class="ph codeph">SET ALL</code> statements were reorganized as below: </p> - <p class="p"> - <strong class="ph b">Complex type considerations:</strong> - </p> - <p class="p"> - <strong class="ph b">Examples:</strong> - </p> + <ul class="ul"> + <li class="li"> + <p class="p"> + The options are divided into groups: <code class="ph codeph">Regular Query Options</code>, + <code class="ph codeph">Advanced Query Options</code>, <code class="ph codeph">Development Query Options</code>, + and <code class="ph codeph">Deprecated Query Options</code>. + </p> - <p class="p"> - The following example sets some numeric and some Boolean query options to control usage of memory, disk - space, and timeout periods, then runs a query whose success could depend on the options in effect: - </p> + <ul class="ul"> + <li class="li"> + <p class="p"> + The advanced options are intended for use in specific kinds of performance tuning + and debugging scenarios. + </p> + + </li> + + + <li class="li"> + <p class="p"> + The development options are related to internal development of Impala or features + that are not yet finalized. These options might be changed or removed without + notice. + </p> + + </li> + + + <li class="li"> + <p class="p"> + The deprecated options are related to features that are removed or changed so that + the options no longer have any purpose. These options might be removed in future + versions. + </p> + + </li> + + </ul> + + </li> + + + <li class="li"> + <p class="p"> + By default, only the first two groups, regular and advanced, are displayed by the + <code class="ph codeph">SET</code> command. Use <code class="ph codeph">SET ALL</code> to see all groups of + options. + </p> + + </li> + + + <li class="li"> + <p class="p"> + <span class="keyword cmdname">impala-shell</span> options and user-specified variables are always + displayed at the end of the list of query options, after all appropriate option + groups. + </p> + + </li> + + </ul> -<pre class="pre codeblock"><code>set mem_limit=64g; -set DISABLE_UNSAFE_SPILLS=true; -set parquet_file_size=400m; -set RESERVATION_REQUEST_TIMEOUT=900000; -insert overwrite parquet_table select c1, c2, count(c3) from text_table group by c1, c2, c3; -</code></pre> <p class="p"> <strong class="ph b">Added in:</strong> <span class="keyword">Impala 2.0.0</span> </p> + <p class="p"> - <code class="ph codeph">SET</code> has always been available as an <span class="keyword cmdname">impala-shell</span> command. Promoting it to - a SQL statement lets you use this feature in client applications through the JDBC and ODBC APIs. + <code class="ph codeph">SET</code> has always been available as an <span class="keyword cmdname">impala-shell</span> + command. Promoting it to a SQL statement lets you use this feature in client applications + through the JDBC and ODBC APIs. </p> - - <p class="p"> - <strong class="ph b">Cancellation:</strong> Cannot be cancelled. - </p> - <p class="p"> <strong class="ph b">HDFS permissions:</strong> This statement does not touch any HDFS files or directories, therefore no HDFS permissions are required. </p> + <p class="p"> <strong class="ph b">Related information:</strong> </p> + <p class="p"> - See <a class="xref" href="impala_query_options.html#query_options">Query Options for the SET Statement</a> for the query options you can adjust using this - statement. + See <a class="xref" href="impala_query_options.html#query_options">Query Options for the SET Statement</a> for the query options you can + adjust using this statement. </p> + + </div> -<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../topics/impala_query_options.html">Query Options for the SET Statement</a></strong><br></li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/impala_langref_sql.html">Impala SQL Statements</a></div></div></nav></article></main></body></html> \ No newline at end of file + + +<div class="related-links"> +<ul class="ullinks"> +<li class="link ulchildlink"><strong><a href="../topics/impala_query_options.html">Query Options for the SET Statement</a></strong><br /> +</li> +</ul> + +<div class="familylinks"> +<div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/impala_langref_sql.html">Impala SQL Statements</a></div> +</div> +</div></body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/impala/blob/b4ad38a9/docs/build/html/topics/impala_shell_commands.html ---------------------------------------------------------------------- diff --git a/docs/build/html/topics/impala_shell_commands.html b/docs/build/html/topics/impala_shell_commands.html index 88ab35e..401ef23 100644 --- a/docs/build/html/topics/impala_shell_commands.html +++ b/docs/build/html/topics/impala_shell_commands.html @@ -1,8 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html - SYSTEM "about:legacy-compat"> -<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="concept"><meta name="DC.Relation" scheme="URI" content="../topics/impala_impala_shell.html"><meta name="prodname" content="Impala"><meta name="prodname" content="Impala"><meta name="version" content="Impala 2.12x"><meta name="version" content="Impala 2.12x"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="shell_commands"><link rel="stylesheet" type="text/css" href="../commonltr.css"><title>impala-shell Command Reference</title></head><body id="shell_commands"><main role="main"><article role="article" aria-labelledby="ariaid-title1"> + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + +<meta name="copyright" content="(C) Copyright 2018" /> +<meta name="DC.rights.owner" content="(C) Copyright 2018" /> +<meta name="DC.Type" content="concept" /> +<meta name="DC.Title" content="impala-shell Command Reference" /> +<meta name="DC.Relation" scheme="URI" content="../topics/impala_impala_shell.html" /> +<meta name="prodname" content="Impala" /> +<meta name="prodname" content="Impala" /> +<meta name="version" content="Impala 3.0.x" /> +<meta name="version" content="Impala 3.0.x" /> +<meta name="DC.Format" content="XHTML" /> +<meta name="DC.Identifier" content="shell_commands" /> +<link rel="stylesheet" type="text/css" href="../commonltr.css" /> +<title>impala-shell Command Reference</title> +</head> +<body id="shell_commands"> + <h1 class="title topictitle1" id="ariaid-title1">impala-shell Command Reference</h1> + @@ -18,50 +38,68 @@ details. </p> - <table class="table"><caption></caption><colgroup><col style="width:20%"><col style="width:80%"></colgroup><thead class="thead"> + + +<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="table" frame="border" border="1" rules="all"><colgroup><col style="width:20%" /><col style="width:80%" /></colgroup><thead class="thead" style="text-align:left;"> <tr class="row"> - <th class="entry nocellnorowborder" id="shell_commands__entry__1"> + <th class="entry nocellnorowborder" style="vertical-align:top;" id="d181638e86"> Command </th> - <th class="entry nocellnorowborder" id="shell_commands__entry__2"> + + <th class="entry cell-norowborder" style="vertical-align:top;" id="d181638e89"> Explanation </th> + </tr> - </thead><tbody class="tbody"> - <tr class="row" id="shell_commands__alter_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + </thead> +<tbody class="tbody"> + <tr id="shell_commands__alter_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">alter</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Changes the underlying structure or settings of an Impala table, or a table shared between Impala and Hive. See <a class="xref" href="impala_alter_table.html#alter_table">ALTER TABLE Statement</a> and <a class="xref" href="impala_alter_view.html#alter_view">ALTER VIEW Statement</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__compute_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__compute_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">compute stats</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Gathers important performance-related information for a table, used by Impala to optimize queries. See <a class="xref" href="impala_compute_stats.html#compute_stats">COMPUTE STATS Statement</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__connect_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__connect_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">connect</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Connects to the specified instance of <code class="ph codeph">impalad</code>. The default port of 21000 is assumed unless you provide another value. You can connect to any host in your cluster that is @@ -70,20 +108,26 @@ provide that alternate port. See <a class="xref" href="impala_connecting.html#connecting">Connecting to impalad through impala-shell</a> for examples. </p> + <p class="p"> The <code class="ph codeph">SET</code> statement has no effect until the <span class="keyword cmdname">impala-shell</span> interpreter is connected to an Impala server. Once you are connected, any query options you set remain in effect as you issue a subsequent <code class="ph codeph">CONNECT</code> command to connect to a different Impala host. </p> + </td> + </tr> - <tr class="row" id="shell_commands__describe_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__describe_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">describe</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Shows the columns, column data types, and any column comments for a specified table. <code class="ph codeph">DESCRIBE FORMATTED</code> shows additional information such as the HDFS data directory, @@ -92,139 +136,189 @@ FORMATTED</code> variant. You can use <code class="ph codeph">DESC</code> as shorthand for the <code class="ph codeph">DESCRIBE</code> command. </p> + </td> + </tr> - <tr class="row" id="shell_commands__drop_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__drop_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">drop</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Removes a schema object, and in some cases its associated data files. See <a class="xref" href="impala_drop_table.html#drop_table">DROP TABLE Statement</a>, <a class="xref" href="impala_drop_view.html#drop_view">DROP VIEW Statement</a>, <a class="xref" href="impala_drop_database.html#drop_database">DROP DATABASE Statement</a>, and <a class="xref" href="impala_drop_function.html#drop_function">DROP FUNCTION Statement</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__explain_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__explain_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">explain</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Provides the execution plan for a query. <code class="ph codeph">EXPLAIN</code> represents a query as a series of steps. For example, these steps might be map/reduce stages, metastore operations, or file system operations such as move or rename. See <a class="xref" href="impala_explain.html#explain">EXPLAIN Statement</a> and <a class="xref" href="impala_explain_plan.html#perf_explain">Using the EXPLAIN Plan for Performance Tuning</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__help_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__help_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">help</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Help provides a list of all available commands and options. </p> + </td> + </tr> - <tr class="row" id="shell_commands__history_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__history_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">history</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Maintains an enumerated cross-session command history. This history is stored in the <span class="ph filepath">~/.impalahistory</span> file. </p> + </td> + </tr> - <tr class="row" id="shell_commands__insert_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__insert_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">insert</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Writes the results of a query to a specified table. This either overwrites table data or appends data to the existing table content. See <a class="xref" href="impala_insert.html#insert">INSERT Statement</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__invalidate_metadata_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__invalidate_metadata_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">invalidate metadata</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Updates <span class="keyword cmdname">impalad</span> metadata for table existence and structure. Use this command after creating, dropping, or altering databases, tables, or partitions in Hive. See <a class="xref" href="impala_invalidate_metadata.html#invalidate_metadata">INVALIDATE METADATA Statement</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__profile_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__profile_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">profile</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Displays low-level information about the most recent query. Used for performance diagnosis and tuning. <span class="ph"> The report starts with the same information as produced by the <code class="ph codeph">EXPLAIN</code> statement and the <code class="ph codeph">SUMMARY</code> command.</span> See <a class="xref" href="impala_explain_plan.html#perf_profile">Using the Query Profile for Performance Tuning</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__quit_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__quit_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">quit</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Exits the shell. Remember to include the final semicolon so that the shell recognizes the end of the command. </p> + </td> + </tr> - <tr class="row" id="shell_commands__refresh_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__refresh_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">refresh</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Refreshes <span class="keyword cmdname">impalad</span> metadata for the locations of HDFS blocks corresponding to Impala data files. Use this command after loading new data files into an Impala table through Hive or through HDFS commands. See <a class="xref" href="impala_refresh.html#refresh">REFRESH Statement</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__rerun_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__rerun_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">rerun</code> or <code class="ph codeph">@</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Executes a previous <span class="keyword cmdname">impala-shell</span> command again, from the list of commands displayed by the <code class="ph codeph">history</code> @@ -232,110 +326,138 @@ <span class="keyword cmdname">impala-shell</span> such as <code class="ph codeph">quit</code> or <code class="ph codeph">profile</code>. </p> + <p class="p"> - Specify an integer argument. A positive integer <code class="ph codeph">N</code> - represents the command labelled <code class="ph codeph">N</code> in the history list. - A negative integer <code class="ph codeph">-N</code> represents the <code class="ph codeph">N</code>th - command from the end of the list, such as -1 for the most recent command. - Commands that are executed again do not produce new entries in the - history list. + Specify an integer argument. A positive integer + <code class="ph codeph">N</code> represents the command labelled + <code class="ph codeph">N</code> in the output of the + <code class="ph codeph">HISTORY</code> command. A negative integer + <code class="ph codeph">-N</code> represents the <code class="ph codeph">N</code>th + command from the end of the list, such as -1 for the most recent + command. Commands that are executed again do not produce new + entries in the <code class="ph codeph">HISTORY</code> output list. </p> + </td> + </tr> - <tr class="row" id="shell_commands__select_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__select_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">select</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Specifies the data set on which to complete some action. All information returned from <code class="ph codeph">select</code> can be sent to some output such as the console or a file or can be used to complete some other element of query. See <a class="xref" href="impala_select.html#select">SELECT Statement</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__set_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__set_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">set</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> - <p class="p"> - Manages query options for an <span class="keyword cmdname">impala-shell</span> session. The available options are the - ones listed in <a class="xref" href="impala_query_options.html#query_options">Query Options for the SET Statement</a>. These options are used for - query tuning and troubleshooting. Issue <code class="ph codeph">SET</code> with no arguments to see the current - query options, either based on the <span class="keyword cmdname">impalad</span> defaults, as specified by you at - <span class="keyword cmdname">impalad</span> startup, or based on earlier <code class="ph codeph">SET</code> statements in the same - session. To modify option values, issue commands with the syntax <code class="ph codeph">set - <var class="keyword varname">option</var>=<var class="keyword varname">value</var></code>. To restore an option to its default, - use the <code class="ph codeph">unset</code> command. Some options take Boolean values of <code class="ph codeph">true</code> - and <code class="ph codeph">false</code>. Others take numeric arguments, or quoted string values. + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> + <p class="p"> + Manages query options for an <span class="keyword cmdname">impala-shell</span> + session. The available options are the ones listed in <a class="xref" href="impala_query_options.html#query_options">Query Options for the SET Statement</a>. These options + are used for query tuning and troubleshooting. Issue + <code class="ph codeph">SET</code> with no arguments to see the current + query options, either based on the <span class="keyword cmdname">impalad</span> + defaults, as specified by you at <span class="keyword cmdname">impalad</span> + startup, or based on earlier <code class="ph codeph">SET</code> statements in + the same session. To modify option values, issue commands with + the syntax <code class="ph codeph">set + <var class="keyword varname">option</var>=<var class="keyword varname">value</var></code>. + To restore an option to its default, use the + <code class="ph codeph">unset</code> command. </p> + <p class="p"> The <code class="ph codeph">SET</code> statement has no effect until the <span class="keyword cmdname">impala-shell</span> interpreter is connected to an Impala server. Once you are connected, any query options you set remain in effect as you issue a subsequent <code class="ph codeph">CONNECT</code> command to connect to a different Impala host. </p> - <p class="p"> - In Impala 2.0 and later, <code class="ph codeph">SET</code> is available as a SQL statement for any kind of - application, not only through <span class="keyword cmdname">impala-shell</span>. See - <a class="xref" href="impala_set.html#set">SET Statement</a> for details. - </p> <p class="p"> - In Impala 2.5 and later, you can use <code class="ph codeph">SET</code> to define your own substitution variables - within an <span class="keyword cmdname">impala-shell</span> session. - Within a SQL statement, you substitute the value by using the notation <code class="ph codeph">${var:<var class="keyword varname">variable_name</var>}</code>. + In Impala 2.0 and later, <code class="ph codeph">SET</code> is + available as a SQL statement for any kind of application as well + as in <span class="keyword cmdname">impala-shell</span>. See <a class="xref" href="impala_set.html#set">SET Statement</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__shell_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__shell_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">shell</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Executes the specified command in the operating system shell without exiting <code class="ph codeph">impala-shell</code>. You can use the <code class="ph codeph">!</code> character as shorthand for the <code class="ph codeph">shell</code> command. </p> - <div class="note note note_note"><span class="note__title notetitle">Note:</span> + + <div class="note note"><span class="notetitle">Note:</span> Quote any instances of the <code class="ph codeph">--</code> or <code class="ph codeph">/*</code> tokens to avoid them being interpreted as the start of a comment. To embed comments within <code class="ph codeph">source</code> or <code class="ph codeph">!</code> commands, use the shell comment character <code class="ph codeph">#</code> before the comment portion of the line. </div> + </td> + </tr> - <tr class="row" id="shell_commands__show_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__show_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">show</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Displays metastore data for schema objects created and accessed through Impala, Hive, or both. <code class="ph codeph">show</code> can be used to gather information about objects such as databases, tables, and functions. See <a class="xref" href="impala_show.html#show">SHOW Statement</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__source_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__source_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">source</code> or <code class="ph codeph">src</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Executes one or more statements residing in a specified file from the local filesystem. Allows you to perform the same kinds of batch operations as with the <code class="ph codeph">-f</code> option, @@ -345,72 +467,106 @@ must end with a semicolon. See <a class="xref" href="impala_shell_running_commands.html#shell_running_commands">Running Commands and SQL Statements in impala-shell</a> for examples. </p> + </td> + </tr> - <tr class="row" id="shell_commands__summary_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__summary_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">summary</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Summarizes the work performed in various stages of a query. It provides a higher-level view of the information displayed by the <code class="ph codeph">EXPLAIN</code> command. Added in Impala 1.4.0. See <a class="xref" href="impala_explain_plan.html#perf_summary">Using the SUMMARY Report for Performance Tuning</a> for details about the report format and how to interpret it. </p> + <p class="p"> In <span class="keyword">Impala 2.3</span> and higher, you can see a continuously updated report of the summary information while a query is in progress. See <a class="xref" href="impala_live_summary.html#live_summary">LIVE_SUMMARY Query Option (Impala 2.3 or higher only)</a> for details. </p> + </td> + </tr> - <tr class="row" id="shell_commands__unset_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__unset_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">unset</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Removes any user-specified value for a query option and returns the option to its default value. See <a class="xref" href="impala_query_options.html#query_options">Query Options for the SET Statement</a> for the available query options. </p> + <p class="p"> In <span class="keyword">Impala 2.5</span> and higher, it can also remove user-specified substitution variables using the notation <code class="ph codeph">UNSET VAR:<var class="keyword varname">variable_name</var></code>. </p> + </td> + </tr> - <tr class="row" id="shell_commands__use_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__use_cmd" class="row"> + <td class="entry nocellnorowborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">use</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cell-norowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Indicates the database against which to execute subsequent commands. Lets you avoid using fully qualified names when referring to tables in databases other than <code class="ph codeph">default</code>. See <a class="xref" href="impala_use.html#use">USE Statement</a> for details. Not effective with the <code class="ph codeph">-q</code> option, because that option only allows a single statement in the argument. </p> + </td> + </tr> - <tr class="row" id="shell_commands__version_cmd"> - <td class="entry nocellnorowborder" headers="shell_commands__entry__1 "> + + <tr id="shell_commands__version_cmd" class="row"> + <td class="entry row-nocellborder" style="vertical-align:top;" headers="d181638e86 "> <p class="p"> <code class="ph codeph">version</code> </p> + </td> - <td class="entry nocellnorowborder" headers="shell_commands__entry__2 "> + + <td class="entry cellrowborder" style="vertical-align:top;" headers="d181638e89 "> <p class="p"> Returns Impala version information. </p> + </td> + </tr> - </tbody></table> + + </tbody> +</table> +</div> + </div> -<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/impala_impala_shell.html">Using the Impala Shell (impala-shell Command)</a></div></div></nav></article></main></body></html> \ No newline at end of file + +<div class="related-links"> +<div class="familylinks"> +<div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/impala_impala_shell.html">Using the Impala Shell (impala-shell Command)</a></div> +</div> +</div></body> +</html> \ No newline at end of file
