You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mi...@apache.org on 2017/09/21 20:34:02 UTC
svn commit: r1809223 [14/30] - in /zeppelin/site: ./ contribution/
contribution/zeppelinweb/ docs/0.7.3/ docs/0.7.3/assets/
docs/0.7.3/assets/themes/ docs/0.7.3/assets/themes/zeppelin/
docs/0.7.3/assets/themes/zeppelin/bootstrap/ docs/0.7.3/assets/them...
Added: zeppelin/site/docs/0.7.3/interpreter/elasticsearch.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/interpreter/elasticsearch.html?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/interpreter/elasticsearch.html (added)
+++ zeppelin/site/docs/0.7.3/interpreter/elasticsearch.html Thu Sep 21 20:33:57 2017
@@ -0,0 +1,504 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.7.3 Documentation: Elasticsearch Interpreter for Apache Zeppelin</title>
+ <meta name="description" content="Elasticsearch is a highly scalable open-source full-text search and analytics engine.">
+ <meta name="author" content="The Apache Software Foundation">
+
+ <!-- Enable responsive viewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
+
+ <!-- Le styles -->
+ <link href="/docs/0.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.7.3/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />
+ <!-- Le fav and touch icons -->
+ <!-- Update these with your own images
+ <link rel="shortcut icon" href="images/favicon.ico">
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
+ -->
+
+ <!-- Js -->
+ <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.7.3/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <div class="navbar-brand">
+ <a class="navbar-brand-main" href="http://zeppelin.apache.org">
+ <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
+ <span style="vertical-align:middle">Zeppelin</span>
+ </a>
+ <a class="navbar-brand-version" href="/docs/0.7.3">
+ <span><small>0.7.3</small></span>
+ </a>
+ </div>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Getting Started</b><span></li>
+ <li><a href="/docs/0.7.3/install/install.html">Install</a></li>
+ <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li>
+ <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li>
+ <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Basic Feature Guide</b><span></li>
+ <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li>
+ <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li>
+ <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>More</b><span></li>
+ <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li>
+ <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li>
+ <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Usage</b><span></li>
+ <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li>
+ <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>-->
+ <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li>
+ <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li>
+ <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Available Interpreters</b><span></li>
+ <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li>
+ <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li>
+ <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li>
+ <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li>
+ <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li>
+ <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span><b>Basic Display System</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Angular API</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;">
+ <li class="title"><span><b>Notebook Storage</b><span></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>REST API</b><span></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Security</b><span></li>
+ <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li>
+ <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Advanced</b><span></li>
+ <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li>
+ <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Contibute</b><span></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.7.3/search.html" class="nav-search-link">
+ <span class="fa fa-search nav-search-icon"></span>
+ </a>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+
+ <div class="content">
+
+<!--<div class="hero-unit Elasticsearch Interpreter for Apache Zeppelin">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<h1>Elasticsearch Interpreter for Apache Zeppelin</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<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>
+
+<h2>Configuration</h2>
+
+<table class="table-configuration">
+ <tr>
+ <th>Property</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>elasticsearch.cluster.name</td>
+ <td>elasticsearch</td>
+ <td>Cluster name</td>
+ </tr>
+ <tr>
+ <td>elasticsearch.host</td>
+ <td>localhost</td>
+ <td>Host of a node in the cluster</td>
+ </tr>
+ <tr>
+ <td>elasticsearch.port</td>
+ <td>9300</td>
+ <td>Connection port <b>( Important: it depends on the client type, transport or http)</b></td>
+ </tr>
+ <tr>
+ <td>elasticsearch.client.type</td>
+ <td>transport</td>
+ <td>The type of client for Elasticsearch (transport or http)<b>( Important: the port depends on this value)</b></td>
+ </tr>
+ <tr>
+ <td>elasticsearch.basicauth.username</td>
+ <td></td>
+ <td>Username for a basic authentication (http)</b></td>
+ </tr>
+ <tr>
+ <td>elasticsearch.basicauth.password</td>
+ <td></td>
+ <td>Password for a basic authentication (http)</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><center>
+ <img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-config.png" alt="Interpreter configuration">
+</center></p>
+
+<blockquote>
+<p><strong>Note #1 :</strong> You can add more properties to configure the Elasticsearch client.</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>
+
+<h2>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>
+
+<h2>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">%elasticsearch
+<span class="nb">help</span>
+
+Elasticsearch interpreter:
+General format: <<span class="nb">command</span>> /<indices>/<types>/<id> <option> <JSON>
+ - indices: list of indices separated by commas <span class="o">(</span>depends on the <span class="nb">command</span><span class="o">)</span>
+ - types: list of document types separated by commas <span class="o">(</span>depends on the <span class="nb">command</span><span class="o">)</span>
+Commands:
+ - search /indices/types <query>
+ . indices and types can be omitted <span class="o">(</span>at least, you have to provide <span class="s1">'/'</span><span class="o">)</span>
+ . a query is either a JSON-formatted query, nor a lucene query
+ - size <value>
+ . defines the size of the result <span class="nb">set</span> <span class="o">(</span>default value is in the config<span class="o">)</span>
+ . <span class="k">if </span>used, this <span class="nb">command </span>must be declared before a search <span class="nb">command</span>
+ - count /indices/types <query>
+ . same comments as <span class="k">for </span>the search
+ - get /index/type/id
+ - delete /index/type/id
+ - index /index/type/id <json-formatted document>
+ . the id can be omitted, elasticsearch will generate one
+</code></pre></div>
+<blockquote>
+<p><strong>Tip :</strong> Use ( Ctrl + . ) for autocompletion.</p>
+</blockquote>
+
+<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">%elasticsearch
+get /index/type/id
+</code></pre></div>
+<p>Example:
+<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-get.png" alt="Elasticsearch - Get"></p>
+
+<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>
+
+<ul>
+<li>You can provide a JSON-formatted query, that is exactly what you provide when you use the REST API of Elasticsearch.<br>
+
+<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>.
+
+<ul>
+<li>This is a shortcut to a query like that: <code>{ "query": { "query_string": { "query": "__HERE YOUR QUERY__", "analyze_wildcard": true } } }</code></li>
+<li>See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax">Elasticsearch query string syntax</a> for more details about the content of such a query.</li>
+</ul></li>
+</ul>
+<div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch
+search /index1,index2,.../type1,type2,... <JSON document containing the query or query_string elements>
+</code></pre></div>
+<p>If you want to modify the size of the result set, you can add a line that is setting the size, before your search command.</p>
+<div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch
+size 50
+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">%elasticsearch
+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>
+
+%elasticsearch
+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>
+
+%elasticsearch
+search /logs <span class="o">{</span> <span class="s2">"aggs"</span>: <span class="o">{</span>
+<span class="s2">"content_length_stats"</span>: <span class="o">{</span>
+ <span class="s2">"extended_stats"</span>: <span class="o">{</span>
+ <span class="s2">"field"</span>: <span class="s2">"content_length"</span>
+ <span class="o">}</span>
+<span class="o">}</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">%elasticsearch
+search /logs request.method:GET AND status:200
+
+%elasticsearch
+search /logs <span class="o">(</span>404 AND <span class="o">(</span>POST OR DELETE<span class="o">))</span>
+</code></pre></div></li>
+</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.
+For the Elastic interpreter, the result of a search query is flattened.</p>
+</blockquote>
+
+<p>Suppose we have a JSON document:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">{
+ "date": "2015-12-08T21:03:13.588Z",
+ "request": {
+ "method": "GET",
+ "url": "/zeppelin/4cd001cd-c517-4fa9-b8e5-a06b8f4056c4",
+ "headers": [ "Accept: *.*", "Host: apache.org"]
+ },
+ "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>
+<th>request.method</th>
+<th>request.url</th>
+<th>status</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>1234</td>
+<td>2015-12-08T21:03:13.588Z</td>
+<td>Accept: *.*</td>
+<td>Host: apache.org</td>
+<td>GET</td>
+<td>/zeppelin/4cd001cd-c517-4fa9-b8e5-a06b8f4056c4</td>
+<td>403</td>
+</tr>
+</tbody></table>
+
+<p>Examples:</p>
+
+<ul>
+<li><p>With a table containing the results:
+<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-search-table.png" alt="Elasticsearch - Search - table"></p></li>
+<li><p>You can also use a predefined diagram:
+<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-search-pie.png" alt="Elasticsearch - Search - diagram"></p></li>
+<li><p>With a JSON query:
+<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 JSON query containing a <code>fields</code> parameter (for filtering the fields in the response): in this case, all the fields values in the response are arrays, so, after flattening the result, the format of all the field names is <code>field_name[x]</code>
+<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-query-with-fields-param.png" alt="Elasticsearch - Search with query and a fields param"></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>
+
+<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">%elasticsearch
+count /index1,index2,.../type1,type2,... <JSON document containing the query OR a query string>
+</code></pre></div>
+<p>Examples:</p>
+
+<ul>
+<li><p>Without query:
+<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-count.png" alt="Elasticsearch - Count"></p></li>
+<li><p>With a query:
+<img src="../assets/themes/zeppelin/img/docs-img/elasticsearch-count-with-query.png" alt="Elasticsearch - Count with query"></p></li>
+</ul>
+
+<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">%elasticsearch
+index /index/type/id <JSON document>
+
+%elasticsearch
+index /index/type <JSON document>
+</code></pre></div>
+<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">%elasticsearch
+delete /index/type/id
+</code></pre></div>
+<h3>Apply Zeppelin Dynamic Forms</h3>
+
+<p>You can leverage <a href="../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">%elasticsearch
+size <span class="k">${</span><span class="nv">limit</span><span class="p">=10</span><span class="k">}</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>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2017 The Apache Software Foundation</p>-->
+ </footer>
+ </div>
+
+
+
+
+ <script type="text/javascript">
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-45176241-5', 'zeppelin.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+
Added: zeppelin/site/docs/0.7.3/interpreter/flink.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/interpreter/flink.html?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/interpreter/flink.html (added)
+++ zeppelin/site/docs/0.7.3/interpreter/flink.html Thu Sep 21 20:33:57 2017
@@ -0,0 +1,303 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.7.3 Documentation: Flink Interpreter for Apache Zeppelin</title>
+ <meta name="description" content="Apache Flink is an open source platform for distributed stream and batch data processing.">
+ <meta name="author" content="The Apache Software Foundation">
+
+ <!-- Enable responsive viewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
+
+ <!-- Le styles -->
+ <link href="/docs/0.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.7.3/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />
+ <!-- Le fav and touch icons -->
+ <!-- Update these with your own images
+ <link rel="shortcut icon" href="images/favicon.ico">
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
+ -->
+
+ <!-- Js -->
+ <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.7.3/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <div class="navbar-brand">
+ <a class="navbar-brand-main" href="http://zeppelin.apache.org">
+ <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
+ <span style="vertical-align:middle">Zeppelin</span>
+ </a>
+ <a class="navbar-brand-version" href="/docs/0.7.3">
+ <span><small>0.7.3</small></span>
+ </a>
+ </div>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Getting Started</b><span></li>
+ <li><a href="/docs/0.7.3/install/install.html">Install</a></li>
+ <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li>
+ <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li>
+ <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Basic Feature Guide</b><span></li>
+ <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li>
+ <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li>
+ <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>More</b><span></li>
+ <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li>
+ <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li>
+ <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Usage</b><span></li>
+ <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li>
+ <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>-->
+ <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li>
+ <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li>
+ <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Available Interpreters</b><span></li>
+ <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li>
+ <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li>
+ <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li>
+ <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li>
+ <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li>
+ <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span><b>Basic Display System</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Angular API</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;">
+ <li class="title"><span><b>Notebook Storage</b><span></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>REST API</b><span></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Security</b><span></li>
+ <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li>
+ <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Advanced</b><span></li>
+ <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li>
+ <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Contibute</b><span></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.7.3/search.html" class="nav-search-link">
+ <span class="fa fa-search nav-search-icon"></span>
+ </a>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+
+ <div class="content">
+
+<!--<div class="hero-unit Flink Interpreter for Apache Zeppelin">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<h1>Flink interpreter for Apache Zeppelin</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<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>
+
+<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>
+
+<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>
+
+<table class="table-configuration">
+ <tr>
+ <th>property</th>
+ <th>value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>host</td>
+ <td>local</td>
+ <td>host name of running JobManager. 'local' runs flink in local mode (default)</td>
+ </tr>
+ <tr>
+ <td>port</td>
+ <td>6123</td>
+ <td>port of running JobManager</td>
+ </tr>
+</table>
+
+<p>For more information about Flink configuration, you can find it <a href="https://ci.apache.org/projects/flink/flink-docs-release-1.0/setup/config.html">here</a>.</p>
+
+<h2>How to test it's working</h2>
+
+<p>You can find an example of Flink usage in the Zeppelin Tutorial folder or try the following word count example, by using the <a href="https://www.zeppelinhub.com/viewer/notebooks/aHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL05GTGFicy96ZXBwZWxpbi1ub3RlYm9va3MvbWFzdGVyL25vdGVib29rcy8yQVFFREs1UEMvbm90ZS5qc29u">Zeppelin notebook</a> 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="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">benv</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>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2017 The Apache Software Foundation</p>-->
+ </footer>
+ </div>
+
+
+
+
+ <script type="text/javascript">
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-45176241-5', 'zeppelin.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+
Added: zeppelin/site/docs/0.7.3/interpreter/geode.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/interpreter/geode.html?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/interpreter/geode.html (added)
+++ zeppelin/site/docs/0.7.3/interpreter/geode.html Thu Sep 21 20:33:57 2017
@@ -0,0 +1,419 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.7.3 Documentation: Geode/Gemfire OQL Interpreter for Apache Zeppelin</title>
+ <meta name="description" content="Apache Geode (incubating) provides a database-like consistency model, reliable transaction processing and a shared-nothing architecture to maintain very low latency performance with high concurrency processing.">
+ <meta name="author" content="The Apache Software Foundation">
+
+ <!-- Enable responsive viewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
+
+ <!-- Le styles -->
+ <link href="/docs/0.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.7.3/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />
+ <!-- Le fav and touch icons -->
+ <!-- Update these with your own images
+ <link rel="shortcut icon" href="images/favicon.ico">
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
+ -->
+
+ <!-- Js -->
+ <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.7.3/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <div class="navbar-brand">
+ <a class="navbar-brand-main" href="http://zeppelin.apache.org">
+ <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
+ <span style="vertical-align:middle">Zeppelin</span>
+ </a>
+ <a class="navbar-brand-version" href="/docs/0.7.3">
+ <span><small>0.7.3</small></span>
+ </a>
+ </div>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Getting Started</b><span></li>
+ <li><a href="/docs/0.7.3/install/install.html">Install</a></li>
+ <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li>
+ <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li>
+ <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Basic Feature Guide</b><span></li>
+ <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li>
+ <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li>
+ <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>More</b><span></li>
+ <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li>
+ <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li>
+ <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Usage</b><span></li>
+ <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li>
+ <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>-->
+ <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li>
+ <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li>
+ <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Available Interpreters</b><span></li>
+ <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li>
+ <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li>
+ <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li>
+ <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li>
+ <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li>
+ <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span><b>Basic Display System</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Angular API</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;">
+ <li class="title"><span><b>Notebook Storage</b><span></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>REST API</b><span></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Security</b><span></li>
+ <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li>
+ <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Advanced</b><span></li>
+ <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li>
+ <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Contibute</b><span></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.7.3/search.html" class="nav-search-link">
+ <span class="fa fa-search nav-search-icon"></span>
+ </a>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+
+ <div class="content">
+
+<!--<div class="hero-unit Geode/Gemfire OQL Interpreter for Apache Zeppelin">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<h1>Geode/Gemfire OQL Interpreter for Apache Zeppelin</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<table class="table-configuration">
+ <tr>
+ <th>Name</th>
+ <th>Class</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>%geode.oql</td>
+ <td>GeodeOqlInterpreter</td>
+ <td>Provides OQL environment for Apache Geode</td>
+ </tr>
+</table>
+
+<p>This interpreter supports the <a href="http://geode.incubator.apache.org/">Geode</a> <a href="http://geode-docs.cfapps.io/docs/developing/querying_basics/oql_compared_to_sql.html">Object Query Language (OQL)</a>. With the OQL-based querying language:</p>
+
+<p><a href="https://www.youtube.com/watch?v=zvzzA9GXu3Q"><img align="right" src="http://img.youtube.com/vi/zvzzA9GXu3Q/3.jpg" alt="zeppelin-view" hspace="10" width="200"></img></a></p>
+
+<ul>
+<li>You can query on any arbitrary object</li>
+<li>You can navigate object collections</li>
+<li>You can invoke methods and access the behavior of objects</li>
+<li>Data mapping is supported</li>
+<li>You are not required to declare types. Since you do not need type definitions, you can work across multiple languages</li>
+<li>You are not constrained by a schema</li>
+</ul>
+
+<p>This <a href="https://www.youtube.com/watch?v=zvzzA9GXu3Q">Video Tutorial</a> illustrates some of the features provided by the <code>Geode Interpreter</code>.</p>
+
+<h2>Create Interpreter</h2>
+
+<p>By default Zeppelin creates one <code>Geode/OQL</code> instance. You can remove it or create more instances.</p>
+
+<p>Multiple Geode instances can be created, each configured to the same or different backend Geode cluster. But over time a <code>Notebook</code> can have only one Geode interpreter instance <code>bound</code>. That means you <em>cannot</em> connect to different Geode clusters in the same <code>Notebook</code>. This is a known Zeppelin limitation.</p>
+
+<p>To create new Geode instance open the <code>Interpreter</code> section and click the <code>+Create</code> button. Pick a <code>Name</code> of your choice and from the <code>Interpreter</code> drop-down select <code>geode</code>. Then follow the configuration instructions and <code>Save</code> the new instance.</p>
+
+<blockquote>
+<p>Note: The <code>Name</code> of the instance is used only to distinguish the instances while binding them to the <code>Notebook</code>. The <code>Name</code> is irrelevant inside the <code>Notebook</code>. In the <code>Notebook</code> you must use <code>%geode.oql</code> tag.</p>
+</blockquote>
+
+<h2>Bind to Notebook</h2>
+
+<p>In the <code>Notebook</code> click on the <code>settings</code> icon in the top right corner. The select/deselect the interpreters to be bound with the <code>Notebook</code>.</p>
+
+<h2>Configuration</h2>
+
+<p>You can modify the configuration of the Geode from the <code>Interpreter</code> section. The Geode interpreter expresses the following properties:</p>
+
+<table class="table-configuration">
+ <tr>
+ <th>Property Name</th>
+ <th>Description</th>
+ <th>Default Value</th>
+ </tr>
+ <tr>
+ <td>geode.locator.host</td>
+ <td>The Geode Locator Host</td>
+ <td>localhost</td>
+ </tr>
+ <tr>
+ <td>geode.locator.port</td>
+ <td>The Geode Locator Port</td>
+ <td>10334</td>
+ </tr>
+ <tr>
+ <td>geode.max.result</td>
+ <td>Max number of OQL result to display to prevent the browser overload</td>
+ <td>1000</td>
+ </tr>
+</table>
+
+<h2>How to use</h2>
+
+<blockquote>
+<p><em>Tip 1: Use (CTRL + .) for OQL auto-completion.</em></p>
+
+<p><em>Tip 2: Always start the paragraphs with the full <code>%geode.oql</code> prefix tag! The short notation: <code>%geode</code> would still be able run the OQL queries but the syntax highlighting and the auto-completions will be disabled.</em></p>
+</blockquote>
+
+<h3>Create / Destroy Regions</h3>
+
+<p>The OQL specification does not support <a href="https://cwiki.apache.org/confluence/display/GEODE/Index#Index-MainConceptsandComponents">Geode Regions</a> mutation operations. To <code>create</code>/<code>destroy</code> regions one should use the <a href="http://geode-docs.cfapps.io/docs/tools_modules/gfsh/chapter_overview.html">GFSH</a> shell tool instead. In the following it is assumed that the GFSH is colocated with Zeppelin server.</p>
+<div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%sh
+<span class="nb">source</span> /etc/geode/conf/geode-env.sh
+gfsh <span class="s"><< EOF</span>
+
+<span class="s"> connect --locator=ambari.localdomain[10334]</span>
+
+<span class="s"> destroy region --name=/regionEmployee</span>
+<span class="s"> destroy region --name=/regionCompany</span>
+<span class="s"> create region --name=regionEmployee --type=REPLICATE</span>
+<span class="s"> create region --name=regionCompany --type=REPLICATE</span>
+
+<span class="s"> exit;</span>
+<span class="s">EOF</span>
+</code></pre></div>
+<p>Above snippet re-creates two regions: <code>regionEmployee</code> and <code>regionCompany</code>. Note that you have to explicitly specify the locator host and port. The values should match those you have used in the Geode Interpreter configuration. Comprehensive list of <a href="http://geode-docs.cfapps.io/docs/tools_modules/gfsh/gfsh_quick_reference.html">GFSH Commands by Functional Area</a>.</p>
+
+<h3>Basic OQL</h3>
+<div class="highlight"><pre><code class="sql language-sql" data-lang="sql"><span class="o">%</span><span class="n">geode</span><span class="p">.</span><span class="n">oql</span>
+<span class="k">SELECT</span> <span class="k">count</span><span class="p">(</span><span class="o">*</span><span class="p">)</span> <span class="k">FROM</span> <span class="o">/</span><span class="n">regionEmployee</span>
+</code></pre></div>
+<p>OQL <code>IN</code> and <code>SET</code> filters:</p>
+<div class="highlight"><pre><code class="sql language-sql" data-lang="sql"><span class="o">%</span><span class="n">geode</span><span class="p">.</span><span class="n">oql</span>
+<span class="k">SELECT</span> <span class="o">*</span> <span class="k">FROM</span> <span class="o">/</span><span class="n">regionEmployee</span>
+<span class="k">WHERE</span> <span class="n">companyId</span> <span class="k">IN</span> <span class="k">SET</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="k">OR</span> <span class="n">lastName</span> <span class="k">IN</span> <span class="k">SET</span><span class="p">(</span><span class="s1">'Tzolov13'</span><span class="p">,</span> <span class="s1">'Tzolov73'</span><span class="p">)</span>
+</code></pre></div>
+<p>OQL <code>JOIN</code> operations</p>
+<div class="highlight"><pre><code class="sql language-sql" data-lang="sql"><span class="o">%</span><span class="n">geode</span><span class="p">.</span><span class="n">oql</span>
+<span class="k">SELECT</span> <span class="n">e</span><span class="p">.</span><span class="n">employeeId</span><span class="p">,</span> <span class="n">e</span><span class="p">.</span><span class="n">firstName</span><span class="p">,</span> <span class="n">e</span><span class="p">.</span><span class="n">lastName</span><span class="p">,</span> <span class="k">c</span><span class="p">.</span><span class="n">id</span> <span class="k">as</span> <span class="n">companyId</span><span class="p">,</span> <span class="k">c</span><span class="p">.</span><span class="n">companyName</span><span class="p">,</span> <span class="k">c</span><span class="p">.</span><span class="n">address</span>
+<span class="k">FROM</span> <span class="o">/</span><span class="n">regionEmployee</span> <span class="n">e</span><span class="p">,</span> <span class="o">/</span><span class="n">regionCompany</span> <span class="k">c</span>
+<span class="k">WHERE</span> <span class="n">e</span><span class="p">.</span><span class="n">companyId</span> <span class="o">=</span> <span class="k">c</span><span class="p">.</span><span class="n">id</span>
+</code></pre></div>
+<p>By default the QOL responses contain only the region entry values. To access the keys, query the <code>EntrySet</code> instead:</p>
+<div class="highlight"><pre><code class="sql language-sql" data-lang="sql"><span class="o">%</span><span class="n">geode</span><span class="p">.</span><span class="n">oql</span>
+<span class="k">SELECT</span> <span class="n">e</span><span class="p">.</span><span class="k">key</span><span class="p">,</span> <span class="n">e</span><span class="p">.</span><span class="n">value</span><span class="p">.</span><span class="n">companyId</span><span class="p">,</span> <span class="n">e</span><span class="p">.</span><span class="n">value</span><span class="p">.</span><span class="n">email</span>
+<span class="k">FROM</span> <span class="o">/</span><span class="n">regionEmployee</span><span class="p">.</span><span class="n">entrySet</span> <span class="n">e</span>
+</code></pre></div>
+<p>Following query will return the EntrySet value as a Blob:</p>
+<div class="highlight"><pre><code class="sql language-sql" data-lang="sql"><span class="o">%</span><span class="n">geode</span><span class="p">.</span><span class="n">oql</span>
+<span class="k">SELECT</span> <span class="n">e</span><span class="p">.</span><span class="k">key</span><span class="p">,</span> <span class="n">e</span><span class="p">.</span><span class="n">value</span> <span class="k">FROM</span> <span class="o">/</span><span class="n">regionEmployee</span><span class="p">.</span><span class="n">entrySet</span> <span class="n">e</span>
+</code></pre></div>
+<blockquote>
+<p>Note: You can have multiple queries in the same paragraph but only the result from the first is displayed. [<a href="https://issues.apache.org/jira/browse/ZEPPELIN-178">1</a>], [<a href="https://issues.apache.org/jira/browse/ZEPPELIN-212">2</a>].</p>
+</blockquote>
+
+<h3>GFSH Commands From The Shell</h3>
+
+<p>Use the Shell Interpreter (<code>%sh</code>) to run OQL commands form the command line:</p>
+<div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%sh
+<span class="nb">source</span> /etc/geode/conf/geode-env.sh
+gfsh -e <span class="s2">"connect"</span> -e <span class="s2">"list members"</span>
+</code></pre></div>
+<h3>Apply Zeppelin Dynamic Forms</h3>
+
+<p>You can leverage <a href="../manual/dynamicform.html">Zeppelin Dynamic Form</a> inside your OQL 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">geode</span><span class="p">.</span><span class="n">oql</span>
+<span class="k">SELECT</span> <span class="o">*</span> <span class="k">FROM</span> <span class="o">/</span><span class="n">regionEmployee</span> <span class="n">e</span> <span class="k">WHERE</span> <span class="n">e</span><span class="p">.</span><span class="n">employeeId</span> <span class="o">></span> <span class="err">${</span><span class="n">Id</span><span class="err">}</span>
+</code></pre></div>
+<h3>Auto-completion</h3>
+
+<p>The Geode Interpreter provides a basic auto-completion functionality. On <code>(Ctrl+.)</code> it list the most relevant suggestions in a pop-up window.</p>
+
+<h2>Geode REST API</h2>
+
+<p>To list the defined regions you can use the <a href="http://geode-docs.cfapps.io/docs/geode_rest/chapter_overview.html">Geode REST API</a>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">http://<geode server hostname>phd1.localdomain:8484/gemfire-api/v1/
+</code></pre></div><div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"regions"</span> <span class="p">:</span> <span class="p">[{</span>
+ <span class="nt">"name"</span> <span class="p">:</span> <span class="s2">"regionEmployee"</span><span class="p">,</span>
+ <span class="nt">"type"</span> <span class="p">:</span> <span class="s2">"REPLICATE"</span><span class="p">,</span>
+ <span class="nt">"key-constraint"</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="nt">"value-constraint"</span> <span class="p">:</span> <span class="kc">null</span>
+ <span class="p">},</span> <span class="p">{</span>
+ <span class="nt">"name"</span> <span class="p">:</span> <span class="s2">"regionCompany"</span><span class="p">,</span>
+ <span class="nt">"type"</span> <span class="p">:</span> <span class="s2">"REPLICATE"</span><span class="p">,</span>
+ <span class="nt">"key-constraint"</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="nt">"value-constraint"</span> <span class="p">:</span> <span class="kc">null</span>
+ <span class="p">}]</span>
+<span class="p">}</span>
+</code></pre></div>
+<blockquote>
+<p>To enable Geode REST API with JSON support add the following properties to geode.server.properties.file and restart:</p>
+</blockquote>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">http-service-port=8484
+start-dev-rest-api=true
+</code></pre></div>
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2017 The Apache Software Foundation</p>-->
+ </footer>
+ </div>
+
+
+
+
+ <script type="text/javascript">
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-45176241-5', 'zeppelin.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+