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/10/25 06:17:33 UTC
incubator-zeppelin git commit: ZEPPELIN-334 Add documentation for
Apache Lens Interpreter
Repository: incubator-zeppelin
Updated Branches:
refs/heads/master 7465a2641 -> 52cdbacf2
ZEPPELIN-334 Add documentation for Apache Lens Interpreter
[ZEPPELIN-334](https://issues.apache.org/jira/browse/ZEPPELIN-334?jql=project%20%3D%20ZEPPELIN%20AND%20text%20~%20%22lens%22) Add documentation for Apache Lens Interpreter
Since the last PR that I opened few days ago has some problems, so I create new one.
I read all comments in the last one and edited below files.
Author: Ryu Ah young <fb...@hanmail.net>
Closes #360 from AhyoungRyu/ZEPPELIN-334-Add-documentation-for-Apache-Lens-Interpreter and squashes the following commits:
9099e6d [Ryu Ah young] modify the typo and add description
11feb1d [Ryu Ah young] ZEPPELIN-334 Add documentation for Apache Lens Interpreter
Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/52cdbacf
Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/52cdbacf
Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/52cdbacf
Branch: refs/heads/master
Commit: 52cdbacf207bceb5d66b18c1e5452608881906cf
Parents: 7465a26
Author: Ryu Ah young <fb...@hanmail.net>
Authored: Sat Oct 24 20:46:31 2015 +0900
Committer: Lee moon soo <mo...@apache.org>
Committed: Sun Oct 25 14:18:36 2015 +0900
----------------------------------------------------------------------
.../img/docs-img/lens-interpreter-binding.png | Bin 0 -> 78255 bytes
.../img/docs-img/lens-interpreter-setting.png | Bin 0 -> 73297 bytes
.../themes/zeppelin/img/docs-img/lens-logo.png | Bin 0 -> 223040 bytes
.../zeppelin/img/docs-img/lens-result.png | Bin 0 -> 57509 bytes
.../zeppelin/img/docs-img/lens-ui-service.png | Bin 0 -> 87865 bytes
docs/docs/index.md | 2 +-
docs/docs/interpreter/lens.md | 173 +++++++++++++++++++
7 files changed, 174 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/52cdbacf/docs/assets/themes/zeppelin/img/docs-img/lens-interpreter-binding.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/lens-interpreter-binding.png b/docs/assets/themes/zeppelin/img/docs-img/lens-interpreter-binding.png
new file mode 100644
index 0000000..11b96ed
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/lens-interpreter-binding.png differ
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/52cdbacf/docs/assets/themes/zeppelin/img/docs-img/lens-interpreter-setting.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/lens-interpreter-setting.png b/docs/assets/themes/zeppelin/img/docs-img/lens-interpreter-setting.png
new file mode 100644
index 0000000..867e1d6
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/lens-interpreter-setting.png differ
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/52cdbacf/docs/assets/themes/zeppelin/img/docs-img/lens-logo.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/lens-logo.png b/docs/assets/themes/zeppelin/img/docs-img/lens-logo.png
new file mode 100644
index 0000000..2606b4e
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/lens-logo.png differ
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/52cdbacf/docs/assets/themes/zeppelin/img/docs-img/lens-result.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/lens-result.png b/docs/assets/themes/zeppelin/img/docs-img/lens-result.png
new file mode 100644
index 0000000..e5d48f6
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/lens-result.png differ
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/52cdbacf/docs/assets/themes/zeppelin/img/docs-img/lens-ui-service.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/lens-ui-service.png b/docs/assets/themes/zeppelin/img/docs-img/lens-ui-service.png
new file mode 100644
index 0000000..ec223d4
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/lens-ui-service.png differ
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/52cdbacf/docs/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/docs/index.md b/docs/docs/index.md
index 2db242a..8edc871 100644
--- a/docs/docs/index.md
+++ b/docs/docs/index.md
@@ -22,7 +22,7 @@ group: nav-right
* [flink](./interpreter/flink.html)
* [hive](../docs/pleasecontribute.html)
* [ignite](../docs/pleasecontribute.html)
-* [lens](../docs/pleasecontribute.html)
+* [lens](./interpreter/lens.html)
* [md](../docs/pleasecontribute.html)
* [sh](../docs/pleasecontribute.html)
* [spark](./interpreter/spark.html)
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/52cdbacf/docs/docs/interpreter/lens.md
----------------------------------------------------------------------
diff --git a/docs/docs/interpreter/lens.md b/docs/docs/interpreter/lens.md
new file mode 100644
index 0000000..903df7e
--- /dev/null
+++ b/docs/docs/interpreter/lens.md
@@ -0,0 +1,173 @@
+---
+layout: page
+title: "Lens Interpreter"
+description: "Lens user guide"
+group: manual
+---
+{% include JB/setup %}
+
+## Lens Interpreter for Apache Zeppelin
+
+### Overview
+[Apache Lens](https://lens.apache.org/) provides an Unified Analytics interface. Lens aims to cut the Data Analytics silos by providing a single view of data across multiple tiered data stores and optimal execution environment for the analytical query. It seamlessly integrates Hadoop with traditional data warehouses to appear like one.
+
+
+
+### Installing and Running Lens
+In order to use Lens interpreters, you may install Apache Lens in some simple steps:
+
+ 1. Download Lens for latest version from [the ASF](http://www.apache.org/dyn/closer.lua/lens/2.3-beta). Or the older release can be found [in the Archives](http://archive.apache.org/dist/lens/).
+ 2. Before running Lens, you have to set HIVE_HOME and HADOOP_HOME. If you want to get more information about this, please refer to [here](http://lens.apache.org/lenshome/install-and-run.html#Installation). Lens also provides Pseudo Distributed mode. [Lens pseudo-distributed setup](http://lens.apache.org/lenshome/pseudo-distributed-setup.html) is done by using [docker](https://www.docker.com/). Hive server and hadoop daemons are run as separate processes in lens pseudo-distributed setup.
+ 3. Now, you can start lens server (or stop).
+
+ ```
+ ./bin/lens-ctl start (or stop)
+ ```
+
+### Configuring Lens Interpreter
+At the "Interpreters" menu, you can to edit Lens interpreter or create new one. Zeppelin provides these properties for Lens.
+
+ <table class="table-configuration">
+ <tr>
+ <th>Property Name</th>
+ <th>value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>lens.client.dbname</td>
+ <td>default</td>
+ <td>The database schema name</td>
+ </tr>
+ <tr>
+ <td>lens.query.enable.persistent.resultset</td>
+ <td>false</td>
+ <td>Whether to enable persistent resultset for queries. When enabled, server will fetch results from driver, custom format them if any and store in a configured location. The file name of query output is queryhandle-id, with configured extensions</td>
+ </tr>
+ <tr>
+ <td>lens.server.base.url</td>
+ <td>http://hostname:port/lensapi</td>
+ <td>The base url for the lens server. you have to edit "hostname" and "port" that you may use(ex. http://0.0.0.0:9999/lensapi)</td>
+ </tr>
+ <tr>
+ <td>lens.session.cluster.user </td>
+ <td>default</td>
+ <td>Hadoop cluster username</td>
+ </tr>
+ <tr>
+ <td>zeppelin.lens.maxResult</td>
+ <td>1000</td>
+ <td>Max number of rows to display</td>
+ </tr>
+ <tr>
+ <td>zeppelin.lens.maxThreads</td>
+ <td>10</td>
+ <td>If concurrency is true then how many threads?</td>
+ </tr>
+ <tr>
+ <td>zeppelin.lens.run.concurrent</td>
+ <td>true</td>
+ <td>Run concurrent Lens Sessions</td>
+ </tr>
+ <tr>
+ <td>xxx</td>
+ <td>yyy</td>
+ <td>anything else from [Configuring lens server](https://lens.apache.org/admin/config-server.html)</td>
+ </tr>
+ </table>
+
+
+
+### Interpreter Bindging for Zeppelin Notebook
+After configuring Lens interpreter, create your own notebook, then you can bind interpreters like below image.
+
+
+For more interpreter binding information see [here](http://zeppelin.incubator.apache.org/docs/manual/interpreters.html).
+
+### How to use
+You can analyze your data by using [OLAP Cube](http://lens.apache.org/user/olap-cube.html) [QL](http://lens.apache.org/user/cli.html) which is a high level SQL like language to query and describe data sets organized in data cubes.
+You may experience OLAP Cube like this [Video tutorial](https://cwiki.apache.org/confluence/display/LENS/2015/07/13/20+Minute+video+demo+of+Apache+Lens+through+examples).
+As you can see in this video, they are using Lens Client Shell(./bin/lens-cli.sh). All of these functions also can be used on Zeppelin by using Lens interpreter.
+
+<li> Create and Use(Switch) Databases.
+
+ ```
+ create database newDb
+ ```
+
+ ```
+ use newDb
+ ```
+
+<li> Create Storage.
+
+ ```
+ create storage your/path/to/lens/client/examples/resources/db-storage.xml
+ ```
+
+<li> Create Dimensions, Show fields and join-chains of them.
+
+ ```
+ create dimension your/path/to/lens/client/examples/resources/customer.xml
+ ```
+
+ ```
+ dimension show fields customer
+ ```
+
+ ```
+ dimension show joinchains customer
+ ```
+
+<li> Create Caches, Show fields and join-chains of them.
+
+ ```
+ create cube your/path/to/lens/client/examples/resources/sales-cube.xml
+ ```
+
+ ```
+ cube show fields sales
+ ```
+
+ ```
+ cube show joinchains sales
+ ```
+
+<li> Create Dimtables and Fact.
+
+ ```
+ create dimtable your/path/to/lens/client/examples/resources/customer_table.xml
+ ```
+
+ ```
+ create fact your/path/to/lens/client/examples/resources/sales-raw-fact.xml
+ ```
+
+<li> Add partitions to Dimtable and Fact.
+
+ ```
+ dimtable add single-partition --dimtable_name customer_table --storage_name local --path your/path/to/lens/client/examples/resources/customer-local-part.xml
+ ```
+
+ ```
+ fact add partitions --fact_name sales_raw_fact --storage_name local --path your/path/to/lens/client/examples/resources/sales-raw-local-parts.xml
+ ```
+
+<li> Now, you can run queries on cubes.
+
+ ```
+ query execute cube select customer_city_name, product_details.description, product_details.category, product_details.color, store_sales from sales where time_range_in(delivery_time, '2015-04-11-00', '2015-04-13-00')
+ ```
+
+
+ 
+
+These are just examples that provided in advance by Lens. If you want to explore whole tutorials of Lens, see the [tutorial video](https://cwiki.apache.org/confluence/display/LENS/2015/07/13/20+Minute+video+demo+of+Apache+Lens+through+examples).
+
+### Lens UI Service
+Lens also provides web UI service. Once the server starts up, you can open the service on http://serverhost:19999/index.html and browse. You may also check the structure that you made and use query easily here.
+
+ 
+
+
+
+