zeppelin/docs/interpreter/kylin.md
zhongjian c9adf7161f ZEPPELIN-415 document for Apache Kylin Interpreter
### What is this PR for?
This is document for Apache Kylin Interpreter for Apache Zeppelin

### What type of PR is it?
Documentation

### Todos
Done

### What is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-415

### How should this be tested?

### Screenshots (if appropriate)

### Questions:
* Does the licenses files need update?
   No
* Is there breaking changes for older versions?
   No
* Does this needs documentation?
   This is document

Author: zhongjian <jiatuer@163.com>
Author: Jason <jiatuer@163.com>

Closes #1576 from janzhongi/master and squashes the following commits:

5464006 [zhongjian] add default value for kylin query api config
c26fa77 [Jason] ZEPPELIN-415 document for Apache Kylin Interpreter
2016-11-14 06:59:06 +01:00

2.8 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.
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 to select the kylin interpreter and then input sql.

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