Update doc layout
Project: http://git-wip-us.apache.org/repos/asf/kylin/repo Commit: http://git-wip-us.apache.org/repos/asf/kylin/commit/c1af8222 Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/c1af8222 Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/c1af8222 Branch: refs/heads/document Commit: c1af8222f1b7d8196a2065e1cf3adfc638730cb8 Parents: 2291fce Author: shaofengshi <shaofeng...@apache.org> Authored: Thu Aug 31 18:57:47 2017 +0800 Committer: shaofengshi <shaofeng...@apache.org> Committed: Thu Aug 31 18:57:47 2017 +0800 ---------------------------------------------------------------------- website/_data/docs21.yml | 22 ++++++---- .../howto/howto_build_cube_with_restapi.md | 2 +- website/_docs21/howto/howto_cleanup_storage.md | 2 +- website/_docs21/howto/howto_jdbc.md | 2 +- website/_docs21/howto/howto_ldap_and_sso.md | 2 +- .../_docs21/howto/howto_update_coprocessor.md | 2 +- website/_docs21/howto/howto_use_beeline.md | 2 +- website/_docs21/howto/howto_use_restapi.md | 44 ++++++++++++++++++++ website/_docs21/index.md | 16 +++---- website/_docs21/tutorial/acl.md | 2 +- website/_docs21/tutorial/create_cube.md | 2 +- website/_docs21/tutorial/cube_build_job.md | 2 +- .../_docs21/tutorial/cube_build_performance.md | 2 +- website/_docs21/tutorial/flink.md | 2 +- website/_docs21/tutorial/hue.md | 2 +- website/_docs21/tutorial/microstrategy.md | 2 +- website/_docs21/tutorial/squirrel.md | 2 +- website/_docs21/tutorial/web.md | 2 +- 18 files changed, 80 insertions(+), 32 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_data/docs21.yml ---------------------------------------------------------------------- diff --git a/website/_data/docs21.yml b/website/_data/docs21.yml index 3f3380f..90acd70 100644 --- a/website/_data/docs21.yml +++ b/website/_data/docs21.yml @@ -19,11 +19,11 @@ docs: - index - release_notes + - gettingstarted/concepts + - gettingstarted/terminology - gettingstarted/faq - gettingstarted/events - gettingstarted/best_practices - - gettingstarted/terminology - - gettingstarted/concepts - title: Installation docs: @@ -37,25 +37,29 @@ - title: Tutorial docs: - tutorial/kylin_sample + - tutorial/web - tutorial/create_cube - tutorial/cube_build_job - - tutorial/cube_spark - tutorial/acl - - tutorial/web + - tutorial/cube_spark + - tutorial/cube_build_performance + +- title: Integration + docs: + - tutorial/odbc + - howto/howto_jdbc - tutorial/tableau - tutorial/tableau_91 - tutorial/powerbi - - tutorial/odbc - - tutorial/flink + - tutorial/microstrategy - tutorial/squirrel - - tutorial/cube_build_performance + - tutorial/flink - tutorial/hue - title: How To docs: - - howto/howto_build_cube_with_restapi - - howto/howto_use_restapi_in_js - howto/howto_use_restapi + - howto/howto_build_cube_with_restapi - howto/howto_optimize_cubes - howto/howto_optimize_build - howto/howto_backup_metadata http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/howto/howto_build_cube_with_restapi.md ---------------------------------------------------------------------- diff --git a/website/_docs21/howto/howto_build_cube_with_restapi.md b/website/_docs21/howto/howto_build_cube_with_restapi.md index 9092afe..8808b7b 100644 --- a/website/_docs21/howto/howto_build_cube_with_restapi.md +++ b/website/_docs21/howto/howto_build_cube_with_restapi.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Build Cube with RESTful API +title: Build Cube with API categories: howto permalink: /docs21/howto/howto_build_cube_with_restapi.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/howto/howto_cleanup_storage.md ---------------------------------------------------------------------- diff --git a/website/_docs21/howto/howto_cleanup_storage.md b/website/_docs21/howto/howto_cleanup_storage.md index 323e138..f488040 100644 --- a/website/_docs21/howto/howto_cleanup_storage.md +++ b/website/_docs21/howto/howto_cleanup_storage.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Cleanup Storage (HDFS & HBase) +title: Cleanup Storage categories: howto permalink: /docs21/howto/howto_cleanup_storage.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/howto/howto_jdbc.md ---------------------------------------------------------------------- diff --git a/website/_docs21/howto/howto_jdbc.md b/website/_docs21/howto/howto_jdbc.md index f2fd6f0..4885a84 100644 --- a/website/_docs21/howto/howto_jdbc.md +++ b/website/_docs21/howto/howto_jdbc.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Use JDBC Driver +title: Kylin JDBC Driver categories: howto permalink: /docs21/howto/howto_jdbc.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/howto/howto_ldap_and_sso.md ---------------------------------------------------------------------- diff --git a/website/_docs21/howto/howto_ldap_and_sso.md b/website/_docs21/howto/howto_ldap_and_sso.md index 5e7ca29..8d6bd47 100644 --- a/website/_docs21/howto/howto_ldap_and_sso.md +++ b/website/_docs21/howto/howto_ldap_and_sso.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Enable Security with LDAP and SSO +title: Secure with LDAP and SSO categories: howto permalink: /docs21/howto/howto_ldap_and_sso.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/howto/howto_update_coprocessor.md ---------------------------------------------------------------------- diff --git a/website/_docs21/howto/howto_update_coprocessor.md b/website/_docs21/howto/howto_update_coprocessor.md index 87805eb..99f5d0c 100644 --- a/website/_docs21/howto/howto_update_coprocessor.md +++ b/website/_docs21/howto/howto_update_coprocessor.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: How to Update HBase Coprocessor +title: Update Coprocessor categories: howto permalink: /docs21/howto/howto_update_coprocessor.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/howto/howto_use_beeline.md ---------------------------------------------------------------------- diff --git a/website/_docs21/howto/howto_use_beeline.md b/website/_docs21/howto/howto_use_beeline.md index 2c4b29c..c730cc1 100644 --- a/website/_docs21/howto/howto_use_beeline.md +++ b/website/_docs21/howto/howto_use_beeline.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Use Beeline for Hive Commands +title: Use Beeline for Hive categories: howto permalink: /docs21/howto/howto_use_beeline.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/howto/howto_use_restapi.md ---------------------------------------------------------------------- diff --git a/website/_docs21/howto/howto_use_restapi.md b/website/_docs21/howto/howto_use_restapi.md index afdad37..f5b5cd1 100644 --- a/website/_docs21/howto/howto_use_restapi.md +++ b/website/_docs21/howto/howto_use_restapi.md @@ -1111,3 +1111,47 @@ This API is specific for stream cube's building; #### Path variable * cubeName - `required` `string` Cube name + + + +## Use RESTful API in Javascript + +Keypoints of call Kylin RESTful API in web page are: + +1. Add basic access authorization info in http headers. + +2. Use proper request type and data synax. + +Kylin security is based on basic access authorization, if you want to use API in your javascript, you need to add authorization info in http headers; for example: + +``` +$.ajaxSetup({ + headers: { 'Authorization': "Basic eWFu**********X***ZA==", 'Content-Type': 'application/json;charset=utf-8' } // use your own authorization code here + }); + var request = $.ajax({ + url: "http://hostname/kylin/api/query";, + type: "POST", + data: '{"sql":"select count(*) from SUMMARY;","offset":0,"limit":50000,"acceptPartial":true,"project":"test"}', + dataType: "json" + }); + request.done(function( msg ) { + alert(msg); + }); + request.fail(function( jqXHR, textStatus ) { + alert( "Request failed: " + textStatus ); + }); + +``` + +To generate your authorization code, download and import "jquery.base64.js" from [https://github.com/yckart/jquery.base64.js](https://github.com/yckart/jquery.base64.js)). + +``` +var authorizationCode = $.base64('encode', 'NT_USERNAME' + ":" + 'NT_PASSWORD'); + +$.ajaxSetup({ + headers: { + 'Authorization': "Basic " + authorizationCode, + 'Content-Type': 'application/json;charset=utf-8' + } +}); +``` \ No newline at end of file http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/index.md ---------------------------------------------------------------------- diff --git a/website/_docs21/index.md b/website/_docs21/index.md index 570c0a7..12bf1b1 100644 --- a/website/_docs21/index.md +++ b/website/_docs21/index.md @@ -28,13 +28,13 @@ Installation & Setup Tutorial ------------ 1. [Quick Start with Sample Cube](tutorial/kylin_sample.html) -2. [Cube Creation](tutorial/create_cube.html) +2. [Web Interface](tutorial/web.html) +3. [Cube Wizard](tutorial/create_cube.html) 3. [Cube Build and Job Monitoring](tutorial/cube_build_job.html) -4. [Web Interface](tutorial/web.html) 5. [SQL reference: by Apache Calcite](http://calcite.apache.org/docs/reference.html) 6. [Build Cube with Streaming Data](tutorial/cube_streaming.html) 7. [Build Cube with Spark Engine (beta)](tutorial/cube_spark.html) -8. [Cube Build Tuning Step by Step](tutorial/cube_build_performance.html) +8. [Cube Build Tuning](tutorial/cube_build_performance.html) 9. [Enable Query Pushdown](tutorial/query_pushdown.html) @@ -45,10 +45,10 @@ Connectivity and APIs 2. [JDBC driver](howto/howto_jdbc.html) 3. [RESTful API list](howto/howto_use_restapi.html) 4. [Build cube with RESTful API](howto/howto_build_cube_with_restapi.html) -5. [Call RESTful API in Javascript](howto/howto_use_restapi_in_js.html) -6. [Connect from MS Excel and PowerBI](tutorial/powerbi.html) -7. [Connect from Tableau 8](tutorial/tableau.html) -8. [Connect from Tableau 9](tutorial/tableau_91.html) +5. [Connect from MS Excel and PowerBI](tutorial/powerbi.html) +6. [Connect from Tableau 8](tutorial/tableau.html) +7. [Connect from Tableau 9](tutorial/tableau_91.html) +8. [Connect from MicroStrategy](tutorial/microstrategy.html) 9. [Connect from SQuirreL](tutorial/squirrel.html) 10. [Connect from Apache Flink](tutorial/flink.html) 11. [Connect from Apache Hue](tutorial/hue.html) @@ -56,7 +56,7 @@ Connectivity and APIs Operations ------------ 1. [Backup/restore Kylin metadata](howto/howto_backup_metadata.html) -2. [Cleanup storage (HDFS & HBase)](howto/howto_cleanup_storage.html) +2. [Cleanup storage](howto/howto_cleanup_storage.html) 3. [Upgrade from old version](howto/howto_upgrade.html) http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/tutorial/acl.md ---------------------------------------------------------------------- diff --git a/website/_docs21/tutorial/acl.md b/website/_docs21/tutorial/acl.md index b3b7fdf..0485e94 100644 --- a/website/_docs21/tutorial/acl.md +++ b/website/_docs21/tutorial/acl.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Kylin Cube Permission +title: Cube Permission categories: tutorial permalink: /docs21/tutorial/acl.html since: v0.7.1 http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/tutorial/create_cube.md ---------------------------------------------------------------------- diff --git a/website/_docs21/tutorial/create_cube.md b/website/_docs21/tutorial/create_cube.md index c86984f..52fa6fd 100644 --- a/website/_docs21/tutorial/create_cube.md +++ b/website/_docs21/tutorial/create_cube.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Kylin Cube Creation +title: Cube Wizard categories: tutorial permalink: /docs21/tutorial/create_cube.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/tutorial/cube_build_job.md ---------------------------------------------------------------------- diff --git a/website/_docs21/tutorial/cube_build_job.md b/website/_docs21/tutorial/cube_build_job.md index c042f73..63a5210 100644 --- a/website/_docs21/tutorial/cube_build_job.md +++ b/website/_docs21/tutorial/cube_build_job.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Kylin Cube Build and Job Monitoring +title: Cube Build and Job Monitoring categories: tutorial permalink: /docs21/tutorial/cube_build_job.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/tutorial/cube_build_performance.md ---------------------------------------------------------------------- diff --git a/website/_docs21/tutorial/cube_build_performance.md b/website/_docs21/tutorial/cube_build_performance.md index 7169488..8be4bda 100755 --- a/website/_docs21/tutorial/cube_build_performance.md +++ b/website/_docs21/tutorial/cube_build_performance.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Cube Build Tuning Step by Step +title: Cube Build Tuning categories: tutorial permalink: /docs21/tutorial/cube_build_performance.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/tutorial/flink.md ---------------------------------------------------------------------- diff --git a/website/_docs21/tutorial/flink.md b/website/_docs21/tutorial/flink.md index 3390fd7..fdd0d87 100644 --- a/website/_docs21/tutorial/flink.md +++ b/website/_docs21/tutorial/flink.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Connect from Apache Flink +title: Apache Flink categories: tutorial permalink: /docs21/tutorial/flink.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/tutorial/hue.md ---------------------------------------------------------------------- diff --git a/website/_docs21/tutorial/hue.md b/website/_docs21/tutorial/hue.md index fa00d82..84dea6d 100755 --- a/website/_docs21/tutorial/hue.md +++ b/website/_docs21/tutorial/hue.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Connect from Apache Hue +title: Apache Hue categories: tutorial permalink: /docs21/tutorial/hue.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/tutorial/microstrategy.md ---------------------------------------------------------------------- diff --git a/website/_docs21/tutorial/microstrategy.md b/website/_docs21/tutorial/microstrategy.md index 67ec4c3..c20604d 100644 --- a/website/_docs21/tutorial/microstrategy.md +++ b/website/_docs21/tutorial/microstrategy.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Integration with MicroStrategy 10.X +title: MicroStrategy categories: tutorial permalink: /docs21/tutorial/microstrategy.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/tutorial/squirrel.md ---------------------------------------------------------------------- diff --git a/website/_docs21/tutorial/squirrel.md b/website/_docs21/tutorial/squirrel.md index 6b410d1..d3ba148 100644 --- a/website/_docs21/tutorial/squirrel.md +++ b/website/_docs21/tutorial/squirrel.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Connect from SQuirreL +title: SQuirreL categories: tutorial permalink: /docs21/tutorial/squirrel.html --- http://git-wip-us.apache.org/repos/asf/kylin/blob/c1af8222/website/_docs21/tutorial/web.md ---------------------------------------------------------------------- diff --git a/website/_docs21/tutorial/web.md b/website/_docs21/tutorial/web.md index 44758b2..a0d7fd1 100644 --- a/website/_docs21/tutorial/web.md +++ b/website/_docs21/tutorial/web.md @@ -1,6 +1,6 @@ --- layout: docs21 -title: Kylin Web Interface +title: Web Interface categories: tutorial permalink: /docs21/tutorial/web.html ---
