You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mo...@apache.org on 2016/01/17 17:20:26 UTC
svn commit: r1725100 [1/2] - in
/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT: ./
assets/themes/zeppelin/img/docs-img/ development/ interpreter/ manual/
rest-api/ tutorial/
Author: moon
Date: Sun Jan 17 16:20:26 2016
New Revision: 1725100
URL: http://svn.apache.org/viewvc?rev=1725100&view=rev
Log:
https://github.com/apache/incubator-zeppelin/pull/578
Added:
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-bucket-pie.png (with props)
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-value-metric.png (with props)
Removed:
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/docs.html
Modified:
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/index.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/cassandra.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/elasticsearch.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/flink.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/hive.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/lens.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/markdown.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/manual/interpreters.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rss.xml
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/sitemap.txt
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/tutorial/tutorial.html
Added: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-bucket-pie.png
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-bucket-pie.png?rev=1725100&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-bucket-pie.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-value-metric.png
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-value-metric.png?rev=1725100&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-value-metric.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml Sun Jan 17 16:20:26 2016
@@ -4,7 +4,7 @@
<title>Apache Zeppelin (incubating)</title>
<link href="http://zeppelin.incubator.apache.org/" rel="self"/>
<link href="http://zeppelin.incubator.apache.org"/>
- <updated>2016-01-03T08:03:20-08:00</updated>
+ <updated>2016-01-17T08:21:02-08:00</updated>
<id>http://zeppelin.incubator.apache.org</id>
<author>
<name>The Apache Software Foundation</name>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html Sun Jan 17 16:20:26 2016
@@ -164,24 +164,21 @@ Interpreters in the same InterpreterGrou
<h3>Make your own Interpreter</h3>
-<p>Creating a new interpreter is quite simple. Just extend <a href="https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/Interpreter.java">org.apache.zeppelin.interpreter</a> abstract class and implement some methods.</p>
-
-<p>You can include org.apache.zeppelin:zeppelin-interpreter:[VERSION] artifact in your build system.</p>
-
-<p>Your interpreter name is derived from the static register method</p>
+<p>Creating a new interpreter is quite simple. Just extend <a href="https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/Interpreter.java">org.apache.zeppelin.interpreter</a> abstract class and implement some methods.
+You can include <code>org.apache.zeppelin:zeppelin-interpreter:[VERSION]</code> artifact in your build system.
+Your interpreter name is derived from the static register method.</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">static {
Interpreter.register("MyInterpreterName", MyClassName.class.getName());
}
</code></pre></div>
-<p>The name will appear later in the interpreter name option box during the interpreter configuration process.</p>
-
-<p>The name of the interpreter is what you later write to identify a paragraph which should be interpreted using this interpreter.</p>
+<p>The name will appear later in the interpreter name option box during the interpreter configuration process.
+The name of the interpreter is what you later write to identify a paragraph which should be interpreted using this interpreter.</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">%MyInterpreterName
-some interpreter spesific code...
+some interpreter specific code...
</code></pre></div>
<h3>Install your interpreter binary</h3>
-<p>Once you have build your interpreter, you can place your interpreter under directory with all the dependencies.</p>
+<p>Once you have built your interpreter, you can place it under the interpreter directory with all its dependencies.</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">[ZEPPELIN_HOME]/interpreter/[INTERPRETER_NAME]/
</code></pre></div>
<h3>Configure your interpreter</h3>
@@ -189,31 +186,33 @@ some interpreter spesific code...
<p>To configure your interpreter you need to follow these steps:</p>
<ol>
-<li><p>create conf/zeppelin-site.xml by copying conf/zeppelin-site.xml.template to conf/zeppelin-site.xml </p></li>
-<li><p>Add your interpreter class name to the zeppelin.interpreters property in conf/zeppelin-site.xml</p>
+<li><p>Add your interpreter class name to the zeppelin.interpreters property in <code>conf/zeppelin-site.xml</code>.</p>
-<p>Property value is comma separated [INTERPRETER<em>CLASS</em>NAME]
-for example,</p>
+<p>Property value is comma separated [INTERPRETER_CLASS_NAME].
+For example,</p></li>
+</ol>
<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
-<name>zeppelin.interpreters</name>
-<value>org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.shell.ShellInterpreter,org.apache.zeppelin.hive.HiveInterpreter,com.me.MyNewInterpreter</value>
+ <name>zeppelin.interpreters</name>
+ <value>org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.shell.ShellInterpreter,org.apache.zeppelin.hive.HiveInterpreter,com.me.MyNewInterpreter</value>
</property>
-</code></pre></div></li>
-<li><p>start zeppelin by running <code>./bin/zeppelin-deamon start</code></p></li>
-<li><p>in the interpreter page, click the +Create button and configure your interpreter properties.
+</code></pre></div>
+<ol>
+<li><p>Add your interpreter to the <a href="https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397">default configuration</a> which is used when there is no <code>zeppelin-site.xml</code>.</p></li>
+<li><p>Start Zeppelin by running <code>./bin/zeppelin-daemon.sh start</code>.</p></li>
+<li><p>In the interpreter page, click the <code>+Create</code> button and configure your interpreter properties.
Now you are done and ready to use your interpreter.</p></li>
</ol>
-<p>Note that the interpreters shipped with zeppelin have a <a href="https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397">default configuration</a> which is used when there is no zeppelin-site.xml.</p>
+<p>Note that the interpreters shipped with zeppelin have a <a href="https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397">default configuration</a> which is used when there is no <code>conf/zeppelin-site.xml</code>.</p>
<h3>Use your interpreter</h3>
<h4>0.5.0</h4>
-<p>Inside of a notebook, %[INTERPRETER_NAME] directive will call your interpreter.
+<p>Inside of a notebook, <code>%[INTERPRETER_NAME]</code> directive will call your interpreter.
Note that the first interpreter configuration in zeppelin.interpreters will be the default one.</p>
-<p>for example</p>
+<p>For example,</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">%myintp
val a = "My interpreter"
@@ -223,15 +222,13 @@ println(a)
<h4>0.6.0 and later</h4>
-<p>Inside of a notebook, %[INTERPRETER_GROUP].[INTERPRETER_NAME] directive will call your interpreter.
+<p>Inside of a notebook, <code>%[INTERPRETER_GROUP].[INTERPRETER_NAME]</code> directive will call your interpreter.
Note that the first interpreter configuration in zeppelin.interpreters will be the default one.</p>
-<p>You can omit either [INTERPRETER_GROUP] or [INTERPRETER_NAME]. Omit [INTERPRETER_NAME] selects first available interpreter in the [INTERPRETER_GROUP].
-Omit '[INTERPRETER_GROUP]' will selects [INTERPRETER_NAME] from default interpreter group.</p>
-
-<p>For example, if you have two interpreter myintp1 and myintp2 in group mygrp,</p>
+<p>You can omit either [INTERPRETER_GROUP] or [INTERPRETER_NAME]. If you omit [INTERPRETER_NAME], then first available interpreter will be selected in the [INTERPRETER_GROUP].
+Likewise, if you skip [INTERPRETER_GROUP], then [INTERPRETER_NAME] will be chosen from default interpreter group.</p>
-<p>you can call myintp1 like</p>
+<p>For example, if you have two interpreter myintp1 and myintp2 in group mygrp, you can call myintp1 like</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">%mygrp.myintp1
codes for myintp1
@@ -241,7 +238,7 @@ codes for myintp1
codes for myintp2
</code></pre></div>
-<p>If you omit your interpreter name, it'll selects first available interpreter in the group (myintp1)</p>
+<p>If you omit your interpreter name, it'll select first available interpreter in the group ( myintp1 ).</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">%mygrp
codes for myintp1
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/index.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/index.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/index.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/index.html Sun Jan 17 16:20:26 2016
@@ -259,7 +259,7 @@ This way, you can easily embed it as an
<h3>100% Opensource</h3>
-<p>Apache Zeppelin (incubating) is Apache2 Licensed software. Please check out the <a href="https://github.com/apache/incubator-zeppelin">source repository</a> and <a href="./development/howtocontribute.html">How to contribute</a></p>
+<p>Apache Zeppelin (incubating) is Apache2 Licensed software. Please check out the <a href="http://git.apache.org/incubator-zeppelin.git">source repository</a> and <a href="./development/howtocontribute.html">How to contribute</a></p>
<p>Zeppelin has a very active development community.
Join the <a href="./community.html">Mailing list</a> and report issues on our <a href="https://issues.apache.org/jira/browse/ZEPPELIN">Issue tracker</a>.</p>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/cassandra.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/cassandra.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/cassandra.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/cassandra.html Sun Jan 17 16:20:26 2016
@@ -138,11 +138,8 @@
<div class="row">
<div class="col-md-12">
- <hr/>
+ <h2>1. Cassandra CQL Interpreter for Apache Zeppelin</h2>
-<h2>1. Cassandra CQL Interpreter for Apache Zeppelin</h2>
-
-<p><br/>
<table class="table-configuration">
<tr>
<th>Name</th>
@@ -154,37 +151,31 @@
<td>CassandraInterpreter</td>
<td>Provides interpreter for Apache Cassandra CQL query language</td>
</tr>
-</table></p>
-
-<hr/>
+</table>
<h2>2. Enabling Cassandra Interpreter</h2>
-<p>In a notebook, to enable the <strong>Cassandra</strong> interpreter, click on the <strong>Gear</strong> icon and select <strong>Cassandra</strong></p>
+<p>In a notebook, to enable the <strong>Cassandra</strong> interpreter, click on the <strong>Gear</strong> icon and select <strong>Cassandra</strong>.</p>
<p><center>
- <img src="../assets/themes/zeppelin/img/docs-img/cassandra-InterpreterBinding.png" alt="Interpreter Binding"></p>
-
-<p><img src="../assets/themes/zeppelin/img/docs-img/cassandra-InterpreterSelection.png" alt="Interpreter Selection">
+ <img src="../assets/themes/zeppelin/img/docs-img/cassandra-InterpreterBinding.png" width="25%" height="25%">
+ <br>
+ <img src="../assets/themes/zeppelin/img/docs-img/cassandra-InterpreterSelection.png" width="25%" height="25%">
</center></p>
-<hr/>
-
<h2>3. Using the Cassandra Interpreter</h2>
<p>In a paragraph, use <strong><em>%cassandra</em></strong> to select the <strong>Cassandra</strong> interpreter and then input all commands.</p>
-<p>To access the interactive help, type <strong>HELP;</strong></p>
+<p>To access the interactive help, type <code>HELP;</code></p>
<p><center>
- <img src="../assets/themes/zeppelin/img/docs-img/cassandra-InteractiveHelp.png" alt="Interactive Help">
+ <img src="../assets/themes/zeppelin/img/docs-img/cassandra-InteractiveHelp.png" width="50%" height="50%">
</center></p>
-<hr/>
-
<h2>4. Interpreter Commands</h2>
-<p>The <strong>Cassandra</strong> interpreter accepts the following commands</p>
+<p>The <strong>Cassandra</strong> interpreter accepts the following commands.</p>
<p><center>
<table class="table-configuration">
@@ -218,11 +209,9 @@
<td>All CQL-compatible statements (SELECT, INSERT, CREATE ...)</td>
<td>All CQL statements are executed directly against the Cassandra server</td>
</tr>
- </table><br>
+ </table>
</center></p>
-<hr/>
-
<h2>5. CQL statements</h2>
<p>This interpreter is compatible with any CQL statement supported by Cassandra. Ex: </p>
@@ -269,7 +258,7 @@ This means that the following statements
<span class="k">Insert</span> <span class="k">into</span> <span class="n">users</span><span class="p">(</span><span class="n">login</span><span class="p">,</span><span class="n">name</span><span class="p">)</span> <span class="k">vAlues</span><span class="p">(</span><span class="s1">'hsue'</span><span class="p">,</span><span class="s1">'Helen SUE'</span><span class="p">);</span>
</code></pre></div>
<p>The complete list of all CQL statements and versions can be found below:
-<center><br>
+<center>
<table class="table-configuration">
<tr>
<th>Cassandra Version</th>
@@ -283,7 +272,7 @@ This means that the following statements
http://docs.datastax.com/en/cql/3.3/cql/cqlIntro.html
</a>
</td>
- </tr><br>
+ </tr>
<tr>
<td><strong>2.1 & 2.0</strong></td>
<td>
@@ -292,7 +281,7 @@ This means that the following statements
http://docs.datastax.com/en/cql/3.1/cql/cql<em>intro</em>c.html
</a>
</td>
- </tr><br>
+ </tr>
<tr>
<td><strong>1.2</strong></td>
<td>
@@ -301,12 +290,10 @@ This means that the following statements
http://docs.datastax.com/en/cql/3.0/cql/aboutCQL.html
</a>
</td>
- </tr><br>
+ </tr>
</table>
</center></p>
-<hr/>
-
<h2>6. Comments in statements</h2>
<p>It is possible to add comments between statements. Single line comments start with the hash sign (#). Multi-line comments are enclosed between /** and **/. Ex: </p>
@@ -319,21 +306,17 @@ This means that the following statements
<span class="cm"> **/</span>
<span class="k">Insert</span> <span class="k">into</span> <span class="n">users</span><span class="p">(</span><span class="n">login</span><span class="p">,</span><span class="n">name</span><span class="p">)</span> <span class="k">vAlues</span><span class="p">(</span><span class="s1">'hsue'</span><span class="p">,</span><span class="s1">'Helen SUE'</span><span class="p">);</span>
</code></pre></div>
-<hr/>
-
<h2>7. Syntax Validation</h2>
<p>The interpreters is shipped with a built-in syntax validator. This validator only checks for basic syntax errors.
-All CQL-related syntax validation is delegated directly to <strong>Cassandra</strong> </p>
+All CQL-related syntax validation is delegated directly to <strong>Cassandra</strong>.</p>
<p>Most of the time, syntax errors are due to <strong>missing semi-colons</strong> between statements or <strong>typo errors</strong>.</p>
-<hr/>
-
<h2>8. Schema commands</h2>
<p>To make schema discovery easier and more interactive, the following commands are supported:
-<center><br>
+<center>
<table class="table-configuration">
<tr>
<th>Command</th>
@@ -342,76 +325,72 @@ All CQL-related syntax validation is del
<tr>
<td><strong>DESCRIBE CLUSTER;</strong></td>
<td>Show the current cluster name and its partitioner</td>
- </tr><br>
+ </tr>
<tr>
<td><strong>DESCRIBE KEYSPACES;</strong></td>
<td>List all existing keyspaces in the cluster and their configuration (replication factor, durable write ...)</td>
- </tr><br>
+ </tr>
<tr>
<td><strong>DESCRIBE TABLES;</strong></td>
<td>List all existing keyspaces in the cluster and for each, all the tables name</td>
- </tr><br>
+ </tr>
<tr>
<td><strong>DESCRIBE TYPES;</strong></td>
<td>List all existing user defined types in the <strong>current (logged) keyspace</strong></td>
- </tr><br>
+ </tr>
<tr>
<td nowrap><strong>DESCRIBE FUNCTIONS <keyspace<em>name>;</strong></td>
<td>List all existing user defined functions in the given keyspace</td>
- </tr><br>
+ </tr>
<tr>
<td nowrap><strong>DESCRIBE AGGREGATES <keyspace</em>name>;</strong></td>
<td>List all existing user defined aggregates in the given keyspace</td>
- </tr><br>
+ </tr>
<tr>
<td nowrap><strong>DESCRIBE KEYSPACE <keyspace<em>name>;</strong></td>
- <td>Describe the given keyspace configuration and all its table details (name, columns, ...)</td>
- </tr><br>
+ <td>Describe the given keyspace configuration and all its table details (name, columns, ...)</td>
+ </tr>
<tr>
<td nowrap><strong>DESCRIBE TABLE (<keyspace</em>name>).<table<em>name>;</strong></td>
<td>
Describe the given table. If the keyspace is not provided, the current logged in keyspace is used.
If there is no logged in keyspace, the default system keyspace is used.
- If no table is found, an error message is raised
+ If no table is found, an error message is raised.
</td>
- </tr><br>
+ </tr>
<tr>
<td nowrap><strong>DESCRIBE TYPE (<keyspace</em>name>).<type<em>name>;</strong></td>
<td>
Describe the given type(UDT). If the keyspace is not provided, the current logged in keyspace is used.
If there is no logged in keyspace, the default system keyspace is used.
- If no type is found, an error message is raised
+ If no type is found, an error message is raised.
</td>
- </tr><br>
+ </tr>
<tr>
<td nowrap><strong>DESCRIBE FUNCTION (<keyspace</em>name>).<function<em>name>;</strong></td>
- <td>Describe the given user defined function. The keyspace is optional</td>
- </tr><br>
+ <td>Describe the given user defined function. The keyspace is optional.</td>
+ </tr>
<tr>
<td nowrap><strong>DESCRIBE AGGREGATE (<keyspace</em>name>).<aggregate_name>;</strong></td>
- <td>Describe the given user defined aggregate. The keyspace is optional</td>
- </tr><br>
+ <td>Describe the given user defined aggregate. The keyspace is optional.</td>
+ </tr>
</table>
-</center> </p>
+</center></p>
<p>The schema objects (cluster, keyspace, table, type, function and aggregate) are displayed in a tabular format.
There is a drop-down menu on the top left corner to expand objects details. On the top right menu is shown the Icon legend.</p>
-<p><br/>
-<center>
+<p><center>
<img src="../assets/themes/zeppelin/img/docs-img/cassandra-DescribeSchema.png" alt="Describe Schema">
</center></p>
-<hr/>
-
<h2>9. Runtime Parameters</h2>
<p>Sometimes you want to be able to pass runtime query parameters to your statements.
Those parameters are not part of the CQL specs and are specific to the interpreter.
Below is the list of all parameters: </p>
-<p><br/>
-<center><br>
+<p><center>
<table class="table-configuration">
<tr>
<th>Parameter</th>
@@ -421,38 +400,37 @@ Below is the list of all parameters: </p
<tr>
<td nowrap>Consistency Level</td>
<td><strong>@consistency=<em>value</em></strong></td>
- <td>Apply the given consistency level to all queries in the paragraph</td>
+ <td>Apply the given consistency level to all queries in the paragraph.</td>
</tr>
<tr>
<td nowrap>Serial Consistency Level</td>
<td><strong>@serialConsistency=<em>value</em></strong></td>
- <td>Apply the given serial consistency level to all queries in the paragraph</td>
+ <td>Apply the given serial consistency level to all queries in the paragraph.</td>
</tr>
<tr>
<td nowrap>Timestamp</td>
<td><strong>@timestamp=<em>long value</em></strong></td>
<td>
Apply the given timestamp to all queries in the paragraph.
- Please note that timestamp value passed directly in CQL statement will override this value
+ Please note that timestamp value passed directly in CQL statement will override this value.
</td>
</tr>
<tr>
<td nowrap>Retry Policy</td>
<td><strong>@retryPolicy=<em>value</em></strong></td>
- <td>Apply the given retry policy to all queries in the paragraph</td>
+ <td>Apply the given retry policy to all queries in the paragraph.</td>
</tr>
<tr>
<td nowrap>Fetch Size</td>
<td><strong>@fetchSize=<em>integer value</em></strong></td>
- <td>Apply the given fetch size to all queries in the paragraph</td>
+ <td>Apply the given fetch size to all queries in the paragraph.</td>
</tr>
</table>
</center></p>
<p>Some parameters only accept restricted values: </p>
-<p><br/>
-<center><br>
+<p><center>
<table class="table-configuration">
<tr>
<th>Parameter</th>
@@ -460,11 +438,11 @@ Below is the list of all parameters: </p
</tr>
<tr>
<td nowrap>Consistency Level</td>
- <td><strong>ALL, ANY, ONE, TWO, THREE, QUORUM, LOCAL<em>ONE, LOCAL</em>QUORUM, EACH<em>QUORUM</strong></td>
+ <td><strong>ALL, ANY, ONE, TWO, THREE, QUORUM, LOCAL_ONE, LOCAL_QUORUM, EACH_QUORUM</strong></td>
</tr>
<tr>
<td nowrap>Serial Consistency Level</td>
- <td><strong>SERIAL, LOCAL</em>SERIAL</strong></td>
+ <td><strong>SERIAL, LOCAL_SERIAL</strong></td>
</tr>
<tr>
<td nowrap>Timestamp</td>
@@ -472,7 +450,7 @@ Below is the list of all parameters: </p
</tr>
<tr>
<td nowrap>Retry Policy</td>
- <td><strong>DEFAULT, DOWNGRADING<em>CONSISTENCY, FALLTHROUGH, LOGGING</em>DEFAULT, LOGGING<em>DOWNGRADING, LOGGING</em>FALLTHROUGH</strong></td>
+ <td><strong>DEFAULT, DOWNGRADING_CONSISTENCY, FALLTHROUGH, LOGGING_DEFAULT, LOGGING_DOWNGRADING, LOGGING_FALLTHROUGH</strong></td>
</tr>
<tr>
<td nowrap>Fetch Size</td>
@@ -482,7 +460,7 @@ Below is the list of all parameters: </p
</center> </p>
<blockquote>
-<p>Please note that you should <strong>not</strong> add semi-colon ( <strong>;</strong> ) at the end of each parameter statement</p>
+<p>Please note that you should <strong>not</strong> add semi-colon ( <strong>;</strong> ) at the end of each parameter statement.</p>
</blockquote>
<p>Some examples: </p>
@@ -511,15 +489,13 @@ Below is the list of all parameters: </p
<blockquote>
<ol>
-<li><strong>many</strong> query parameters can be set in the same paragraph</li>
-<li>if the <strong>same</strong> query parameter is set many time with different values, the interpreter only take into account the first value</li>
-<li>each query parameter applies to <strong>all CQL statements</strong> in the same paragraph, unless you override the option using plain CQL text (like forcing timestamp with the USING clause)</li>
-<li>the order of each query parameter with regard to CQL statement does not matter</li>
+<li><strong>Many</strong> query parameters can be set in the same paragraph.</li>
+<li>If the <strong>same</strong> query parameter is set many time with different values, the interpreter only take into account the first value.</li>
+<li>Each query parameter applies to <strong>all CQL statements</strong> in the same paragraph, unless you override the option using plain CQL text. ( Like forcing timestamp with the USING clause )</li>
+<li>The order of each query parameter with regard to CQL statement does not matter.</li>
</ol>
</blockquote>
-<hr/>
-
<h2>10. Support for Prepared Statements</h2>
<p>For performance reason, it is better to prepare statements before-hand and reuse them later by providing bound values.
@@ -540,20 +516,17 @@ This interpreter provides 3 commands to
@remove_prepare[statement_name]
</code></pre></div>
-<p><br/></p>
-
<h4>a. @prepare</h4>
-<p><br/>
-You can use the syntax <em>"@prepare[statement</em>name]=SELECT ..."_ to create a prepared statement.
-The <em>statement</em>name_ is <strong>mandatory</strong> because the interpreter prepares the given statement with the Java driver and
-saves the generated prepared statement in an <strong>internal hash map</strong>, using the provided <em>statement</em>name_ as search key.</p>
+<p>You can use the syntax <code>@prepare[statement_name]=SELECT ...</code> to create a prepared statement.
+The <code>statement_name</code> is <strong>mandatory</strong> because the interpreter prepares the given statement with the Java driver and
+saves the generated prepared statement in an <strong>internal hash map</strong>, using the provided <code>statement_name</code> as search key.</p>
<blockquote>
<p>Please note that this internal prepared statement map is shared with <strong>all notebooks</strong> and <strong>all paragraphs</strong> because
-there is only one instance of the interpreter for Cassandra</p>
+there is only one instance of the interpreter for Cassandra.</p>
-<p>If the interpreter encounters <strong>many</strong> @prepare for the <strong>same <em>statement</em>name_ (key)</strong>, only the <strong>first</strong> statement will be taken into account.</p>
+<p>If the interpreter encounters <strong>many</strong> @prepare for the <strong>same statement_name (key)</strong>, only the <strong>first</strong> statement will be taken into account.</p>
</blockquote>
<p>Example: </p>
@@ -561,21 +534,18 @@ there is only one instance of the interp
@prepare[select]=SELECT * FROM spark_demo.artists LIMIT ?
</code></pre></div>
-<p>For the above example, the prepared statement is <em>SELECT * FROM spark</em>demo.albums LIMIT ?<em>.
-_SELECT * FROM spark</em>demo.artists LIMIT ?_ is ignored because an entry already exists in the prepared statements map with the key select. </p>
+<p>For the above example, the prepared statement is <code>SELECT * FROM spark_demo.albums LIMIT ?</code>.
+<code>SELECT * FROM spark_demo.artists LIMIT ?</code> is ignored because an entry already exists in the prepared statements map with the key select. </p>
<p>In the context of <strong>Zeppelin</strong>, a notebook can be scheduled to be executed at regular interval,
-thus it is necessary to <strong>avoid re-preparing many time the same statement (considered an anti-pattern)</strong>.
-<br/>
-<br/></p>
+thus it is necessary to <strong>avoid re-preparing many time the same statement (considered an anti-pattern)</strong>.</p>
<h4>b. @bind</h4>
-<p><br/>
-Once the statement is prepared (possibly in a separated notebook/paragraph). You can bind values to it: </p>
+<p>Once the statement is prepared ( possibly in a separated notebook/paragraph ). You can bind values to it: </p>
<div class="highlight"><pre><code class="text language-text" data-lang="text"> @bind[select_first]=10
</code></pre></div>
-<p>Bound values are not mandatory for the <strong>@bind</strong> statement. However if you provide bound values, they need to comply to some syntax:</p>
+<p>Bound values are not mandatory for the <code>@bind</code> statement. However if you provide bound values, they need to comply to some syntax:</p>
<ul>
<li>String values should be enclosed between simple quotes ( â )</li>
@@ -585,8 +555,8 @@ Once the statement is prepared (possibly
<li>yyyy-MM-dd HH:MM:ss</li>
<li>yyyy-MM-dd HH:MM:ss.SSS</li>
</ol></li>
-<li><strong>null</strong> is parsed as-is</li>
-<li><strong>boolean</strong> (true|false) are parsed as-is</li>
+<li><strong>null</strong> is parsed as-is.</li>
+<li><strong>boolean</strong> (true|false) is parsed as-is.</li>
<li>collection values must follow the <strong><a href="http://docs.datastax.com/en/cql/3.1/cql/cql_using/use_collections_c.html">standard CQL syntax</a></strong>:
<ul>
@@ -594,8 +564,8 @@ Once the statement is prepared (possibly
<li>set: {âset<em>item1â, âset</em>item2â, â¦}</li>
<li>map: {âkey1â: âval1â, âkey2â: âval2â, â¦}</li>
</ul></li>
-<li><strong>tuple</strong> values should be enclosed between parenthesis (see <strong><a href="http://docs.datastax.com/en/cql/3.1/cql/cql_reference/tupleType.html">Tuple CQL syntax</a></strong>): (âtextâ, 123, true)</li>
-<li><strong>udt</strong> values should be enclosed between brackets (see <strong><a href="http://docs.datastax.com/en/cql/3.1/cql/cql_using/cqlUseUDT.html">UDT CQL syntax</a></strong>): {stree<em>name: âBeverly Hillsâ, number: 104, zip</em>code: 90020, state: âCaliforniaâ, â¦}</li>
+<li><strong>tuple</strong> values should be enclosed between parenthesis ( see <strong><a href="http://docs.datastax.com/en/cql/3.1/cql/cql_reference/tupleType.html">Tuple CQL syntax</a></strong> ): (âtextâ, 123, true)</li>
+<li><strong>udt</strong> values should be enclosed between brackets ( see <strong><a href="http://docs.datastax.com/en/cql/3.1/cql/cql_using/cqlUseUDT.html">UDT CQL syntax</a></strong> ): {stree<em>name: âBeverly Hillsâ, number: 104, zip</em>code: 90020, state: âCaliforniaâ, â¦}</li>
</ul>
<blockquote>
@@ -606,17 +576,12 @@ Once the statement is prepared (possibly
<span class="n">APPLY</span> <span class="n">BATCH</span><span class="p">;</span>
</code></pre></div></blockquote>
-<p><br/></p>
-
<h4>c. @remove_prepare</h4>
-<p><br/>
-To avoid for a prepared statement to stay forever in the prepared statement map, you can use the
-<strong>@remove<em>prepare[statement</em>name]</strong> syntax to remove it.
+<p>To avoid for a prepared statement to stay forever in the prepared statement map, you can use the
+<code>@remove_prepare[statement_name]</code> syntax to remove it.
Removing a non-existing prepared statement yields no error.</p>
-<hr/>
-
<h2>11. Using Dynamic Forms</h2>
<p>Instead of hard-coding your CQL queries, it is possible to use the mustache syntax ( <strong>{{ }}</strong> ) to inject simple value or multiple choices forms. </p>
@@ -645,8 +610,6 @@ We could have also use the <strong>{{sty
<p>It is also possible to use dynamic forms for <strong>prepared statements</strong>: </p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">@bind[select]=='{{performer=Sheryl Crow|Doof|Fanfarlo|Los Paranoia}}', '{{style=Rock}}'
</code></pre></div>
-<hr/>
-
<h2>12. Execution parallelism and shared states</h2>
<p>It is possible to execute many paragraphs in parallel. However, at the back-end side, weâre still using synchronous queries.
@@ -658,46 +621,35 @@ Consequently, if you use the <strong>USE
<strong>all current users</strong> of the <strong>Cassandra</strong> interpreter because we only create 1 <code>com.datastax.driver.core.Session</code> object
per instance of <strong>Cassandra</strong> interpreter.</p>
-<p>The same remark does apply to the <strong>prepared statement hash map</strong>, it is shared by <strong>all users</strong> using the same instance of <strong>Cassandra</strong> interpreter.</p>
-
-<p>Until <strong>Zeppelin</strong> offers a real multi-users separation, there is a work-around to segregate user environment and states:
-<em>create different <strong>Cassandra</strong> interpreter instances</em></p>
+<p>The same remark does apply to the <strong>prepared statement hash map</strong>, it is shared by <strong>all users</strong> using the same instance of <strong>Cassandra</strong> interpreter.
+Until <strong>Zeppelin</strong> offers a real multi-users separation, there is a work-around to segregate user environment and states:
+create different <strong>Cassandra</strong> interpreter instances.</p>
-<p>For this, first go to the <strong>Interpreter</strong> menu and click on the <strong>Create</strong> button
-<br/>
-<br/>
+<p>For this, first go to the <strong>Interpreter</strong> menu and click on the <strong>Create</strong> button.
<center>
<img src="../assets/themes/zeppelin/img/docs-img/cassandra-NewInterpreterInstance.png" alt="Create Interpreter">
</center></p>
<p>In the interpreter creation form, put <strong>cass-instance2</strong> as <strong>Name</strong> and select the <strong>cassandra</strong>
-in the interpreter drop-down list<br>
-<br/>
-<br/>
+in the interpreter drop-down list
<center>
<img src="../assets/themes/zeppelin/img/docs-img/cassandra-InterpreterName.png" alt="Interpreter Name">
-</center> </p>
+</center></p>
<p>Click on <strong>Save</strong> to create the new interpreter instance. Now you should be able to see it in the interpreter list.</p>
-<p><br/>
-<br/>
-<center>
+<p><center>
<img src="../assets/themes/zeppelin/img/docs-img/cassandra-NewInterpreterInList.png" alt="Interpreter In List">
-</center> </p>
+</center></p>
<p>Go back to your notebook and click on the <strong>Gear</strong> icon to configure interpreter bindings.
You should be able to see and select the <strong>cass-instance2</strong> interpreter instance in the available
interpreter list instead of the standard <strong>cassandra</strong> instance.</p>
-<p><br/>
-<br/>
-<center>
+<p><center>
<img src="../assets/themes/zeppelin/img/docs-img/cassandra-InterpreterInstanceSelection.png" alt="Interpreter Instance Selection">
</center> </p>
-<hr/>
-
<h2>13. Interpreter Configuration</h2>
<p>To configure the <strong>Cassandra</strong> interpreter, go to the <strong>Interpreter</strong> menu and scroll down to change the parameters.
@@ -753,7 +705,7 @@ to configure the Java driver</p>
<strong>
It is strongly recommended to let the default value
and prefix the table name with the actual keyspace
- in all of your queries
+ in all of your queries.
</strong>
</td>
<td>system</td>
@@ -764,7 +716,7 @@ to configure the Java driver</p>
Load balancing policy. Default = <em>new TokenAwarePolicy(new DCAwareRoundRobinPolicy())</em>
To Specify your own policy, provide the <strong>fully qualify class name (FQCN)</strong> of your policy.
At runtime the interpreter will instantiate the policy using
- <strong>Class.forName(FQCN)</strong>
+ <strong>Class.forName(FQCN).</strong>
</td>
<td>DEFAULT</td>
</tr>
@@ -838,7 +790,7 @@ to configure the Java driver</p>
<td>
Cassandra query default consistency level
<br/>
- Available values: ONE, TWO, THREE, QUORUM, LOCAL<em>ONE, LOCAL</em>QUORUM, EACH<em>QUORUM, ALL
+ Available values: ONE, TWO, THREE, QUORUM, LOCAL_ONE, LOCAL_QUORUM, EACH_QUORUM, ALL
</td>
<td>ONE</td>
</tr>
@@ -852,7 +804,7 @@ to configure the Java driver</p>
<td>
Cassandra query default serial consistency level
<br/>
- Available values: SERIAL, LOCAL</em>SERIAL
+ Available values: SERIAL, LOCAL<em>SERIAL
</td>
<td>SERIAL</td>
</tr>
@@ -863,7 +815,7 @@ to configure the Java driver</p>
Default = new ExponentialReconnectionPolicy(1000, 10 * 60 * 1000)
To Specify your own policy, provide the <strong>fully qualify class name (FQCN)</strong> of your policy.
At runtime the interpreter will instantiate the policy using
- <strong>Class.forName(FQCN)</strong>
+ <strong>Class.forName(FQCN).</strong>
</td>
<td>DEFAULT</td>
</tr>
@@ -874,7 +826,7 @@ to configure the Java driver</p>
Default = DefaultRetryPolicy.INSTANCE
To Specify your own policy, provide the <strong>fully qualify class name (FQCN)</strong> of your policy.
At runtime the interpreter will instantiate the policy using
- <strong>Class.forName(FQCN)</strong>
+ <strong>Class.forName(FQCN).</strong>
</td>
<td>DEFAULT</td>
</tr>
@@ -889,7 +841,7 @@ to configure the Java driver</p>
<td>12000</td>
</tr>
<tr>
- <td>cassandra.socket.tcp.no_delay</td>
+ <td>cassandra.socket.tcp.no</em>delay</td>
<td>Cassandra socket TCP no delay</td>
<td>true</td>
</tr>
@@ -900,18 +852,16 @@ to configure the Java driver</p>
Default = NoSpeculativeExecutionPolicy.INSTANCE
To Specify your own policy, provide the <strong>fully qualify class name (FQCN)</strong> of your policy.
At runtime the interpreter will instantiate the policy using
- <strong>Class.forName(FQCN)</strong>
+ <strong>Class.forName(FQCN).</strong>
</td>
<td>DEFAULT</td>
</tr>
</table></p>
-<hr/>
-
<h2>14. Bugs & Contacts</h2>
<p>If you encounter a bug for this interpreter, please create a <strong><a href="https://issues.apache.org/jira/browse/ZEPPELIN-382?jql=project%20%3D%20ZEPPELIN">JIRA</a></strong> ticket and ping me on Twitter
- at <strong><a href="https://twitter.com/doanduyhai">@doanduyhai</a></strong></p>
+ at <strong><a href="https://twitter.com/doanduyhai">@doanduyhai</a></strong>.</p>
</div>
</div>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/elasticsearch.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/elasticsearch.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/elasticsearch.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/elasticsearch.html Sun Jan 17 16:20:26 2016
@@ -140,9 +140,12 @@
<div class="col-md-12">
<h2>Elasticsearch Interpreter for Apache Zeppelin</h2>
-<h3>1. Configuration</h3>
+<p><a href="https://www.elastic.co/products/elasticsearch">Elasticsearch</a> is a highly scalable open-source full-text search and analytics engine. It allows you to store, search, and analyze big volumes of data quickly and in near real time. It is generally used as the underlying engine/technology that powers applications that have complex search features and requirements.</p>
+
+<p><br /></p>
+
+<h2>1. Configuration</h2>
-<p><br/>
<table class="table-configuration">
<tr>
<th>Property</th>
@@ -162,34 +165,34 @@
<tr>
<td>elasticsearch.port</td>
<td>9300</td>
- <td>Connection port <b>(important: this is not the HTTP port, but the transport port)</b></td>
+ <td>Connection port <b>( Important: this is not the HTTP port, but the transport port )</b></td>
</tr>
<tr>
<td>elasticsearch.result.size</td>
<td>10</td>
<td>The size of the result set of a search query</td>
</tr>
-</table></p>
+</table>
<p><center>
<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-config.png" alt="Interpreter configuration">
</center></p>
<blockquote>
-<p>Note #1: you can add more properties to configure the Elasticsearch client.</p>
+<p><strong>Note #1 :</strong> You can add more properties to configure the Elasticsearch client.</p>
-<p>Note #2: if you use Shield, you can add a property named <code>shield.user</code> with a value containing the name and the password (format: <code>username:password</code>). For more details about Shield configuration, consult the <a href="https://www.elastic.co/guide/en/shield/current/_using_elasticsearch_java_clients_with_shield.html">Shield reference guide</a>. Do not forget, to copy the shield client jar in the interpreter directory (<code>ZEPPELIN_HOME/interpreters/elasticsearch</code>).</p>
+<p><strong>Note #2 :</strong> If you use Shield, you can add a property named <code>shield.user</code> with a value containing the name and the password ( format: <code>username:password</code> ). For more details about Shield configuration, consult the <a href="https://www.elastic.co/guide/en/shield/current/_using_elasticsearch_java_clients_with_shield.html">Shield reference guide</a>. Do not forget, to copy the shield client jar in the interpreter directory (<code>ZEPPELIN_HOME/interpreters/elasticsearch</code>).</p>
</blockquote>
-<hr/>
+<p><br /></p>
-<h3>2. Enabling the Elasticsearch Interpreter</h3>
+<h2>2. Enabling the Elasticsearch Interpreter</h2>
<p>In a notebook, to enable the <strong>Elasticsearch</strong> interpreter, click the <strong>Gear</strong> icon and select <strong>Elasticsearch</strong>.</p>
-<hr/>
+<p><br /></p>
-<h3>3. Using the Elasticsearch Interpreter</h3>
+<h2>3. Using the Elasticsearch Interpreter</h2>
<p>In a paragraph, use <code>%elasticsearch</code> to select the Elasticsearch interpreter and then input all commands. To get the list of available commands, use <code>help</code>.</p>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="p">|</span> %elasticsearch
@@ -209,14 +212,14 @@ Commands:
. same comments as <span class="k">for </span>the search
- get /index/type/id
- delete /index/type/id
- - index /ndex/type/id <json-formatted document>
+ - index /index/type/id <json-formatted document>
. the id can be omitted, elasticsearch will generate one
</code></pre></div>
<blockquote>
-<p>Tip: use (CTRL + .) for completion</p>
+<p><strong>Tip :</strong> Use ( Ctrl + . ) for autocompletion.</p>
</blockquote>
-<h4>get</h4>
+<h3>Get</h3>
<p>With the <code>get</code> command, you can find a document by id. The result is a JSON document.</p>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="p">|</span> %elasticsearch
@@ -225,7 +228,7 @@ Commands:
<p>Example:
<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-get.png" alt="Elasticsearch - Get"></p>
-<h4>search</h4>
+<h3>Search</h3>
<p>With the <code>search</code> command, you can send a search query to Elasticsearch. There are two formats of query:</p>
@@ -235,7 +238,7 @@ Commands:
<ul>
<li>See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html">Elasticsearch search API reference document</a> for more details about the content of the search queries.</li>
</ul></li>
-<li>You can also provide the content of a <code>query_string</code>
+<li>You can also provide the content of a <code>query_string</code>.
<ul>
<li>This is a shortcut to a query like that: <code>{ "query": { "query_string": { "query": "__HERE YOUR QUERY__", "analyze_wildcard": true } } }</code> </li>
@@ -250,15 +253,28 @@ Commands:
<span class="p">|</span> size 50
<span class="p">|</span> search /index1,index2,.../type1,type2,... <JSON document containing the query or query_string elements>
</code></pre></div>
+<blockquote>
+<p>A search query can also contain <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html">aggregations</a>. If there is at least one aggregation, the result of the first aggregation is shown, otherwise, you get the search hits.</p>
+</blockquote>
+
<p>Examples:</p>
<ul>
<li><p>With a JSON query:</p>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="p">|</span> %elasticsearch
-<span class="p">|</span> search / <span class="o">{</span> <span class="s2">"query"</span>: <span class="o">{</span> <span class="s2">"match_all"</span>: <span class="o">{}</span> <span class="o">}</span> <span class="o">}</span>
+<span class="p">|</span> search / <span class="o">{</span> <span class="s2">"query"</span>: <span class="o">{</span> <span class="s2">"match_all"</span>: <span class="o">{</span> <span class="o">}</span> <span class="o">}</span> <span class="o">}</span>
<span class="p">|</span>
<span class="p">|</span> %elasticsearch
<span class="p">|</span> search /logs <span class="o">{</span> <span class="s2">"query"</span>: <span class="o">{</span> <span class="s2">"query_string"</span>: <span class="o">{</span> <span class="s2">"query"</span>: <span class="s2">"request.method:GET AND status:200"</span> <span class="o">}</span> <span class="o">}</span> <span class="o">}</span>
+<span class="p">|</span>
+<span class="p">|</span> %elasticsearch
+<span class="p">|</span> search /logs <span class="o">{</span> <span class="s2">"aggs"</span>: <span class="o">{</span>
+<span class="p">|</span> <span class="s2">"content_length_stats"</span>: <span class="o">{</span>
+<span class="p">|</span> <span class="s2">"extended_stats"</span>: <span class="o">{</span>
+<span class="p">|</span> <span class="s2">"field"</span>: <span class="s2">"content_length"</span>
+<span class="p">|</span> <span class="o">}</span>
+<span class="p">|</span> <span class="o">}</span>
+<span class="p">|</span> <span class="o">}</span> <span class="o">}</span>
</code></pre></div></li>
<li><p>With query_string elements:</p>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="p">|</span> %elasticsearch
@@ -270,7 +286,7 @@ Commands:
</ul>
<blockquote>
-<p><strong>Important</strong>: a document in Elasticsearch is a JSON document, so it is hierarchical, not flat as a row in a SQL table.
+<p><strong>Important</strong> : a document in Elasticsearch is a JSON document, so it is hierarchical, not flat as a row in a SQL table.
For the Elastic interpreter, the result of a search query is flattened.</p>
</blockquote>
@@ -282,13 +298,15 @@ For the Elastic interpreter, the result
"url": "/zeppelin/4cd001cd-c517-4fa9-b8e5-a06b8f4056c4",
"headers": [ "Accept: *.*", "Host: apache.org"]
},
- "status": "403"
+ "status": "403",
+ "content_length": 1234
}
</code></pre></div>
<p>The data will be flattened like this:</p>
<table><thead>
<tr>
+<th>content_length</th>
<th>date</th>
<th>request.headers[0]</th>
<th>request.headers[1]</th>
@@ -298,6 +316,7 @@ For the Elastic interpreter, the result
</tr>
</thead><tbody>
<tr>
+<td>1234</td>
<td>2015-12-08T21:03:13.588Z</td>
<td>Accept: *.*</td>
<td>Host: apache.org</td>
@@ -318,9 +337,13 @@ For the Elastic interpreter, the result
<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-search-json-query-table.png" alt="Elasticsearch - Search with query"></p></li>
<li><p>With a query string:
<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-query-string.png" alt="Elasticsearch - Search with query string"></p></li>
+<li><p>With a query containing a multi-value metric aggregation:
+<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-value-metric.png" alt="Elasticsearch - Search with aggregation (multi-value metric)"></p></li>
+<li><p>With a query containing a multi-bucket aggregation:
+<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-bucket-pie.png" alt="Elasticsearch - Search with aggregation (multi-bucket)"></p></li>
</ul>
-<h4>count</h4>
+<h3>Count</h3>
<p>With the <code>count</code> command, you can count documents available in some indices and types. You can also provide a query.</p>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="p">|</span> %elasticsearch
@@ -335,7 +358,7 @@ For the Elastic interpreter, the result
<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-count-with-query.png" alt="Elasticsearch - Count with query"></p></li>
</ul>
-<h4>index</h4>
+<h3>Index</h3>
<p>With the <code>index</code> command, you can insert/update a document in Elasticsearch.</p>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="p">|</span> %elasticsearch
@@ -344,18 +367,18 @@ For the Elastic interpreter, the result
<span class="p">|</span> %elasticsearch
<span class="p">|</span> index /index/type <JSON document>
</code></pre></div>
-<h4>delete</h4>
+<h3>Delete</h3>
<p>With the <code>delete</code> command, you can delete a document.</p>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="p">|</span> %elasticsearch
<span class="p">|</span> delete /index/type/id
</code></pre></div>
-<h4>Apply Zeppelin Dynamic Forms</h4>
+<h3>Apply Zeppelin Dynamic Forms</h3>
-<p>You can leverage <a href="/docs/0.6.0-incubating-SNAPSHOT/manual/dynamicform.html">Zeppelin Dynamic Form</a> inside your queries. You can use both the <code>text input</code> and <code>select form</code> parameterization features</p>
+<p>You can leverage <a href="/docs/0.6.0-incubating-SNAPSHOT/manual/dynamicform.html">Zeppelin Dynamic Form</a> inside your queries. You can use both the <code>text input</code> and <code>select form</code> parameterization features.</p>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="p">|</span> %elasticsearch
<span class="p">|</span> size <span class="k">${</span><span class="nv">limit</span><span class="p">=10</span><span class="k">}</span>
-<span class="p">|</span> search /index/type <span class="o">{</span> <span class="s2">"query"</span>: <span class="o">{</span> <span class="s2">"match_all"</span>: <span class="o">{}</span> <span class="o">}</span> <span class="o">}</span>
+<span class="p">|</span> search /index/type <span class="o">{</span> <span class="s2">"query"</span>: <span class="o">{</span> <span class="s2">"match_all"</span>: <span class="o">{</span> <span class="o">}</span> <span class="o">}</span> <span class="o">}</span>
</code></pre></div>
</div>
</div>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/flink.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/flink.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/flink.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/flink.html Sun Jan 17 16:20:26 2016
@@ -140,13 +140,15 @@
<div class="col-md-12">
<h2>Flink interpreter for Apache Zeppelin</h2>
-<p><a href="https://flink.apache.org">Apache Flink</a> is an open source platform for distributed stream and batch data processing.</p>
+<p><a href="https://flink.apache.org">Apache Flink</a> is an open source platform for distributed stream and batch data processing. Flinkâs core is a streaming dataflow engine that provides data distribution, communication, and fault tolerance for distributed computations over data streams. Flink also builds batch processing on top of the streaming engine, overlaying native iteration support, managed memory, and program optimization.</p>
-<h3>How to start local Flink cluster, to test the interpreter</h3>
+<p><br></p>
+
+<h2>How to start local Flink cluster, to test the interpreter</h2>
<p>Zeppelin comes with pre-configured flink-local interpreter, which starts Flink in a local mode on your machine, so you do not need to install anything.</p>
-<h3>How to configure interpreter to point to Flink cluster</h3>
+<h2>How to configure interpreter to point to Flink cluster</h2>
<p>At the "Interpreters" menu, you have to create a new Flink interpreter and provide next properties:</p>
@@ -166,34 +168,31 @@
<td>6123</td>
<td>port of running JobManager</td>
</tr>
- <tr>
- <td>xxx</td>
- <td>yyy</td>
- <td>anything else from [Flink Configuration](https://ci.apache.org/projects/flink/flink-docs-release-0.9/setup/config.html)</td>
- </tr>
</table>
-<p><br /></p>
+<p>For more information about Flink configuration, you can find it <a href="https://ci.apache.org/projects/flink/flink-docs-release-0.10/setup/config.html">here</a>.</p>
-<h3>How to test it's working</h3>
+<h2>How to test it's working</h2>
-<p>In example, by using the <a href="https://www.zeppelinhub.com/viewer/notebooks/aHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL05GTGFicy96ZXBwZWxpbi1ub3RlYm9va3MvbWFzdGVyL25vdGVib29rcy8yQVFFREs1UEMvbm90ZS5qc29u">Zeppelin notebook</a> is from <a href="http://www.slideshare.net/tillrohrmann/data-analysis-49806564">Till Rohrmann's presentation</a> "Interactive data analysis with Apache Flink" for Apache Flink Meetup.</p>
+<p>In example, by using the <a href="https://www.zeppelinhub.com/viewer/notebooks/aHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL05GTGFicy96ZXBwZWxpbi1ub3RlYm9va3MvbWFzdGVyL25vdGVib29rcy8yQVFFREs1UEMvbm90ZS5qc29u">Zeppelin notebook</a> is from Till Rohrmann's presentation <a href="http://www.slideshare.net/tillrohrmann/data-analysis-49806564">Interactive data analysis with Apache Flink</a> for Apache Flink Meetup.</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">%sh
rm 10.txt.utf-8
wget http://www.gutenberg.org/ebooks/10.txt.utf-8
-</code></pre></div><div class="highlight"><pre><code class="text language-text" data-lang="text">%flink
-case class WordCount(word: String, frequency: Int)
-val bible:DataSet[String] = env.readTextFile("10.txt.utf-8")
-val partialCounts: DataSet[WordCount] = bible.flatMap{
- line =>
- """\b\w+\b""".r.findAllIn(line).map(word => WordCount(word, 1))
-// line.split(" ").map(word => WordCount(word, 1))
-}
-val wordCounts = partialCounts.groupBy("word").reduce{
- (left, right) => WordCount(left.word, left.frequency + right.frequency)
-}
-val result10 = wordCounts.first(10).collect()
</code></pre></div>
+<div class="highlight"><pre><code class="scala"><span class="o">%</span><span class="n">flink</span>
+<span class="k">case</span> <span class="k">class</span> <span class="nc">WordCount</span><span class="o">(</span><span class="n">word</span><span class="k">:</span> <span class="kt">String</span><span class="o">,</span> <span class="n">frequency</span><span class="k">:</span> <span class="kt">Int</span><span class="o">)</span>
+<span class="k">val</span> <span class="n">bible</span><span class="k">:</span><span class="kt">DataSet</span><span class="o">[</span><span class="kt">String</span><span class="o">]</span> <span class="k">=</span> <span class="n">env</span><span class="o">.</span><span class="n">readTextFile</span><span class="o">(</span><span class="s">"10.txt.utf-8"</span><span class="o">)</span>
+<span class="k">val</span> <span class="n">partialCounts</span><span class="k">:</span> <span class="kt">DataSet</span><span class="o">[</span><span class="kt">WordCount</span><span class="o">]</span> <span class="k">=</span> <span class="n">bible</span><span class="o">.</span><span class="n">flatMap</span><span class="o">{</span>
+ <span class="n">line</span> <span class="k">=></span>
+ <span class="s">"""\b\w+\b"""</span><span class="o">.</span><span class="n">r</span><span class="o">.</span><span class="n">findAllIn</span><span class="o">(</span><span class="n">line</span><span class="o">).</span><span class="n">map</span><span class="o">(</span><span class="n">word</span> <span class="k">=></span> <span class="nc">WordCount</span><span class="o">(</span><span class="n">word</span><span class="o">,</span> <span class="mi">1</span><span class="o">))</span>
+<span class="c1">// line.split(" ").map(word => WordCount(word, 1))</span>
+<span class="o">}</span>
+<span class="k">val</span> <span class="n">wordCounts</span> <span class="k">=</span> <span class="n">partialCounts</span><span class="o">.</span><span class="n">groupBy</span><span class="o">(</span><span class="s">"word"</span><span class="o">).</span><span class="n">reduce</span><span class="o">{</span>
+ <span class="o">(</span><span class="n">left</span><span class="o">,</span> <span class="n">right</span><span class="o">)</span> <span class="k">=></span> <span class="nc">WordCount</span><span class="o">(</span><span class="n">left</span><span class="o">.</span><span class="n">word</span><span class="o">,</span> <span class="n">left</span><span class="o">.</span><span class="n">frequency</span> <span class="o">+</span> <span class="n">right</span><span class="o">.</span><span class="n">frequency</span><span class="o">)</span>
+<span class="o">}</span>
+<span class="k">val</span> <span class="n">result10</span> <span class="k">=</span> <span class="n">wordCounts</span><span class="o">.</span><span class="n">first</span><span class="o">(</span><span class="mi">10</span><span class="o">).</span><span class="n">collect</span><span class="o">()</span>
+</code></pre></div>
+
</div>
</div>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/hive.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/hive.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/hive.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/hive.html Sun Jan 17 16:20:26 2016
@@ -140,9 +140,10 @@
<div class="col-md-12">
<h2>Hive Interpreter for Apache Zeppelin</h2>
-<h3>Configuration</h3>
+<p>The <a href="https://hive.apache.org/">Apache Hive</a> ⢠data warehouse software facilitates querying and managing large datasets residing in distributed storage. Hive provides a mechanism to project structure onto this data and query the data using a SQL-like language called HiveQL. At the same time this language also allows traditional map/reduce programmers to plug in their custom mappers and reducers when it is inconvenient or inefficient to express this logic in HiveQL.</p>
+
+<h2>1. Configuration</h2>
-<p><br/>
<table class="table-configuration">
<tr>
<th>Property</th>
@@ -162,48 +163,48 @@
<tr>
<td>default.user</td>
<td></td>
- <td><b>(Optional)</b>Username of the connection</td>
+ <td><b>( Optional ) </b>Username of the connection</td>
</tr>
<tr>
<td>default.password</td>
<td></td>
- <td><b>(Optional)</b>Password of the connection</td>
+ <td><b>( Optional ) </b>Password of the connection</td>
</tr>
<tr>
<td>default.xxx</td>
<td></td>
- <td><b>(Optional)</b>Other properties used by the driver</td>
+ <td><b>( Optional ) </b>Other properties used by the driver</td>
</tr>
<tr>
<td>${prefix}.driver</td>
<td></td>
- <td>Driver class path of <code>%hive(${prefix})</code></td>
+ <td>Driver class path of <code>%hive(${prefix})</code> </td>
</tr>
<tr>
<td>${prefix}.url</td>
<td></td>
- <td>Url of <code>%hive(${prefix})</code></td>
+ <td>Url of <code>%hive(${prefix})</code> </td>
</tr>
<tr>
<td>${prefix}.user</td>
<td></td>
- <td><b>(Optional)</b>Username of the connection of <code>%hive(${prefix})</code></td>
+ <td><b>( Optional ) </b>Username of the connection of <code>%hive(${prefix})</code> </td>
</tr>
<tr>
<td>${prefix}.password</td>
<td></td>
- <td><b>(Optional)</b>Password of the connection of <code>%hive(${prefix})</code></td>
+ <td><b>( Optional ) </b>Password of the connection of <code>%hive(${prefix})</code> </td>
</tr>
<tr>
<td>${prefix}.xxx</td>
<td></td>
- <td><b>(Optional)</b>Other properties used by the driver of <code>%hive(${prefix})</code></td>
+ <td><b>( Optional ) </b>Other properties used by the driver of <code>%hive(${prefix})</code> </td>
</tr>
-</table></p>
+</table>
-<p>This interpreter provides multiple configuration with ${prefix}. User can set a multiple connection properties by this prefix. It can be used like <code>%hive(${prefix})</code>.</p>
+<p>This interpreter provides multiple configuration with <code>${prefix}</code>. User can set a multiple connection properties by this prefix. It can be used like <code>%hive(${prefix})</code>.</p>
-<h3>How to use</h3>
+<h2>2. How to use</h2>
<p>Basically, you can use</p>
<div class="highlight"><pre><code class="sql language-sql" data-lang="sql"><span class="o">%</span><span class="n">hive</span>
@@ -216,9 +217,9 @@
</code></pre></div>
<p>You can also run multiple queries up to 10 by default. Changing these settings is not implemented yet.</p>
-<h4>Apply Zeppelin Dynamic Forms</h4>
+<h3>Apply Zeppelin Dynamic Forms</h3>
-<p>You can leverage <a href="/docs/0.6.0-incubating-SNAPSHOT/manual/dynamicform.html">Zeppelin Dynamic Form</a> inside your queries. You can use both the <code>text input</code> and <code>select form</code> parameterization features</p>
+<p>You can leverage <a href="/docs/0.6.0-incubating-SNAPSHOT/manual/dynamicform.html">Zeppelin Dynamic Form</a> inside your queries. You can use both the <code>text input</code> and <code>select form</code> parameterization features.</p>
<div class="highlight"><pre><code class="sql language-sql" data-lang="sql"><span class="o">%</span><span class="n">hive</span>
<span class="k">SELECT</span> <span class="err">${</span><span class="n">group_by</span><span class="err">}</span><span class="p">,</span> <span class="k">count</span><span class="p">(</span><span class="o">*</span><span class="p">)</span> <span class="k">as</span> <span class="k">count</span>
<span class="k">FROM</span> <span class="n">retail_demo</span><span class="p">.</span><span class="n">order_lineitems_pxf</span>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/lens.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/lens.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/lens.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/lens.html Sun Jan 17 16:20:26 2016
@@ -160,7 +160,7 @@
<h3>Configuring Lens Interpreter</h3>
-<p>At the "Interpreters" menu, you can to edit Lens interpreter or create new one. Zeppelin provides these properties for Lens.</p>
+<p>At the "Interpreters" menu, you can edit Lens interpreter or create new one. Zeppelin provides these properties for Lens.</p>
<p><table class="table-configuration">
<tr>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/markdown.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/markdown.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/markdown.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/markdown.html Sun Jan 17 16:20:26 2016
@@ -143,17 +143,18 @@
<h3>Overview</h3>
<p><a href="http://daringfireball.net/projects/markdown/">Markdown</a> is a plain text formatting syntax designed so that it can be converted to HTML.
-Zeppelin uses markdown4j, for more examples and extension support checkout <a href="https://code.google.com/p/markdown4j/">markdown4j</a><br>
-In Zeppelin notebook you can use <code>%md</code> in the beginning of a paragraph to invoke the Markdown interpreter to generate static html from Markdown plain text.</p>
+Zeppelin uses markdown4j. For more examples and extension support, please checkout <a href="https://code.google.com/p/markdown4j/">here</a>.<br>
+In Zeppelin notebook, you can use <code>%md</code> in the beginning of a paragraph to invoke the Markdown interpreter and generate static html from Markdown plain text.</p>
-<p>In Zeppelin, Markdown interpreter is enabled by default.
-<img src="/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/markdown-interpreter-setting.png" width="600px" /></p>
+<p>In Zeppelin, Markdown interpreter is enabled by default.</p>
+
+<p><img src="/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/markdown-interpreter-setting.png" width="60%" /></p>
<h3>Example</h3>
<p>The following example demonstrates the basic usage of Markdown in a Zeppelin notebook.</p>
-<p><img src="/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/markdown-example.png" width="800px" /></p>
+<p><img src="/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/img/docs-img/markdown-example.png" width="70%" /></p>
</div>
</div>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html Sun Jan 17 16:20:26 2016
@@ -138,7 +138,7 @@
<div class="row">
<div class="col-md-12">
- <h2>Spark Interpreter</h2>
+ <h2>Spark Interpreter for Apache Zeppelin</h2>
<p><a href="http://spark.apache.org">Apache Spark</a> is supported in Zeppelin with
Spark Interpreter group, which consisted of 4 interpreters.</p>
@@ -171,17 +171,15 @@ Spark Interpreter group, which consisted
</tr>
</table>
-<p><br /><br /></p>
-
-<h3>Configuration</h3>
+<p><br /></p>
-<hr />
+<h2>Configuration</h2>
-<p>Without any configuration, Spark interpreter works out of box in local mode. But if you want to connect to your Spark cluster, you'll need following two simple steps.</p>
+<p>Without any configuration, Spark interpreter works out of box in local mode. But if you want to connect to your Spark cluster, you'll need to follow below two simple steps.</p>
-<h4>1. export SPARK_HOME</h4>
+<h3>1. Export SPARK_HOME</h3>
-<p>In <strong>conf/zeppelin-env.sh</strong>, export SPARK_HOME environment variable with your Spark installation path.</p>
+<p>In <strong>conf/zeppelin-env.sh</strong>, export <code>SPARK_HOME</code> environment variable with your Spark installation path.</p>
<p>for example</p>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="nb">export </span><span class="nv">SPARK_HOME</span><span class="o">=</span>/usr/lib/spark
@@ -190,9 +188,7 @@ Spark Interpreter group, which consisted
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="nb">export </span><span class="nv">HADOOP_CONF_DIR</span><span class="o">=</span>/usr/lib/hadoop
<span class="nb">export </span><span class="nv">SPARK_SUBMIT_OPTIONS</span><span class="o">=</span><span class="s2">"--packages com.databricks:spark-csv_2.10:1.2.0"</span>
</code></pre></div>
-<p><br /></p>
-
-<h4>2. set master in Interpreter menu.</h4>
+<h3>2. Set master in Interpreter menu</h3>
<p>After start Zeppelin, go to <strong>Interpreter</strong> menu and edit <strong>master</strong> property in your Spark interpreter setting. The value may vary depending on your Spark cluster deployment type.</p>
@@ -205,34 +201,32 @@ Spark Interpreter group, which consisted
<li><strong>mesos://host:5050</strong> in Mesos cluster</li>
</ul>
-<p><br />
-That's it. Zeppelin will work with any version of Spark and any deployment type without rebuild Zeppelin in this way. (Zeppelin 0.5.5-incubating release works up to Spark 1.5.1)</p>
+<p>That's it. Zeppelin will work with any version of Spark and any deployment type without rebuilding Zeppelin in this way. ( Zeppelin 0.5.5-incubating release works up to Spark 1.5.2 )</p>
-<p>Note that without exporting SPARK_HOME, it's running in local mode with included version of Spark. The included version may vary depending on the build profile.</p>
+<blockquote>
+<p>Note that without exporting <code>SPARK_HOME</code>, it's running in local mode with included version of Spark. The included version may vary depending on the build profile.</p>
+</blockquote>
-<p><br /> <br /></p>
-
-<h3>SparkContext, SQLContext, ZeppelinContext</h3>
+<p><br /></p>
-<hr />
+<h2>SparkContext, SQLContext, ZeppelinContext</h2>
<p>SparkContext, SQLContext, ZeppelinContext are automatically created and exposed as variable names 'sc', 'sqlContext' and 'z', respectively, both in scala and python environments.</p>
+<blockquote>
<p>Note that scala / python environment shares the same SparkContext, SQLContext, ZeppelinContext instance.</p>
+</blockquote>
-<p><a name="dependencyloading"> </a>
-<br />
-<br /></p>
-
-<h3>Dependency Management</h3>
+<p><br />
+<a name="dependencyloading"> </a></p>
-<hr />
+<h2>Dependency Management</h2>
-<p>There are two ways to load external library in spark interpreter. First is using Zeppelin's %dep interpreter and second is loading Spark properties.</p>
+<p>There are two ways to load external library in spark interpreter. First is using Zeppelin's <code>%dep</code> interpreter and second is loading Spark properties.</p>
-<h4>1. Dynamic Dependency Loading via %dep interpreter</h4>
+<h3>1. Dynamic Dependency Loading via %dep interpreter</h3>
-<p>When your code requires external library, instead of doing download/copy/restart Zeppelin, you can easily do following jobs using %dep interpreter.</p>
+<p>When your code requires external library, instead of doing download/copy/restart Zeppelin, you can easily do following jobs using <code>%dep</code> interpreter.</p>
<ul>
<li>Load libraries recursively from Maven repository</li>
@@ -242,7 +236,7 @@ That's it. Zeppelin will work with a
</ul>
<p>Dep interpreter leverages scala environment. So you can write any Scala code here.
-Note that %dep interpreter should be used before %spark, %pyspark, %sql.</p>
+Note that <code>%dep</code> interpreter should be used before <code>%spark</code>, <code>%pyspark</code>, <code>%sql</code>.</p>
<p>Here's usages.</p>
<div class="highlight"><pre><code class="scala language-scala" data-lang="scala"><span class="o">%</span><span class="n">dep</span>
@@ -277,9 +271,7 @@ Note that %dep interpreter should be use
<span class="c1">// local() skips adding artifact to spark clusters (skipping sc.addJar())</span>
<span class="n">z</span><span class="o">.</span><span class="n">load</span><span class="o">(</span><span class="s">"groupId:artifactId:version"</span><span class="o">).</span><span class="n">local</span><span class="o">()</span>
</code></pre></div>
-<p><br /></p>
-
-<h4>2. Loading Spark Properties</h4>
+<h3>2. Loading Spark Properties</h3>
<p>Once <code>SPARK_HOME</code> is set in <code>conf/zeppelin-env.sh</code>, Zeppelin uses <code>spark-submit</code> as spark interpreter runner. <code>spark-submit</code> supports two ways to load configurations. The first is command line options such as --master and Zeppelin can pass these options to <code>spark-submit</code> by exporting <code>SPARK_SUBMIT_OPTIONS</code> in conf/zeppelin-env.sh. Second is reading configuration options from <code>SPARK_HOME/conf/spark-defaults.conf</code>. Spark properites that user can set to distribute libraries are:</p>
@@ -310,10 +302,11 @@ Note that %dep interpreter should be use
</tr>
</table>
-<p>Note that adding jar to pyspark is only availabe via %dep interpreter at the moment</p>
+<blockquote>
+<p>Note that adding jar to pyspark is only availabe via <code>%dep</code> interpreter at the moment.</p>
+</blockquote>
-<p><br/>
-Here are few examples:</p>
+<p>Here are few examples:</p>
<ul>
<li><p>SPARK_SUBMIT_OPTIONS in conf/zeppelin-env.sh</p>
@@ -326,38 +319,47 @@ spark.files /path/mylib1.py,
</code></pre></div></li>
</ul>
-<p><br />
-<br /></p>
-
-<h3>ZeppelinContext</h3>
+<p><br /></p>
-<hr />
+<h2>ZeppelinContext</h2>
<p>Zeppelin automatically injects ZeppelinContext as variable 'z' in your scala/python environment. ZeppelinContext provides some additional functions and utility.</p>
-<p><br /></p>
-
-<h4>Object exchange</h4>
+<h3>Object Exchange</h3>
<p>ZeppelinContext extends map and it's shared between scala, python environment.
-So you can put some object from scala and read it from python, vise versa.</p>
+So you can put some object from scala and read it from python, vise versa.
+<div class="codetabs">
+ <div data-lang="scala" markdown="1"></p>
-<p>Put object from scala</p>
-<div class="highlight"><pre><code class="scala language-scala" data-lang="scala"><span class="o">%</span><span class="n">spark</span>
+<div class="highlight"><pre><code class="scala"><span class="c1">// Put object from scala</span>
+<span class="o">%</span><span class="n">spark</span>
<span class="k">val</span> <span class="n">myObject</span> <span class="k">=</span> <span class="o">...</span>
<span class="n">z</span><span class="o">.</span><span class="n">put</span><span class="o">(</span><span class="s">"objName"</span><span class="o">,</span> <span class="n">myObject</span><span class="o">)</span>
</code></pre></div>
-<p>Get object from python</p>
-<div class="highlight"><pre><code class="python language-python" data-lang="python"><span class="o">%</span><span class="n">python</span>
+
+
+ </div>
+ <div data-lang="python" markdown="1">
+
+
+<div class="highlight"><pre><code class="python"><span class="c"># Get object from python</span>
+<span class="o">%</span><span class="n">pyspark</span>
<span class="n">myObject</span> <span class="o">=</span> <span class="n">z</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"objName"</span><span class="p">)</span>
</code></pre></div>
-<p><br /></p>
-<h4>Form creation</h4>
+
+ </div>
+</div>
+
+<h3>Form Creation</h3>
<p>ZeppelinContext provides functions for creating forms.
-In scala and python environments, you can create forms programmatically.</p>
-<div class="highlight"><pre><code class="scala language-scala" data-lang="scala"><span class="o">%</span><span class="n">spark</span>
+In scala and python environments, you can create forms programmatically.
+<div class="codetabs">
+ <div data-lang="scala" markdown="1"></p>
+
+<div class="highlight"><pre><code class="scala"><span class="o">%</span><span class="n">spark</span>
<span class="cm">/* Create text input form */</span>
<span class="n">z</span><span class="o">.</span><span class="n">input</span><span class="o">(</span><span class="s">"formName"</span><span class="o">)</span>
@@ -372,6 +374,32 @@ In scala and python environments, you ca
<span class="n">z</span><span class="o">.</span><span class="n">select</span><span class="o">(</span><span class="s">"formName"</span><span class="o">,</span> <span class="s">"option1"</span><span class="o">,</span> <span class="nc">Seq</span><span class="o">((</span><span class="s">"option1"</span><span class="o">,</span> <span class="s">"option1DisplayName"</span><span class="o">),</span>
<span class="o">(</span><span class="s">"option2"</span><span class="o">,</span> <span class="s">"option2DisplayName"</span><span class="o">)))</span>
</code></pre></div>
+
+
+ </div>
+ <div data-lang="python" markdown="1">
+
+
+<div class="highlight"><pre><code class="python"><span class="o">%</span><span class="n">pyspark</span>
+<span class="c"># Create text input form </span>
+<span class="n">z</span><span class="o">.</span><span class="n">input</span><span class="p">(</span><span class="s">"formName"</span><span class="p">)</span>
+
+<span class="c"># Create text input form with default value </span>
+<span class="n">z</span><span class="o">.</span><span class="n">input</span><span class="p">(</span><span class="s">"formName"</span><span class="p">,</span> <span class="s">"defaultValue"</span><span class="p">)</span>
+
+<span class="c"># Create select form </span>
+<span class="n">z</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="s">"formName"</span><span class="p">,</span> <span class="p">[(</span><span class="s">"option1"</span><span class="p">,</span> <span class="s">"option1DisplayName"</span><span class="p">),</span>
+ <span class="p">(</span><span class="s">"option2"</span><span class="p">,</span> <span class="s">"option2DisplayName"</span><span class="p">)])</span>
+
+<span class="c"># Create select form with default value</span>
+<span class="n">z</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="s">"formName"</span><span class="p">,</span> <span class="p">[(</span><span class="s">"option1"</span><span class="p">,</span> <span class="s">"option1DisplayName"</span><span class="p">),</span>
+ <span class="p">(</span><span class="s">"option2"</span><span class="p">,</span> <span class="s">"option2DisplayName"</span><span class="p">)],</span> <span class="s">"option1"</span><span class="p">)</span>
+</code></pre></div>
+
+
+ </div>
+</div>
+
<p>In sql environment, you can create form in simple template.</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">%sql
select * from ${table=defaultTableName} where text like '%${search}%'
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/manual/interpreters.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/manual/interpreters.html?rev=1725100&r1=1725099&r2=1725100&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/manual/interpreters.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/manual/interpreters.html Sun Jan 17 16:20:26 2016
@@ -152,47 +152,58 @@ See the License for the specific languag
limitations under the License.
-->
-<h2>Interpreters in zeppelin</h2>
+<h2>Interpreters in Zeppelin</h2>
-<p>This section explain the role of Interpreters, interpreters group and interpreters settings in Zeppelin.
-Zeppelin interpreter concept allows any language/data-processing-backend to be plugged into Zeppelin.
-Currently Zeppelin supports many interpreters such as Scala(with Apache Spark), Python(with Apache Spark), SparkSQL, Hive, Markdown and Shell.</p>
+<p>In this section, we will explain about the role of interpreters, interpreters group and interpreter settings in Zeppelin.
+The concept of Zeppelin interpreter allows any language/data-processing-backend to be plugged into Zeppelin.
+Currently, Zeppelin supports many interpreters such as Scala ( with Apache Spark ), Python ( with Apache Spark ), SparkSQL, Hive, Markdown, Shell and so on.</p>
-<h3>What is zeppelin interpreter?</h3>
+<p><br/></p>
-<p>Zeppelin Interpreter is the plug-in which enable zeppelin user to use a specific language/data-processing-backend. For example to use scala code in Zeppelin, you need <code>spark</code> interpreter.</p>
+<h2>What is Zeppelin interpreter?</h2>
-<p>When you click on the <code>+Create</code> button in the interpreter page the interpreter drop-down list box will present all the available interpreters on your server.</p>
+<p>Zeppelin Interpreter is a plug-in which enables Zeppelin users to use a specific language/data-processing-backend. For example, to use scala code in Zeppelin, you need <code>%spark</code> interpreter.</p>
+
+<p>When you click the <code>+Create</code> button in the interpreter page, the interpreter drop-down list box will show all the available interpreters on your server.</p>
<p><img src="/assets/themes/zeppelin/img/screenshots/interpreter_create.png"></p>
-<h3>What is zeppelin interpreter setting?</h3>
+<p><br/></p>
+
+<h2>What is Zeppelin Interpreter Setting?</h2>
-<p>Zeppelin interpreter setting is the configuration of a given interpreter on zeppelin server. For example, the properties requried for hive JDBC interpreter to connect to the Hive server.</p>
+<p>Zeppelin interpreter setting is the configuration of a given interpreter on Zeppelin server. For example, the properties are required for hive JDBC interpreter to connect to the Hive server.</p>
<p><img src="/assets/themes/zeppelin/img/screenshots/interpreter_setting.png"></p>
-<h3>What is zeppelin interpreter group?</h3>
+<p><br/></p>
+
+<h2>What is Zeppelin Interpreter Group?</h2>
-<p>Every Interpreter belongs to an InterpreterGroup. InterpreterGroup is a unit of start/stop interpreter.
-By default, every interpreter belong to a single group but the group might contain more interpreters. For example, spark interpreter group include spark support, pySpark,
+<p>Every Interpreter is belonged to an <strong>Interpreter Group</strong>. Interpreter Group is a unit of start/stop interpreter.
+By default, every interpreter is belonged to a single group, but the group might contain more interpreters. For example, spark interpreter group is including Spark support, pySpark,
SparkSQL and the dependency loader.</p>
-<p>Technically, Zeppelin interpreters from the same group are running in the same JVM.</p>
+<p>Technically, Zeppelin interpreters from the same group are running in the same JVM. For more information about this, please checkout <a href="../development/writingzeppelininterpreter.html">here</a>.</p>
-<p>Interpreters belong to a single group a registered together and all of their properties are listed in the interpreter setting.
+<p>Each interpreters is belonged to a single group and registered together. All of their properties are listed in the interpreter setting like below image.
<img src="/assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png"></p>
-<h3>Programming langages for interpreter</h3>
+<p><br/></p>
+
+<h2>Programming Languages for Interpreter</h2>
+
+<p>If the interpreter uses a specific programming language ( like Scala, Python, SQL ), it is generally recommended to add a syntax highlighting supported for that to the notebook paragraph editor. </p>
-<p>If the interpreter uses a specific programming language (like Scala, Python, SQL), it is generally a good idea to add syntax highlighting support for that to the notebook paragraph editor. </p>
+<p>To check out the list of languages supported, see the <code>mode-*.js</code> files under <code>zeppelin-web/bower_components/ace-builds/src-noconflict</code> or from <a href="https://github.com/ajaxorg/ace-builds/tree/master/src-noconflict">github.com/ajaxorg/ace-builds</a>. </p>
-<p>To check out the list of languages supported, see the mode-*.js files under zeppelin-web/bower_components/ace-builds/src-noconflict or from github https://github.com/ajaxorg/ace-builds/tree/master/src-noconflict </p>
+<p>If you want to add a new set of syntax highlighting, </p>
-<p>To add a new set of syntax highlighting,<br>
-1. add the mode-*.js file to zeppelin-web/bower.json (when built, zeppelin-web/src/index.html will be changed automatically)<br>
-2. add to the list of <code>editorMode</code> in zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js - it follows the pattern 'ace/mode/x' where x is the name<br>
-3. add to the code that checks for <code>%</code> prefix and calls <code>session.setMode(editorMode.x)</code> in <code>setParagraphMode</code> in zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js </p>
+<ol>
+<li>Add the <code>mode-*.js</code> file to <code>zeppelin-web/bower.json</code> ( when built, <code>zeppelin-web/src/index.html</code> will be changed automatically. ).<br></li>
+<li>Add to the list of <code>editorMode</code> in <code>zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js</code> - it follows the pattern 'ace/mode/x' where x is the name.<br></li>
+<li>Add to the code that checks for <code>%</code> prefix and calls <code>session.setMode(editorMode.x)</code> in <code>setParagraphMode</code> located in <code>zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js</code>.<br></li>
+</ol>
</div>
</div>