You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@drill.apache.org by br...@apache.org on 2018/03/21 01:44:42 UTC

drill-site git commit: doc edits and add content about syntax highlighting for sp config and queries, also syntax autocomplete

Repository: drill-site
Updated Branches:
  refs/heads/asf-site c0a9bfba8 -> ff38045cb


doc edits and add content about syntax highlighting for sp config and queries, also syntax autocomplete


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

Branch: refs/heads/asf-site
Commit: ff38045cb423aeec1038c74a28ef369580417059
Parents: c0a9bfb
Author: Bridget Bevens <bb...@maprtech.com>
Authored: Tue Mar 20 18:44:26 2018 -0700
Committer: Bridget Bevens <bb...@maprtech.com>
Committed: Tue Mar 20 18:44:26 2018 -0700

----------------------------------------------------------------------
 .../index.html                                  |   2 +-
 .../index.html                                  |   2 +-
 docs/distributed-mode-prerequisites/index.html  |   4 +--
 docs/drill-in-10-minutes/index.html             |  10 +++----
 docs/embedded-mode-prerequisites/index.html     |   4 +--
 docs/img/ctas-1.png                             | Bin 0 -> 24316 bytes
 docs/img/ctas-2.png                             | Bin 0 -> 6742 bytes
 docs/img/query-1.png                            | Bin 0 -> 48787 bytes
 docs/img/query-2.png                            | Bin 0 -> 39543 bytes
 docs/img/storagep-1.png                         | Bin 0 -> 23453 bytes
 docs/img/storagep-2.png                         | Bin 0 -> 19542 bytes
 docs/plugin-configuration-basics/index.html     |  14 +++++++--
 docs/query-data-introduction/index.html         |  30 +++++++++++++++++--
 .../index.html                                  |   8 ++---
 feed.xml                                        |   4 +--
 15 files changed, 57 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/apache-drill-1-12-0-release-notes/index.html
----------------------------------------------------------------------
diff --git a/docs/apache-drill-1-12-0-release-notes/index.html b/docs/apache-drill-1-12-0-release-notes/index.html
index 1d1e647..f9ac273 100644
--- a/docs/apache-drill-1-12-0-release-notes/index.html
+++ b/docs/apache-drill-1-12-0-release-notes/index.html
@@ -1242,7 +1242,7 @@
 <li>IF NOT EXISTS support for CREATE TABLE and CREATE VIEWS (DRILL-5952)</li>
 <li>Geometry functions, <code>ST_AsGeoJSON</code> and <code>ST_AsJSON</code>, that return GeoJSON and JSON representations (DRILL-5962, DRILL-5960) </li>
 <li>JMX metrics for failed and canceled queries (DRILL-5909)</li>
-<li>Syntax highlighting and error checking for storage plugin configurations (DRILL-5981)</li>
+<li><a href="/docs/plugin-configuration-basics/">Syntax highlighting</a> and error checking for storage plugin configurations (DRILL-5981)</li>
 <li>System options improvements, including a new internal system options table (DRILL-5723)</li>
 <li>Ability to prevent users from accessing a path outside the current workspace (DRILL-5964)</li>
 <li>Ability to put the server in quiescent mode for a graceful shutdown (DRILL-4286)</li>

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/apache-drill-1-13-0-release-notes/index.html
----------------------------------------------------------------------
diff --git a/docs/apache-drill-1-13-0-release-notes/index.html b/docs/apache-drill-1-13-0-release-notes/index.html
index a2a3310..73a89da 100644
--- a/docs/apache-drill-1-13-0-release-notes/index.html
+++ b/docs/apache-drill-1-13-0-release-notes/index.html
@@ -1245,7 +1245,7 @@
 <li>Ability to query an empty directory and use it for queries with any JOIN and UNION (UNION ALL) operators. (<a href="https://issues.apache.org/jira/browse/DRILL-4185">Drill-4185</a>)<br></li>
 <li>Non-numeric support for JSON processing. (<a href="https://issues.apache.org/jira/browse/DRILL-5919">Drill-5919</a>)<br></li>
 <li>New options to that enable you to configure the number of Jetty acceptors and selectors (<a href="https://issues.apache.org/jira/browse/DRILL-5994">DRILL-5994</a>)<br></li>
-<li>Support SQL syntax highlighting of queries, auto-complete support in SQL editors, and snippets. (<a href="https://issues.apache.org/jira/browse/DRILL-5868">DRILL-5868</a>)<br></li>
+<li>Support <a href="/docs/query-data-introduction/#query-syntax-tips">SQL syntax highlighting of queries</a>, auto-complete support in SQL editors, and snippets. (<a href="https://issues.apache.org/jira/browse/DRILL-5868">DRILL-5868</a>)<br></li>
 <li>Improved performance of the Single Merge Exchange operator. (<a href="https://issues.apache.org/jira/browse/DRILL-6115">DRILL-6115</a>)<br></li>
 <li>Like operator optimization. <a href="https://issues.apache.org/jira/browse/DRILL-5879">DRILL-5879</a><br></li>
 <li>User/Distribution-specific configuration checks during startup (<a href="https://issues.apache.org/jira/browse/DRILL-5741">DRILL-5741</a>).<br></li>

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/distributed-mode-prerequisites/index.html
----------------------------------------------------------------------
diff --git a/docs/distributed-mode-prerequisites/index.html b/docs/distributed-mode-prerequisites/index.html
index 5d9c48e..574211c 100644
--- a/docs/distributed-mode-prerequisites/index.html
+++ b/docs/distributed-mode-prerequisites/index.html
@@ -1218,7 +1218,7 @@
 
     </div>
 
-     Nov 29, 2016
+     Mar 21, 2018
 
     <link href="/css/docpage.css" rel="stylesheet" type="text/css">
 
@@ -1232,7 +1232,7 @@ run it in a clustered environment.</p>
 <p>Before you install Drill on nodes in a cluster, ensure that the cluster meets the following prerequisites:</p>
 
 <ul>
-<li>(Required) Running Oracle JDK <a href="http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html">version 7</a> or <a href="http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html">version 8</a> if running Drill 1.6 or later.<br></li>
+<li>(Required) Running Oracle JDK <a href="http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html">version 8</a>.<br></li>
 <li>(Required) Running a <a href="https://zookeeper.apache.org/doc/r3.1.2/zookeeperStarted.html#sc_RunningReplicatedZooKeeper">ZooKeeper quorum</a><br></li>
 <li>(Recommended) Running a Hadoop cluster<br></li>
 <li>(Recommended) Using DNS </li>

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/drill-in-10-minutes/index.html
----------------------------------------------------------------------
diff --git a/docs/drill-in-10-minutes/index.html b/docs/drill-in-10-minutes/index.html
index a23fbe6..f24521b 100644
--- a/docs/drill-in-10-minutes/index.html
+++ b/docs/drill-in-10-minutes/index.html
@@ -1216,7 +1216,7 @@
 
     </div>
 
-     Mar 18, 2018
+     Mar 21, 2018
 
     <link href="/css/docpage.css" rel="stylesheet" type="text/css">
 
@@ -1241,7 +1241,7 @@ without having to perform any setup tasks.</p>
 <p>You need to meet the following prerequisites to run Drill:</p>
 
 <ul>
-<li>Linux, Mac OS X, and Windows: Oracle JDK <a href="http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html">version 7</a> or <a href="http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html">version 8</a> if running Drill 1.6 or later<br></li>
+<li>Linux, Mac OS X, and Windows: Oracle JDK <a href="http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html">version 8</a>.</li>
 <li>Windows only:<br>
 
 <ul>
@@ -1253,13 +1253,13 @@ without having to perform any setup tasks.</p>
 
 <h3 id="java-installation-prerequisite-check">Java Installation Prerequisite Check</h3>
 
-<p>Run the following command in a terminal (Linux and Mac OS X) or Command Prompt (Windows) to verify that Java 7 or 8 is the version in effect:</p>
+<p>Run the following command in a terminal (Linux and Mac OS X) or Command Prompt (Windows) to verify that Java 8 is the version in effect:</p>
 
 <p><code>java -version</code></p>
 
 <p>The output looks something like this:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">java version &quot;1.7.0_79&quot;
-Java(TM) SE Runtime Environment (build 1.7.0_7965-b15)
+<div class="highlight"><pre><code class="language-text" data-lang="text">java version &quot;1.8.0&quot;
+Java(TM) SE Runtime Environment (build 1.8.0_7965-b15)
 Java HotSpot(TM) 64-Bit Server VM (build 24.79-b02, mixed mode)
 </code></pre></div>
 <h2 id="install-drill-on-linux-or-mac-os-x">Install Drill on Linux or Mac OS X</h2>

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/embedded-mode-prerequisites/index.html
----------------------------------------------------------------------
diff --git a/docs/embedded-mode-prerequisites/index.html b/docs/embedded-mode-prerequisites/index.html
index 030266e..9a06fb4 100644
--- a/docs/embedded-mode-prerequisites/index.html
+++ b/docs/embedded-mode-prerequisites/index.html
@@ -1218,7 +1218,7 @@
 
     </div>
 
-     Nov 29, 2016
+     Mar 21, 2018
 
     <link href="/css/docpage.css" rel="stylesheet" type="text/css">
 
@@ -1229,7 +1229,7 @@
 <p>Before you install Drill, ensure that the machine meets the following prerequisites:</p>
 
 <ul>
-<li>Linux, Mac OS X, and Windows: Oracle JDK <a href="http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html">version 7</a> or <a href="http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html">version 8</a> if running Drill 1.6 or later.<br></li>
+<li>Linux, Mac OS X, and Windows: Oracle JDK <a href="http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html">version 8</a>.<br></li>
 <li>Windows only:<br>
 
 <ul>

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/img/ctas-1.png
----------------------------------------------------------------------
diff --git a/docs/img/ctas-1.png b/docs/img/ctas-1.png
new file mode 100644
index 0000000..ce99da2
Binary files /dev/null and b/docs/img/ctas-1.png differ

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/img/ctas-2.png
----------------------------------------------------------------------
diff --git a/docs/img/ctas-2.png b/docs/img/ctas-2.png
new file mode 100644
index 0000000..1c3a49b
Binary files /dev/null and b/docs/img/ctas-2.png differ

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/img/query-1.png
----------------------------------------------------------------------
diff --git a/docs/img/query-1.png b/docs/img/query-1.png
new file mode 100644
index 0000000..d053985
Binary files /dev/null and b/docs/img/query-1.png differ

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/img/query-2.png
----------------------------------------------------------------------
diff --git a/docs/img/query-2.png b/docs/img/query-2.png
new file mode 100644
index 0000000..275ef91
Binary files /dev/null and b/docs/img/query-2.png differ

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/img/storagep-1.png
----------------------------------------------------------------------
diff --git a/docs/img/storagep-1.png b/docs/img/storagep-1.png
new file mode 100644
index 0000000..b53450e
Binary files /dev/null and b/docs/img/storagep-1.png differ

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/img/storagep-2.png
----------------------------------------------------------------------
diff --git a/docs/img/storagep-2.png b/docs/img/storagep-2.png
new file mode 100644
index 0000000..552b5ee
Binary files /dev/null and b/docs/img/storagep-2.png differ

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/plugin-configuration-basics/index.html
----------------------------------------------------------------------
diff --git a/docs/plugin-configuration-basics/index.html b/docs/plugin-configuration-basics/index.html
index 64d597d..36ffabc 100644
--- a/docs/plugin-configuration-basics/index.html
+++ b/docs/plugin-configuration-basics/index.html
@@ -1218,7 +1218,7 @@
 
     </div>
 
-     Feb 13, 2018
+     Mar 21, 2018
 
     <link href="/css/docpage.css" rel="stylesheet" type="text/css">
 
@@ -1250,9 +1250,19 @@ name. Names are case-sensitive.<br>
 <li><p>Click <strong>Create</strong>.  </p></li>
 <li><p>In Configuration, use JSON formatting to modify a copy of an existing configuration if possible.<br>
 Using a copy of an existing configuration reduces the risk of JSON coding errors. Use the Storage Plugin Attributes table in the next section as a guide for making typical modifications.  </p></li>
-<li><p>Click <strong>Create</strong>.</p></li>
+<li><p>Click <strong>Create</strong>.  </p></li>
 </ol>
 
+<p>Note: Drill 1.12 and later provides syntax highlighting and error checking for plugin configurations to prevent syntax errors, such as missing commas or curly brackets, when configuring storage plugins. </p>
+
+<p>You can see an example of syntax highlighting for a storage plugin configuration in the following image:  </p>
+
+<p><img src="https://i.imgur.com/LdiQC7E.png" alt="">  </p>
+
+<p>A red box with an x indicates that the syntax contains an error, as shown in the following image:  </p>
+
+<p><img src="https://i.imgur.com/cFDCH0v.png" alt=""> </p>
+
 <h2 id="storage-plugin-attributes">Storage Plugin Attributes</h2>
 
 <p>The following graphic shows key attributes of a typical <code>dfs</code>-based storage plugin configuration:<br>

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/query-data-introduction/index.html
----------------------------------------------------------------------
diff --git a/docs/query-data-introduction/index.html b/docs/query-data-introduction/index.html
index 223087f..9d43819 100644
--- a/docs/query-data-introduction/index.html
+++ b/docs/query-data-introduction/index.html
@@ -1216,7 +1216,7 @@
 
     </div>
 
-     
+     Mar 21, 2018
 
     <link href="/css/docpage.css" rel="stylesheet" type="text/css">
 
@@ -1261,9 +1261,35 @@ default, most of the plan output is hidden.</p>
 <code>Example:</code>!set maxwidth 10000`</li>
 <li>Use backticks around <a href="/docs/reserved-keywords">keywords</a>, special characters, and <a href="/docs/lexical-structure/#identifier">identifiers</a> that SQL cannot parse, such as the keyword default and a path that contains a forward slash character:
 Example: <code>SELECT * FROM dfs.`default`.`/Users/drilluser/apache-drill-1.1.0/sample-data/nation.parquet`;</code></li>
-<li>When selecting all (SELECT *) schema-less data, the order of returned columns might differ from the stored order and might vary from query to query.</li>
+<li>When selecting all (SELECT *) schema-less data, the order of returned columns might differ from the stored order and might vary from query to query.<br></li>
 </ul>
 
+<h3 id="syntax-highlighting-and-sql-templates">Syntax Highlighting and SQL Templates</h3>
+
+<p>Drill 1.13 extends the syntax highlighting feature for storage plugin configurations to queries. </p>
+
+<p>You can see queries with highlighted syntax in the query profile on the Query tab, as shown in the following image:  </p>
+
+<p><img src="https://i.imgur.com/ZcXDQwV.png" alt="">  </p>
+
+<p>The Edit Query tab auto-populates with the query so you can easily edit and rerun a query.  </p>
+
+<p>In addition to syntax highlighting, an autocomplete feature enables you to use snippets (SQL templates) to quickly write syntax for queries.  </p>
+
+<p><strong>Using the Autocomplete Feature</strong>  </p>
+
+<p>On the Query page in the Drill Web Console, place your cursor in the Query window and press <code>ctrl+space</code>. A drop-down menu of Drill keywords, functions, and templates appears. Use the up and down arrows on the keyboard to scroll through the list.  </p>
+
+<p><strong>Note:</strong> The <code>s*</code> option provides the template for a SELECT query.  </p>
+
+<p>The following image shows the snippet for creating a temporary table:  </p>
+
+<p><img src="https://i.imgur.com/yKMSIRV.png" alt="">  </p>
+
+<p>When you select the <code>ctas</code> option, the CTAS syntax is automatically written for you, as shown in the following image:  </p>
+
+<p><img src="https://i.imgur.com/TzmZFi5.png" alt=""></p>
+
     
       
         <div class="doc-nav">

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/docs/starting-drill-in-distributed-mode/index.html
----------------------------------------------------------------------
diff --git a/docs/starting-drill-in-distributed-mode/index.html b/docs/starting-drill-in-distributed-mode/index.html
index cb37ab5..c99a41b 100644
--- a/docs/starting-drill-in-distributed-mode/index.html
+++ b/docs/starting-drill-in-distributed-mode/index.html
@@ -1218,7 +1218,7 @@
 
     </div>
 
-     Mar 20, 2018
+     Mar 21, 2018
 
     <link href="/css/docpage.css" rel="stylesheet" type="text/css">
 
@@ -1315,7 +1315,7 @@ Drill lists information about the Drillbits that are running, such as the host n
 
 <h2 id="shut-down-the-drill-process-on-a-node">Shut Down the Drill Process on a Node</h2>
 
-<p>You can abruptly stop the Drill process on a node, or you can gracefully shut down the Drill process on a node. When you stop the Drill process on a node, active queries cannot complete if they need additional time beyond the default five second wait period. In Drill 1.12 and later, you can use the graceful_stop command, which transitions a Drillbit into a quiescent state in which the Drill process can complete in-progress queries before shutting down.  </p>
+<p>You can abruptly stop the Drill process on a node, or you can gracefully shut down the Drill process on a node. When you stop the Drill process on a node, active queries cannot complete if they need additional time beyond the default five second wait period. In Drill 1.12 and later, you can use the graceful_stop command to transition a Drillbit into a quiescent state in which the Drillbit can complete in-progress queries before shutting down.  </p>
 
 <h3 id="stopping-the-drill-process">Stopping the Drill Process</h3>
 
@@ -1324,7 +1324,7 @@ Drill lists information about the Drillbits that are running, such as the host n
 </code></pre></div>
 <h3 id="gracefully-shutting-down-the-drill-process">Gracefully Shutting Down the Drill Process</h3>
 
-<p>Graceful shutdown is enabled by default. You can gracefully shutdown a Drillbit from the command line or the Drill Web Console. When you initiate a graceful shutdown from the Drill Web Console, the console posts an alert stating that a graceful shutdown was triggered. You can see the progress of the shutdown as the Drillbit completes queries and transitions through the quiescent state.  </p>
+<p>Graceful shutdown is enabled by default. You can gracefully shut down a Drillbit from the command line or the Drill Web Console. When you initiate graceful shutdown from the Drill Web Console, the console posts an alert stating that a graceful shutdown was triggered. You can see the progress of the shut down as the Drillbit completes queries and transitions through the quiescent state.  </p>
 
 <p><strong>How A Drillbit Shuts Down Gracefully</strong>  </p>
 
@@ -1346,7 +1346,7 @@ Drill lists information about the Drillbits that are running, such as the host n
 </ul>
 
 <p><strong>Shutting Down a Drillbit Gracefully</strong><br>
-You can gracefully shutdown a node from the command line or the Drill Web Console. </p>
+You can gracefully shut down a Drillbit from the command line or the Drill Web Console. </p>
 
 <p>From the command line, run the following command on the node you want to shut down:  </p>
 <div class="highlight"><pre><code class="language-text" data-lang="text">   drillbit.sh graceful_stop

http://git-wip-us.apache.org/repos/asf/drill-site/blob/ff38045c/feed.xml
----------------------------------------------------------------------
diff --git a/feed.xml b/feed.xml
index f9b2340..4205773 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
 </description>
     <link>/</link>
     <atom:link href="/feed.xml" rel="self" type="application/rss+xml"/>
-    <pubDate>Mon, 19 Mar 2018 17:09:03 -0700</pubDate>
-    <lastBuildDate>Mon, 19 Mar 2018 17:09:03 -0700</lastBuildDate>
+    <pubDate>Tue, 20 Mar 2018 18:42:10 -0700</pubDate>
+    <lastBuildDate>Tue, 20 Mar 2018 18:42:10 -0700</lastBuildDate>
     <generator>Jekyll v2.5.2</generator>
     
       <item>