Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ZEPPELIN-415 document for Apache Kylin Interpreter #1576

Closed
wants to merge 2 commits into from

Conversation

janzhongi
Copy link
Contributor

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

@minahlee
Copy link
Member

minahlee commented Nov 2, 2016

LGTM

@AhyoungRyu
Copy link
Contributor

@janzhongi Thanks for your contribution.
While I'm quickly looking through the docs, it doesn't have Default Value in the conf table. It would be better to provide it for each property i think.

<table class="table-configuration">
  <tr>
    <th>Name</th>
    <th>Default</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>kylin.api.url </td>
    <td>http://localhost:7070/kylin/api/query</td>
    <td>kylin query POST API <br/> The format can be like http://&lt;host&gt;:&lt;port&gt;/kylin/api/query</td>
  </tr>
  <tr>
    <td>kylin.api.user</td>
    <td>ADMIN</td>
    <td>kylin user</td>
  </tr>
  <tr>
    <td>kylin.api.password</td>
    <td>KYLIN</td>
    <td>kylin password</td>
  </tr>
  <tr>
    <td>kylin.query.project</td>
    <td>default</td>
    <td>String, Project to perform query.</td>
  </tr>
  <tr>
    <td>kylin.query.ispartial</td>
    <td>true</td>
    <td>true|false <br/> (@Deprecated since Apache Kylin V1.5) <br/> Whether accept a partial result or not, default be “false”. Set to “false” for production use.</td>
  </tr>
  <tr>
    <td>kylin.query.limit</td>
    <td>5000</td>
    <td>int, Query limit <br/> If limit is set in sql, perPage will be ignored.</td>
  </tr>
  <tr>
    <td>kylin.query.offset</td>
    <td>0</td>
    <td>int, Query offset <br/> If offset is set in sql, curIndex will be ignored.</td>
  </tr>
</table>

You can just copy & paste the above table if you want. I added some markdown escaping for < and >.


## Overview
[Apache Kylin](https://kylin.apache.org/) 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](https://kylin.apache.org/docs15/index.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@janzhongi 15 in docs15 is the version of Kylin, right? If so, do we need to set the version in this link?
Seems https://kylin.apache.org/latest/index.html doesn't work... What do you think? :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AhyoungRyu Thank you for your review, for 'doc15' you mentioned, now 'doc15' is a stable link for kylin, we do not have other link like 'latest' now, if there's update on this in future, I will also update on Zeppelin side.

And for 'Default Value', if you check again you can see first column represents property name, and sceond column represents default value,is that what you mean? thanks!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@janzhongi I see. Thanks for the explanation.
Currently the second column is the "description" for the property name, not "default value". I mean we need three column "Property name", "Default value" and "Description".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, thank you for you reminding!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated code as your suggestion, thank you 👍

@AhyoungRyu
Copy link
Contributor

@janzhongi Thanks for your prompt update! Changes are looks good to me.
Merge if there are no more discussions.

@asfgit asfgit closed this in c9adf71 Nov 14, 2016
1ambda pushed a commit to 1ambda/zeppelin that referenced this pull request Nov 17, 2016
This is document for Apache Kylin Interpreter for Apache Zeppelin

Documentation

Done

https://issues.apache.org/jira/browse/ZEPPELIN-415

* 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 apache#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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants