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/12/28 00:39:10 UTC

[drill] branch gh-pages updated: doc updates and edits DRILL-6611

This is an automated email from the ASF dual-hosted git repository.

bridgetb pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/drill.git


The following commit(s) were added to refs/heads/gh-pages by this push:
     new b8732cb  doc updates and edits DRILL-6611
b8732cb is described below

commit b8732cb64320d97c1d1f633cce51525ad2c004f5
Author: Bridget Bevens <bb...@maprtech.com>
AuthorDate: Thu Dec 27 16:38:30 2018 -0800

    doc updates and edits DRILL-6611
---
 .../030-planning-and-exececution-options.md        |  16 +++++++++-------
 _docs/img/web_ui_reset_default.PNG                 | Bin 46472 -> 100852 bytes
 _docs/install/060-starting-the-web-ui.md           |  20 +++++++++++++++-----
 3 files changed, 24 insertions(+), 12 deletions(-)

diff --git a/_docs/configure-drill/configuration-options/030-planning-and-exececution-options.md b/_docs/configure-drill/configuration-options/030-planning-and-exececution-options.md
index 3393f8e..f486435 100644
--- a/_docs/configure-drill/configuration-options/030-planning-and-exececution-options.md
+++ b/_docs/configure-drill/configuration-options/030-planning-and-exececution-options.md
@@ -1,19 +1,19 @@
 ---
 title: "Planning and Execution Options"
-date: 2018-12-27
+date: 2018-12-28
 parent: "Configuration Options"
 ---
 You can set Drill query planning and execution options per cluster, at the
 system or session level. Options set at the session level only apply to
 queries that you run during the current Drill connection. Options set at the
 system level affect the entire system and persist between restarts. Session
-level settings override system level settings.  
+level settings override system level settings for the duration of the session.  
 
 Planning options are prepended by planner, for example `planner.enable_hashjoin`. Execution options are prepended by drill.exe, for example `drill.exec.functions.cast_empty_string_to_null`.
  
 
 ## Setting Planning and Execution Options  
-You can set planning and execution options for Drill from the Drill shell (SQLLine) or the Drill Web UI. Options set in the Drill Web UI are set at the system level. You can override system level options set in the Drill Web UI by setting the options at the session level from the Drill shell. Session level options override system-level options for the duration of the session.  
+You can set planning and execution options for Drill from the Drill shell (SQLLine) or the Drill Web UI. Options set in the Drill Web UI are set at the system level. You can override system level options set in the Drill Web UI by setting the options at the session level from the Drill shell.   
 
 ### Setting Options from the Drill Shell 
 
@@ -39,17 +39,19 @@ See [Querying the Options Table]({{site.baseurl}}/docs/querying-system-tables/#q
 
 ### Setting Options from the Drill Web UI  
 
-When Drill is running, you can access the Drill Web UI at `http://<drill-hostname>:8047/`. The Drill Web UI has an Options button located in the upper right corner that you can click to display an Options page. The Options page lists all the Drill options that you can set. When you set options from this page, you are setting the options at the system level. To override an option for the duration of a session, set the option from the Drill shell using the SET command.  
+When Drill is running, you can access the Drill Web UI at `http://<drill-hostname>:8047/`. The Drill Web UI has an Options button located in the upper right corner that you can click to display an Options page. The Options page lists all the Drill options that you can set. When you set options from this page, you are setting the options at the system level. To override an option for the duration of a session, set the option from the Drill shell using the SET command.   
+
+![](https://i.imgur.com/SQH3YNT.png) 
 
 Starting in Drill 1.15, the Options page includes the following enhancements:  
   
 **Search Field**  
 The search field enables you to quickly search across all available Drill configuration options to quickly find options you are interested in. For example, you can search on the keyword "memory" for a list of all options related to configuring Drill memory.
 
-**Quick Filter Buttons**  
-Next to the search field are quick filter buttons that filter options by important keywords in one click. For example, the Planner quick filter button quickly lists all options related to the query planner. The query planning options are prepended by the keyword "planner." Quick filters return options that include the keyword in the option name and/or description. 
+**Quick Filters**  
+Next to the search field are quick filter buttons that filter options by important keywords in one click. For example, the "planner" quick filter button quickly lists all options related to the query planner. The query planning options are prepended by the keyword "planner." Quick filters return options that include the keyword in the option name and/or description. 
 
-**Default Button** 
+**Default Button**  
 Each option has a Default button that indicates whether the default value for the option was changed. If the Default button is not active, the option is currently set to the default value. If the default button is active, the value of the option was changed from the default. Clicking an active Default button resets the value of the option back to the original (default) value. 
 
 **Web Display Options**  
diff --git a/_docs/img/web_ui_reset_default.PNG b/_docs/img/web_ui_reset_default.PNG
index 9774733..66e5d69 100644
Binary files a/_docs/img/web_ui_reset_default.PNG and b/_docs/img/web_ui_reset_default.PNG differ
diff --git a/_docs/install/060-starting-the-web-ui.md b/_docs/install/060-starting-the-web-ui.md
index 4c9f710..54d6992 100644
--- a/_docs/install/060-starting-the-web-ui.md
+++ b/_docs/install/060-starting-the-web-ui.md
@@ -1,21 +1,31 @@
 ---
 title: "Starting the Web UI"
-date: 2018-12-27
+date: 2018-12-28
 parent: Install Drill
 ---
 
-The Drill Web UI is one of several [client interfaces](/docs/architecture-introduction/#drill-clients) that you can use to access Drill. 
+The Drill Web UI is one of several [client interfaces](/docs/architecture-introduction/#drill-clients) that you can use to access Drill. You can perform the following activities from the Drill Web UI:  
 
-To open the Drill Web UI, launch a web browser, and go to one of the following URLs depending on the configuration:
+- [Run queries]({{site.baseurl}}/docs/query-data-introduction/) 
+- [Monitor and cancel queries]({{site.baseurl}}/docs/monitoring-and-canceling-queries-in-the-drill-web-ui/)
+- [View query profiles]({{site.baseurl}}/docs/query-profiles/)
+- [Update and configure storage plugins]({{site.baseurl}}/docs/storage-plugin-registration/)
+- View [logs]({{site.baseurl}}/docs/log-and-debug-introduction/) and [metrics]({{site.baseurl}}/docs/monitoring-metrics/)
+- [Set configuration options]({{site.baseurl}}/docs/planning-and-execution-options/#setting-options-from-the-drill-web-ui)  
+
+Starting in Drill 1.15, you can use a Meta+Enter key combination instead of clicking the Submit button to submit queries through the query editor (Query page) in  Drill Web UI. On Mac keyboards, the combination is Ctrl+Meta or Ctrl+Enter. On Windows and Linux, the combination is Ctrl+Enter; however, on Linux, if you mapped the meta key to another physical key on the keyboard, use that key + Enter. 
+ 
+## Accessing the Web UI
+To access the Drill Web UI, enter the URL appropriate for your Drill configuration. The following list describes the URLs for various Drill configurations: 
 
 * `http://<IP address or host name>:8047`  
   Use this URL when [HTTPS support]({{site.baseurl}}/docs/configuring-web-console-and-rest-api-security/#https-support) is disabled (the default).
 * `https://<IP address or host name>:8047`  
   Use this URL when HTTPS support is enabled.  
 * `http://localhost:8047`   
-Use  this URL when running ./drill-embedded.
+  Use  this URL when running Drill in embedded mode (./drill-embedded).
 
-## Drill 1.2 and Later
+## Web UI Security
 
 If [user authentication]({{site.baseurl}}/docs/configuring-user-authentication/) is not enabled, all the Web UI controls appear to users as well as administrators: