drill-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tshi...@apache.org
Subject [01/31] drill git commit: new section configuring drill shell
Date Mon, 18 May 2015 23:36:24 GMT
Repository: drill
Updated Branches:
  refs/heads/gh-pages 1b7072c5d -> 3237426be


new section configuring drill shell


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

Branch: refs/heads/gh-pages
Commit: 6c87ff04e06cccd0b80f03fc4b0deb4c43c373ee
Parents: 6ea0c7a
Author: Kristine Hahn <khahn@maprtech.com>
Authored: Sun May 17 11:19:22 2015 -0700
Committer: Kristine Hahn <khahn@maprtech.com>
Committed: Sun May 17 11:19:22 2015 -0700

----------------------------------------------------------------------
 _data/docs.json                                 | 71 ++++++++++++++---
 .../120-configuring-the-drill-shell.md          | 82 ++++++++++++++++++++
 2 files changed, 143 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/drill/blob/6c87ff04/_data/docs.json
----------------------------------------------------------------------
diff --git a/_data/docs.json b/_data/docs.json
index 2bf92ef..9813e92 100644
--- a/_data/docs.json
+++ b/_data/docs.json
@@ -1106,14 +1106,31 @@
                         }
                     ], 
                     "children": [], 
-                    "next_title": "Connect a Data Source", 
-                    "next_url": "/docs/connect-a-data-source/", 
+                    "next_title": "Configuring the Drill Shell", 
+                    "next_url": "/docs/configuring-the-drill-shell/", 
                     "parent": "Configure Drill", 
                     "previous_title": "Ports Used by Drill", 
                     "previous_url": "/docs/ports-used-by-drill/", 
                     "relative_path": "_docs/configure-drill/110-partition-pruning.md", 
                     "title": "Partition Pruning", 
                     "url": "/docs/partition-pruning/"
+                }, 
+                {
+                    "breadcrumbs": [
+                        {
+                            "title": "Configure Drill", 
+                            "url": "/docs/configure-drill/"
+                        }
+                    ], 
+                    "children": [], 
+                    "next_title": "Connect a Data Source", 
+                    "next_url": "/docs/connect-a-data-source/", 
+                    "parent": "Configure Drill", 
+                    "previous_title": "Partition Pruning", 
+                    "previous_url": "/docs/partition-pruning/", 
+                    "relative_path": "_docs/configure-drill/120-configuring-the-drill-shell.md",

+                    "title": "Configuring the Drill Shell", 
+                    "url": "/docs/configuring-the-drill-shell/"
                 }
             ], 
             "next_title": "Configure Drill Introduction", 
@@ -1396,6 +1413,23 @@
             "title": "Configuring a Multitenant Cluster Introduction", 
             "url": "/docs/configuring-a-multitenant-cluster-introduction/"
         }, 
+        "Configuring the Drill Shell": {
+            "breadcrumbs": [
+                {
+                    "title": "Configure Drill", 
+                    "url": "/docs/configure-drill/"
+                }
+            ], 
+            "children": [], 
+            "next_title": "Connect a Data Source", 
+            "next_url": "/docs/connect-a-data-source/", 
+            "parent": "Configure Drill", 
+            "previous_title": "Partition Pruning", 
+            "previous_url": "/docs/partition-pruning/", 
+            "relative_path": "_docs/configure-drill/120-configuring-the-drill-shell.md",

+            "title": "Configuring the Drill Shell", 
+            "url": "/docs/configuring-the-drill-shell/"
+        }, 
         "Connect a Data Source": {
             "breadcrumbs": [], 
             "children": [
@@ -1615,8 +1649,8 @@
             "next_title": "Connect a Data Source Introduction", 
             "next_url": "/docs/connect-a-data-source-introduction/", 
             "parent": "", 
-            "previous_title": "Partition Pruning", 
-            "previous_url": "/docs/partition-pruning/", 
+            "previous_title": "Configuring the Drill Shell", 
+            "previous_url": "/docs/configuring-the-drill-shell/", 
             "relative_path": "_docs/050-connect-a-data-source.md", 
             "title": "Connect a Data Source", 
             "url": "/docs/connect-a-data-source/"
@@ -4741,8 +4775,8 @@
                 }
             ], 
             "children": [], 
-            "next_title": "Connect a Data Source", 
-            "next_url": "/docs/connect-a-data-source/", 
+            "next_title": "Configuring the Drill Shell", 
+            "next_url": "/docs/configuring-the-drill-shell/", 
             "parent": "Configure Drill", 
             "previous_title": "Ports Used by Drill", 
             "previous_url": "/docs/ports-used-by-drill/", 
@@ -9775,14 +9809,31 @@
                         }
                     ], 
                     "children": [], 
-                    "next_title": "Connect a Data Source", 
-                    "next_url": "/docs/connect-a-data-source/", 
+                    "next_title": "Configuring the Drill Shell", 
+                    "next_url": "/docs/configuring-the-drill-shell/", 
                     "parent": "Configure Drill", 
                     "previous_title": "Ports Used by Drill", 
                     "previous_url": "/docs/ports-used-by-drill/", 
                     "relative_path": "_docs/configure-drill/110-partition-pruning.md", 
                     "title": "Partition Pruning", 
                     "url": "/docs/partition-pruning/"
+                }, 
+                {
+                    "breadcrumbs": [
+                        {
+                            "title": "Configure Drill", 
+                            "url": "/docs/configure-drill/"
+                        }
+                    ], 
+                    "children": [], 
+                    "next_title": "Connect a Data Source", 
+                    "next_url": "/docs/connect-a-data-source/", 
+                    "parent": "Configure Drill", 
+                    "previous_title": "Partition Pruning", 
+                    "previous_url": "/docs/partition-pruning/", 
+                    "relative_path": "_docs/configure-drill/120-configuring-the-drill-shell.md",

+                    "title": "Configuring the Drill Shell", 
+                    "url": "/docs/configuring-the-drill-shell/"
                 }
             ], 
             "next_title": "Configure Drill Introduction", 
@@ -10013,8 +10064,8 @@
             "next_title": "Connect a Data Source Introduction", 
             "next_url": "/docs/connect-a-data-source-introduction/", 
             "parent": "", 
-            "previous_title": "Partition Pruning", 
-            "previous_url": "/docs/partition-pruning/", 
+            "previous_title": "Configuring the Drill Shell", 
+            "previous_url": "/docs/configuring-the-drill-shell/", 
             "relative_path": "_docs/050-connect-a-data-source.md", 
             "title": "Connect a Data Source", 
             "url": "/docs/connect-a-data-source/"

http://git-wip-us.apache.org/repos/asf/drill/blob/6c87ff04/_docs/configure-drill/120-configuring-the-drill-shell.md
----------------------------------------------------------------------
diff --git a/_docs/configure-drill/120-configuring-the-drill-shell.md b/_docs/configure-drill/120-configuring-the-drill-shell.md
new file mode 100644
index 0000000..b9ff103
--- /dev/null
+++ b/_docs/configure-drill/120-configuring-the-drill-shell.md
@@ -0,0 +1,82 @@
+---
+title: "Configuring the Drill Shell"
+parent: "Configure Drill"
+---
+At the Drill shell command prompt, typing "help" lists the configuration and other options
you can set to manage shell functionality. Apache Drill 1.0 formats the resultset output tables
for readability if possible. In this release, columns having 70 characters or more cannot
be formatted. This document formats all output for readability and example purposes.
+
+Formatting tables takes time, which you might notice if running a huge query using the default
`outputFormat` setting, which is `table` of the Drill shell. You can set another, more performant
table formatting such as `csv`, as shown in the [examples]({{site.baseurl}}/docs/configuring-the-drill-shell/#examples-of-configuring-the-drill-shell).

+
+
+## Drill Shell Commands
+
+The following table lists the commands that you can run on the Drill command line.
+
+| Command       | Description                                                           
                                 |
+|---------------|---------------------------------------------------------------------------------------------------------|
+| !brief        | Set verbose mode off.                                                 
                                 |
+| !close        | Close the current connection to the database.                         
                                 |
+| !closeall     | Close all current open connections.                                   
                                 |
+| !connect      | Open a new connection to the database.                                
                                 |
+| !help         | Print a summary of command usage.                                     
                                 |
+| !history      | Display the command history.                                          
                                 |
+| !list         | List the current connections.                                         
                                 |
+| !outputformat | Set the output format for displaying results.                         
                                 |
+| !properties   | Connect to the database specified in the properties file(s).          
                                 |
+| !quit         | Exits the Drill shell.                                                
                                 |
+| !reconnect    | Reconnect to the database.                                            
                                 |
+| !record       | Record all output to the specified file.                              
                                 |
+| !run          | Run a script from the specified file.                                 
                                 |
+| !save         | Save the current variables and aliases.                               
                                 |
+| !script       | Start saving a script to a file.                                      
                                 |
+| !set          | Set a [sqlline variable]({{site.baseurl}}/docs/configuring-the-drill-shell/#the-set-command-variables).
|
+| !tables       | List all the tables in the database.                                  
                                 |
+| !verbose      | Show unabbreviated error messages.                                    
                                 |
+
+## Examples of Configuring the Drill Shell
+
+For example, quit the Drill shell:
+
+    0: jdbc:drill:zk=local> !quit
+
+List the current connections. 
+
+    0: jdbc:drill:zk=local> !list
+    1 active connection:
+     #0  open     jdbc:drill:zk=local
+
+Set the maximum width of the Drill shell to 10000.
+
+     0: jdbc:drill:zk=local> !set maxwidth 10000
+
+Set the output format to CSV to improve performance of a huge query.
+
+     0: jdbc:drill:zk=local> !set outputFormat csv
+
+## The Set Command Variables
+
+| Variable Name   | Valid Variable Values  | Description                                
                                                                                         
                               |
+|-----------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| autoCommit      | true/false             | Enable/disable automatic transaction commit.
                                                                                         
                              |
+| autoSave        | true/false             | Automatically save preferences.            
                                                                                         
                               |
+| color           | true/false             | Control whether color is used for display. 
                                                                                         
                               |
+| fastConnect     | true/false             | Skip building table/column list for tab-completion.
                                                                                         
                       |
+| force           | true/false             | Continue running script even after errors. 
                                                                                         
                               |
+| headerInterval  | \<integer\>            | The interval between which headers are
displayed.                                                                               
                                    |
+| historyFile     | \<path\>               | File in which to save command history.
Default is $HOME/.sqlline/history (UNIX, Linux, Mac OS), $HOME/sqlline/history (Windows).
                                    |
+| incremental     | true/false             | Do not receive all rows from server before printing
the first row. Uses fewer resources, especially for long-running queries, but column widths
may be incorrect.    |
+| isolation       | \<level\>              | Set transaction isolation level.     
                                                                                         
                                     |
+| maxColumnWidth  | \<integer\>            | Maximum width for displaying columns.
                                                                                         
                                     |
+| maxHeight       | \<integer\>            | Maximum height of the terminal.      
                                                                                         
                                     |
+| maxWidth        | \<integer\>            | Maximum width of the terminal.       
                                                                                         
                                     |
+| numberFormat    | \<pattern\>            | Format numbers using DecimalFormat pattern.
                                                                                         
                               |
+| outputFormat    | table/vertical/csv/tsv | Format mode for result display.            
                                                                                         
                               |
+| properties      | \<path\>               | File from which SqlLine reads properties
on startup. Default is $HOME/.sqlline/sqlline.properties (UNIX, Linux, Mac OS), $HOME/sqlline/sqlline.properties
(Windows). |
+| rowLimit        | \<integer\>            | Maximum number of rows returned from a
query; zero means no limit.                                                              
                                    |
+| showElapsedTime | true/false             | Display execution time when verbose.       
                                                                                         
                               |
+| showHeader      | true/false             | Show column names in query results.        
                                                                                         
                               |
+| showNestedErrs  | true/false             | Display nested errors.                     
                                                                                         
                               |
+| showWarnings    | true/false             | Display connection warnings.               
                                                                                         
                               |
+| silent          | true/false             | Disable or enable showing information specified
by show commands.                                                                        
                           |
+| timeout         | \<integer\>            | Query timeout in seconds; less than zero
means no timeout.                                                                        
                                  |
+| trimScripts     | true/false             | Remove trailing spaces from lines read from
script files.                                                                            
                               |
+| verbose         | true/false             | Show unabbreviated error messages and debug
info.                                                                                    
                               |
\ No newline at end of file


Mime
View raw message