zeppelin/docs/interpreter/kylin.md
Yiming Liu 75441540fd [ZEPPELIN-1512] Support Kylin project name in interpreter runtime
### What is this PR for?

Currently, the parameter "project" is defined with "kylin.query.project" in properties. It's not convenience when query Kylin among different projects. May I propose introducing %kylin(project_name) at the interpreter runtime? If not set, the default project will work, otherwise, will use explicit project_name for the query request.
### What type of PR is it?

Improvement
### Todos

DONE
### What is the Jira issue?

https://issues.apache.org/jira/browse/ZEPPELIN-1512
### How should this be tested?

%kylin select ...
%kylin(new_project) select ....
### Screenshots (if appropriate)
### Questions:
- Does the licenses files need update?
  No.
- Is there breaking changes for older versions?
  No.
- Does this needs documentation?
  Will do later.

Author: Yiming Liu <liuyiming.vip@gmail.com>

Closes #1477 from yiming187/ZEPPELIN-1512 and squashes the following commits:

b58ee7f [Yiming Liu] [ZEPPELIN-1512] Support Kylin project name in interpreter runtime
2016-12-14 12:57:12 +09:00

3 KiB

layout title description group
page Apache Kylin Interpreter for Apache Zeppelin Apache Kylin™ is an open source Distributed Analytics Engine designed to provide SQL interface and multi-dimensional analysis (OLAP) on Hadoop supporting extremely large datasets, original contributed from eBay Inc. . interpreter

{% include JB/setup %}

Apache Kylin Interpreter for Apache Zeppelin

Overview

Apache Kylin is an open source Distributed Analytics Engine designed to provide SQL interface and multi-dimensional analysis (OLAP) on Hadoop supporting extremely large datasets, original contributed from eBay Inc. The interpreter assumes that Apache Kylin has been installed and you can connect to Apache Kylin from the machine Apache Zeppelin is installed.
To get start with Apache Kylin, please see Apache Kylin Quickstart.

Configuration

Name Default Description
kylin.api.url http://localhost:7070/kylin/api/query kylin query POST API
The format can be like http://<host>:<port>/kylin/api/query
kylin.api.user ADMIN kylin user
kylin.api.password KYLIN kylin password
kylin.query.project learn_kylin String, Project to perform query. Could update at notebook level
kylin.query.ispartial true true|false
(@Deprecated since Apache Kylin V1.5)
Whether accept a partial result or not, default be “false”. Set to “false” for production use.
kylin.query.limit 5000 int, Query limit
If limit is set in sql, perPage will be ignored.
kylin.query.offset 0 int, Query offset
If offset is set in sql, curIndex will be ignored.

Using the Apache Kylin Interpreter

In a paragraph, use %kylin(project_name) to select the kylin interpreter, project name and then input sql. If no project name defined, will use the default project name from the above configuration.

%kylin(learn_project)
select count(*) from kylin_sales group by part_dt