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 2015/11/07 01:39:07 UTC
svn commit: r1713055 - in /incubator/zeppelin/site:
assets/themes/zeppelin/img/docs-img/ docs/ docs/interpreter/
Author: moon
Date: Sat Nov 7 00:39:07 2015
New Revision: 1713055
URL: http://svn.apache.org/viewvc?rev=1713055&view=rev
Log:
ZEPPELIN-388 Add documentation for Ignite Interpreter
Added:
incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-interpreter-binding.png (with props)
incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-interpreter-setting.png (with props)
incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-logo.png (with props)
incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-scala-example.png (with props)
incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-sql-example.png (with props)
incubator/zeppelin/site/docs/interpreter/ignite.html
Modified:
incubator/zeppelin/site/docs/index.html
Added: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-interpreter-binding.png
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-interpreter-binding.png?rev=1713055&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-interpreter-binding.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-interpreter-setting.png
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-interpreter-setting.png?rev=1713055&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-interpreter-setting.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-logo.png
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-logo.png?rev=1713055&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-logo.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-scala-example.png
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-scala-example.png?rev=1713055&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-scala-example.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-sql-example.png
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-sql-example.png?rev=1713055&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/zeppelin/site/assets/themes/zeppelin/img/docs-img/ignite-sql-example.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: incubator/zeppelin/site/docs/index.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/index.html?rev=1713055&r1=1713054&r2=1713055&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/index.html (original)
+++ incubator/zeppelin/site/docs/index.html Sat Nov 7 00:39:07 2015
@@ -25,7 +25,11 @@
<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="/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
<!-- atom & rss feed -->
<link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
@@ -172,6 +176,14 @@
+
+
+
+
+
+
+
+
@@ -289,6 +301,14 @@
+
+
+
+
+
+
+
+
<li><a href="/download.html">Download</a></li>
@@ -361,7 +381,7 @@
<ul>
<li><a href="./interpreter/flink.html">flink</a></li>
<li><a href="../docs/pleasecontribute.html">hive</a></li>
-<li><a href="../docs/pleasecontribute.html">ignite</a></li>
+<li><a href="./interpreter/ignite.html">ignite</a></li>
<li><a href="./interpreter/lens.html">lens</a></li>
<li><a href="../docs/pleasecontribute.html">md</a></li>
<li><a href="../docs/pleasecontribute.html">sh</a></li>
@@ -429,9 +449,6 @@
- <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
-
- <script src="/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
</body>
</html>
Added: incubator/zeppelin/site/docs/interpreter/ignite.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/interpreter/ignite.html?rev=1713055&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/interpreter/ignite.html (added)
+++ incubator/zeppelin/site/docs/interpreter/ignite.html Sat Nov 7 00:39:07 2015
@@ -0,0 +1,502 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Ignite Interpreter</title>
+ <meta name="description" content="Ignite user guide">
+ <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]-->
+
+ <!-- Le styles -->
+ <link href="/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/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="/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div 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>
+ <a class="navbar-brand" href="/">
+ <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
+ Apache Zeppelin <small>(incubating)</small>
+ </a>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ <ul class="nav navbar-nav navbar-right">
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/community.html">Community</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/index.html">Docs</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/download.html">Download</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="https://github.com/apache/incubator-zeppelin">GitHub</a></li>
+ <li id="apache">
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Apache<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://www.apache.org/foundation/how-it-works.html">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/">Apache License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ </ul>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+
+
+ <div class="container">
+
+<!--<div class="hero-unit Ignite Interpreter">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <h2>Ignite Interpreter for Apache Zeppelin</h2>
+
+<h3>Overview</h3>
+
+<p><a href="https://ignite.apache.org/">Apache Ignite</a> In-Memory Data Fabric is a high-performance, integrated and distributed in-memory platform for computing and transacting on large-scale data sets in real-time, orders of magnitude faster than possible with traditional disk-based or flash technologies.</p>
+
+<p><img src="/assets/themes/zeppelin/img/docs-img/ignite-logo.png" alt="Apache Ignite"></p>
+
+<p>You can use Zeppelin to retrieve distributed data from cache using Ignite SQL interpreter. Moreover, Ignite interpreter allows you to execute any Scala code in cases when SQL doesn't fit to your requirements. For example, you can populate data into your caches or execute distributed computations.</p>
+
+<h3>Installing and Running Ignite example</h3>
+
+<p>In order to use Ignite interpreters, you may install Apache Ignite in some simple steps:</p>
+
+<ol>
+<li><p>Download Ignite <a href="https://ignite.apache.org/download.html#sources">source release</a> or <a href="https://ignite.apache.org/download.html#binaries">binary release</a> whatever you want. But you must download Ignite as the same version of Zeppelin's. If it is not, you can't use scala code on Zeppelin. You can find ignite version in Zepplin at the pom.xml which is placed under <code>path/to/your-Zeppelin/ignite/pom.xml</code> ( Of course, in Zeppelin source release ). Please check <code>ignite.version</code> .<br>Currently, Zeppelin provides ignite only in Zeppelin source release. So, if you download Zeppelin binary release( <code>zeppelin-0.5.0-incubating-bin-spark-xxx-hadoop-xx</code> ), you can not use ignite interpreter on Zeppelin. We are planning to include ignite in a future binary release.</p></li>
+<li><p>Examples are shipped as a separate Maven project, so to start running you simply need to import provided <dest_dir>/apache-ignite-fabric-1.2.0-incubating-bin/pom.xml file into your favourite IDE, such as Eclipse. </p></li>
+</ol>
+
+<ul>
+<li>In case of Eclipse, Eclipse -> File -> Import -> Existing Maven Projects</li>
+<li>Set examples directory path to Eclipse and select the pom.xml.</li>
+<li><p>Then start <code>org.apache.ignite.examples.ExampleNodeStartup</code> (or whatever you want) to run at least one or more ignite node. When you run example code, you may notice that the number of node is increase one by one. </p>
+
+<blockquote>
+<p><strong>Tip. If you want to run Ignite examples on the cli not IDE, you can export executable Jar file from IDE. Then run it by using below command.</strong></p>
+</blockquote>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">$ nohup java -jar </path/to/your Jar file name>
+</code></pre></div></li>
+</ul>
+
+<h3>Configuring Ignite Interpreter</h3>
+
+<p>At the "Interpreters" menu, you may edit Ignite interpreter or create new one. Zeppelin provides these properties for Ignite.</p>
+
+<p><table class="table-configuration">
+ <tr>
+ <th>Property Name</th>
+ <th>value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>ignite.addresses</td>
+ <td>127.0.0.1:47500..47509</td>
+ <td>Coma separated list of Ignite cluster hosts. See <a href="https://apacheignite.readme.io/v1.2/docs/cluster-config">Ignite Cluster Configuration</a> section for more details.</td>
+ </tr>
+ <tr>
+ <td>ignite.clientMode</td>
+ <td>true</td>
+ <td>You can connect to the Ignite cluster as client or server node. See <a href="https://apacheignite.readme.io/v1.2/docs/clients-vs-servers">Ignite Clients vs. Servers</a> section for details. Use true or false values in order to connect in client or server mode respectively.</td>
+ </tr>
+ <tr>
+ <td>ignite.config.url</td>
+ <td></td>
+ <td>Configuration URL. Overrides all other settings.</td>
+ </tr
+ <tr>
+ <td>ignite.jdbc.url</td>
+ <td>jdbc:ignite:cfg://default-ignite-jdbc.xml</td>
+ <td>Ignite JDBC connection URL.</td>
+ </tr>
+ <tr>
+ <td>ignite.peerClassLoadingEnabled</td>
+ <td>true</td>
+ <td>Enables peer-class-loading. See <a href="https://apacheignite.readme.io/v1.2/docs/zero-deployment">Zero Deployment</a> section for details. Use true or false values in order to enable or disable P2P class loading respectively.</td>
+ </tr>
+ </table></p>
+
+<p><img src="/assets/themes/zeppelin/img/docs-img/ignite-interpreter-setting.png" alt="Configuration of Ignite Interpreter"></p>
+
+<h3>Interpreter Binding for Zeppelin Notebook</h3>
+
+<p>After configuring Ignite interpreter, create your own notebook. Then you can bind interpreters like below image.</p>
+
+<p><img src="/assets/themes/zeppelin/img/docs-img/ignite-interpreter-binding.png" alt="Binding Interpreters"></p>
+
+<p>For more interpreter binding information see <a href="http://zeppelin.incubator.apache.org/docs/manual/interpreters.html">here</a>.</p>
+
+<h3>How to use Ignite SQL interpreter</h3>
+
+<p>In order to execute SQL query, use <code>%ignite.ignitesql</code> prefix. <br>
+Supposing you are running <code>org.apache.ignite.examples.streaming.wordcount.StreamWords</code>, then you can use "words" cache( Of course you have to specify this cache name to the Ignite interpreter setting section <code>ignite.jdbc.url</code> of Zeppelin ).
+For example, you can select top 10 words in the words cache using the following query</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"> %ignite.ignitesql
+ select _val, count(_val) as cnt from String group by _val order by cnt desc limit 10
+</code></pre></div>
+<p><img src="/assets/themes/zeppelin/img/docs-img/ignite-sql-example.png" alt="IgniteSql on Zeppelin"></p>
+
+<p>As long as your Ignite version and Zeppelin Ignite version is same, you can also use scala code. Please check the Zeppelin Ignite version before you download your own Ignite. </p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"> %ignite
+ import org.apache.ignite._
+ import org.apache.ignite.cache.affinity._
+ import org.apache.ignite.cache.query._
+ import org.apache.ignite.configuration._
+
+ import scala.collection.JavaConversions._
+
+ val cache: IgniteCache[AffinityUuid, String] = ignite.cache("words")
+
+ val qry = new SqlFieldsQuery("select avg(cnt), min(cnt), max(cnt) from (select count(_val) as cnt from String group by _val)", true)
+
+ val res = cache.query(qry).getAll()
+
+ collectionAsScalaIterable(res).foreach(println _)
+</code></pre></div>
+<p><img src="/assets/themes/zeppelin/img/docs-img/ignite-scala-example.png" alt="Using Scala Code"></p>
+
+<p>Apache Ignite also provides a guide docs for Zeppelin <a href="https://apacheignite.readme.io/docs/data-analysis-with-apache-zeppelin">"Ignite with Apache Zeppelin"</a></p>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2015 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.incubator.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+