Modified: kylin/site/docs/howto/howto_use_restapi.html URL: http://svn.apache.org/viewvc/kylin/site/docs/howto/howto_use_restapi.html?rev=1869215&r1=1869214&r2=1869215&view=diff ============================================================================== --- kylin/site/docs/howto/howto_use_restapi.html (original) +++ kylin/site/docs/howto/howto_use_restapi.html Thu Oct 31 14:08:19 2019 @@ -6369,6 +6369,7 @@ var _hmt = _hmt || []; </li> <li>CUBE <ul> + <li><a href="#create-cube">Create cube</a></li> <li><a href="#list-cubes">List cubes</a></li> <li><a href="#get-cube">Get cube</a></li> <li><a href="#get-cube-descriptor">Get cube descriptor (dimension, measure info, etc)</a></li> @@ -6380,6 +6381,13 @@ var _hmt = _hmt || []; <li><a href="#delete-segment">Delete segment</a></li> </ul> </li> + <li>MODEL + <ul> + <li><a href="#create-model">Create model</a></li> + <li><a href="#get-modeldescdata">Get modelDescData</a></li> + <li><a href="#delete-model">Delete model</a></li> + </ul> + </li> <li>JOB <ul> <li><a href="#resume-job">Resume job</a></li> @@ -6677,6 +6685,40 @@ python -c "import base64; print base64.s <hr /> +<h2 id="create-cube">Create cube</h2> +<p><code class="highlighter-rouge">POST /kylin/api/cubes</code></p> + +<h4 id="request-body-1">Request Body</h4> +<ul> + <li>cubeDescData - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> cubeDescData to create</li> + <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> cubeName to create</li> + <li>projectName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> projectName to which cube belongs</li> +</ul> + +<h4 id="request-sample-1">Request Sample</h4> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w"> +</span><span class="nt">"cubeDescData"</span><span class="p">:</span><span class="s2">"{\"uuid\": \"0ef9b7a8-3929-4dff-b59d-2100aadc8dbf\",\"last_modified\": 0,\"version\": \"3.0.0.20500\",\"name\": \"kylin_test_cube\",\"is_draft\": false,\"model_name\": \"kylin_sales_model\",\"description\": \"\",\"null_string\": null,\"dimensions\": [{\"name\": \"TRANS_ID\",\"table\": \"KYLIN_SALES\",\"column\": \"TRANS_ID\",\"derived\": null},{\"name\": \"YEAR_BEG_DT\",\"table\": \"KYLIN_CAL_DT\",\"column\": null,\"derived\": [\"YEAR_BEG_DT\"]},{\"name\": \"MONTH_BEG_DT\",\"table\": \"KYLIN_CAL_DT\",\"column\": null,\"derived\": [\"MONTH_BEG_DT\"]},{\"name\": \"WEEK_BEG_DT\",\"table\": \"KYLIN_CAL_DT\",\"column\": null,\"derived\": [\"WEEK_BEG_DT\"]},{\"name\": \"USER_DEFINED_FIELD1\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": null,\"derived\": [\"USER_DEFINED_FIELD1\"]},{\"name\": \"USER_DEFINED_FIELD3\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": null,\"derived\": [\"USER_DEFIN ED_FIELD3\"]},{\"name\": \"META_CATEG_NAME\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": \"META_CATEG_NAME\",\"derived\": null},{\"name\": \"CATEG_LVL2_NAME\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": \"CATEG_LVL2_NAME\",\"derived\": null},{\"name\": \"CATEG_LVL3_NAME\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": \"CATEG_LVL3_NAME\",\"derived\": null},{\"name\": \"LSTG_FORMAT_NAME\",\"table\": \"KYLIN_SALES\",\"column\": \"LSTG_FORMAT_NAME\",\"derived\": null},{\"name\": \"SELLER_ID\",\"table\": \"KYLIN_SALES\",\"column\": \"SELLER_ID\",\"derived\": null},{\"name\": \"BUYER_ID\",\"table\": \"KYLIN_SALES\",\"column\": \"BUYER_ID\",\"derived\": null},{\"name\": \"ACCOUNT_BUYER_LEVEL\",\"table\": \"BUYER_ACCOUNT\",\"column\": \"ACCOUNT_BUYER_LEVEL\",\"derived\": null},{\"name\": \"ACCOUNT_SELLER_LEVEL\",\"table\": \"SELLER_ACCOUNT\",\"column\": \"ACCOUNT_SELLER_LEVEL\",\"derived\": null},{\"name\": \"BUYER_COUNTRY\",\"table\": \"BUYER_ACCOUNT\",\"column\": \"A CCOUNT_COUNTRY\",\"derived\": null},{\"name\": \"SELLER_COUNTRY\",\"table\": \"SELLER_ACCOUNT\",\"column\": \"ACCOUNT_COUNTRY\",\"derived\": null},{\"name\": \"BUYER_COUNTRY_NAME\",\"table\": \"BUYER_COUNTRY\",\"column\": \"NAME\",\"derived\": null},{\"name\": \"SELLER_COUNTRY_NAME\",\"table\": \"SELLER_COUNTRY\",\"column\": \"NAME\",\"derived\": null},{\"name\": \"OPS_USER_ID\",\"table\": \"KYLIN_SALES\",\"column\": \"OPS_USER_ID\",\"derived\": null},{\"name\": \"OPS_REGION\",\"table\": \"KYLIN_SALES\",\"column\": \"OPS_REGION\",\"derived\": null}],\"measures\": [{\"name\": \"GMV_SUM\",\"function\": {\"expression\": \"SUM\",\"parameter\": {\"type\": \"column\",\"value\": \"KYLIN_SALES.PRICE\"},\"returntype\": \"decimal(19,4)\"}},{\"name\": \"BUYER_LEVEL_SUM\",\"function\": {\"expression\": \"SUM\",\"parameter\": {\"type\": \"column\",\"value\": \"BUYER_ACCOUNT.ACCOUNT_BUYER_LEVEL\"},\"returntype\": \"bigint\"}},{\"name\": \"SELLER_LEVEL_SUM\",\"function\": {\"expression\": \"SUM\", \"parameter\": {\"type\": \"column\",\"value\": \"SELLER_ACCOUNT.ACCOUNT_SELLER_LEVEL\"},\"returntype\": \"bigint\"}},{\"name\": \"TRANS_CNT\",\"function\": {\"expression\": \"COUNT\",\"parameter\": {\"type\": \"constant\",\"value\": \"1\"},\"returntype\": \"bigint\"}},{\"name\": \"SELLER_CNT_HLL\",\"function\": {\"expression\": \"COUNT_DISTINCT\",\"parameter\": {\"type\": \"column\",\"value\": \"KYLIN_SALES.SELLER_ID\"},\"returntype\": \"hllc(10)\"}},{\"name\": \"TOP_SELLER\",\"function\": {\"expression\": \"TOP_N\",\"parameter\": {\"type\": \"column\",\"value\": \"KYLIN_SALES.PRICE\",\"next_parameter\": {\"type\": \"column\",\"value\": \"KYLIN_SALES.SELLER_ID\"}},\"returntype\": \"topn(100)\",\"configuration\": {\"topn.encoding.KYLIN_SALES.SELLER_ID\": \"dict\",\"topn.encoding_version.KYLIN_SALES.SELLER_ID\": \"1\"}}}],\"rowkey\": {\"rowkey_columns\": [{\"column\": \"KYLIN_SALES.BUYER_ID\",\"encoding\": \"integer:4\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYL IN_SALES.SELLER_ID\",\"encoding\": \"integer:4\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.TRANS_ID\",\"encoding\": \"integer:4\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.PART_DT\",\"encoding\": \"date\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.LEAF_CATEG_ID\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_CATEGORY_GROUPINGS.META_CATEG_NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL2_NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL3_NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"BUYER_ACCOUNT.ACCOUNT_BUYER_LEVEL\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"SELLER_ACCOUNT.ACCOUNT_SELLER_LEVEL\",\"encoding\": \"di ct\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"BUYER_ACCOUNT.ACCOUNT_COUNTRY\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"SELLER_ACCOUNT.ACCOUNT_COUNTRY\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"BUYER_COUNTRY.NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"SELLER_COUNTRY.NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.LSTG_FORMAT_NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.LSTG_SITE_ID\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.OPS_USER_ID\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.OPS_REGION\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false}]},\"hbase_mapping\": {\"column_family\": [{\"name\": \"F1 \",\"columns\": [{\"qualifier\": \"M\",\"measure_refs\": [\"GMV_SUM\",\"BUYER_LEVEL_SUM\",\"SELLER_LEVEL_SUM\",\"TRANS_CNT\"]}]},{\"name\": \"F2\",\"columns\": [{\"qualifier\": \"M\",\"measure_refs\": [\"SELLER_CNT_HLL\",\"TOP_SELLER\"]}]}]},\"aggregation_groups\": [{\"includes\": [\"KYLIN_SALES.PART_DT\",\"KYLIN_CATEGORY_GROUPINGS.META_CATEG_NAME\",\"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL2_NAME\",\"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL3_NAME\",\"KYLIN_SALES.LEAF_CATEG_ID\",\"KYLIN_SALES.LSTG_FORMAT_NAME\",\"KYLIN_SALES.LSTG_SITE_ID\",\"KYLIN_SALES.OPS_USER_ID\",\"KYLIN_SALES.OPS_REGION\",\"BUYER_ACCOUNT.ACCOUNT_BUYER_LEVEL\",\"SELLER_ACCOUNT.ACCOUNT_SELLER_LEVEL\",\"BUYER_ACCOUNT.ACCOUNT_COUNTRY\",\"SELLER_ACCOUNT.ACCOUNT_COUNTRY\",\"BUYER_COUNTRY.NAME\",\"SELLER_COUNTRY.NAME\"],\"select_rule\": {\"hierarchy_dims\": [[\"KYLIN_CATEGORY_GROUPINGS.META_CATEG_NAME\",\"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL2_NAME\",\"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL3_NAME\",\"KYLIN_SALES.LEAF_CATEG_ID\"]],\"mand atory_dims\": [\"KYLIN_SALES.PART_DT\"],\"joint_dims\": [[\"BUYER_ACCOUNT.ACCOUNT_COUNTRY\",\"BUYER_COUNTRY.NAME\"],[\"SELLER_ACCOUNT.ACCOUNT_COUNTRY\",\"SELLER_COUNTRY.NAME\"],[\"BUYER_ACCOUNT.ACCOUNT_BUYER_LEVEL\",\"SELLER_ACCOUNT.ACCOUNT_SELLER_LEVEL\"],[\"KYLIN_SALES.LSTG_FORMAT_NAME\",\"KYLIN_SALES.LSTG_SITE_ID\"],[\"KYLIN_SALES.OPS_USER_ID\",\"KYLIN_SALES.OPS_REGION\"]]}}],\"signature\": null,\"notify_list\": [],\"status_need_notify\": [],\"partition_date_start\": 1325376000000,\"partition_date_end\": 3153600000000,\"auto_merge_time_ranges\": [],\"volatile_range\": 0,\"retention_range\": 0,\"engine_type\": 2,\"storage_type\": 2,\"override_kylin_properties\": {\"kylin.cube.aggrgroup.is-mandatory-only-valid\": \"true\",\"kylin.engine.spark.rdd-partition-cut-mb\": \"500\"},\"cuboid_black_list\": [],\"parent_forward\": 3,\"mandatory_dimension_set_list\": [],\"snapshot_table_desc_list\": []}"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"cubeName"</span><span class="p">:</span><span class="s2">"kylin_test_cube"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"project"</span><span class="p">:</span><span class="s2">"learn_kylin"</span><span class="w"> +</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + +<h4 id="response-sample-3">Response Sample</h4> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w"> +</span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7b3faf69-eca8-cc5f-25f9-49b0f0b5d404"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"cubeName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"kylin_test_cube"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"cubeDescData"</span><span class="p">:</span><span class="s2">"{\"uuid\": \"0ef9b7a8-3929-4dff-b59d-2100aadc8dbf\",\"last_modified\": 0,\"version\": \"3.0.0.20500\",\"name\": \"kylin_test_cube\",\"is_draft\": false,\"model_name\": \"kylin_sales_model\",\"description\": \"\",\"null_string\": null,\"dimensions\": [{\"name\": \"TRANS_ID\",\"table\": \"KYLIN_SALES\",\"column\": \"TRANS_ID\",\"derived\": null},{\"name\": \"YEAR_BEG_DT\",\"table\": \"KYLIN_CAL_DT\",\"column\": null,\"derived\": [\"YEAR_BEG_DT\"]},{\"name\": \"MONTH_BEG_DT\",\"table\": \"KYLIN_CAL_DT\",\"column\": null,\"derived\": [\"MONTH_BEG_DT\"]},{\"name\": \"WEEK_BEG_DT\",\"table\": \"KYLIN_CAL_DT\",\"column\": null,\"derived\": [\"WEEK_BEG_DT\"]},{\"name\": \"USER_DEFINED_FIELD1\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": null,\"derived\": [\"USER_DEFINED_FIELD1\"]},{\"name\": \"USER_DEFINED_FIELD3\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": null,\"derived\": [\"USER_DEFIN ED_FIELD3\"]},{\"name\": \"META_CATEG_NAME\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": \"META_CATEG_NAME\",\"derived\": null},{\"name\": \"CATEG_LVL2_NAME\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": \"CATEG_LVL2_NAME\",\"derived\": null},{\"name\": \"CATEG_LVL3_NAME\",\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"column\": \"CATEG_LVL3_NAME\",\"derived\": null},{\"name\": \"LSTG_FORMAT_NAME\",\"table\": \"KYLIN_SALES\",\"column\": \"LSTG_FORMAT_NAME\",\"derived\": null},{\"name\": \"SELLER_ID\",\"table\": \"KYLIN_SALES\",\"column\": \"SELLER_ID\",\"derived\": null},{\"name\": \"BUYER_ID\",\"table\": \"KYLIN_SALES\",\"column\": \"BUYER_ID\",\"derived\": null},{\"name\": \"ACCOUNT_BUYER_LEVEL\",\"table\": \"BUYER_ACCOUNT\",\"column\": \"ACCOUNT_BUYER_LEVEL\",\"derived\": null},{\"name\": \"ACCOUNT_SELLER_LEVEL\",\"table\": \"SELLER_ACCOUNT\",\"column\": \"ACCOUNT_SELLER_LEVEL\",\"derived\": null},{\"name\": \"BUYER_COUNTRY\",\"table\": \"BUYER_ACCOUNT\",\"column\": \"A CCOUNT_COUNTRY\",\"derived\": null},{\"name\": \"SELLER_COUNTRY\",\"table\": \"SELLER_ACCOUNT\",\"column\": \"ACCOUNT_COUNTRY\",\"derived\": null},{\"name\": \"BUYER_COUNTRY_NAME\",\"table\": \"BUYER_COUNTRY\",\"column\": \"NAME\",\"derived\": null},{\"name\": \"SELLER_COUNTRY_NAME\",\"table\": \"SELLER_COUNTRY\",\"column\": \"NAME\",\"derived\": null},{\"name\": \"OPS_USER_ID\",\"table\": \"KYLIN_SALES\",\"column\": \"OPS_USER_ID\",\"derived\": null},{\"name\": \"OPS_REGION\",\"table\": \"KYLIN_SALES\",\"column\": \"OPS_REGION\",\"derived\": null}],\"measures\": [{\"name\": \"GMV_SUM\",\"function\": {\"expression\": \"SUM\",\"parameter\": {\"type\": \"column\",\"value\": \"KYLIN_SALES.PRICE\"},\"returntype\": \"decimal(19,4)\"}},{\"name\": \"BUYER_LEVEL_SUM\",\"function\": {\"expression\": \"SUM\",\"parameter\": {\"type\": \"column\",\"value\": \"BUYER_ACCOUNT.ACCOUNT_BUYER_LEVEL\"},\"returntype\": \"bigint\"}},{\"name\": \"SELLER_LEVEL_SUM\",\"function\": {\"expression\": \"SUM\", \"parameter\": {\"type\": \"column\",\"value\": \"SELLER_ACCOUNT.ACCOUNT_SELLER_LEVEL\"},\"returntype\": \"bigint\"}},{\"name\": \"TRANS_CNT\",\"function\": {\"expression\": \"COUNT\",\"parameter\": {\"type\": \"constant\",\"value\": \"1\"},\"returntype\": \"bigint\"}},{\"name\": \"SELLER_CNT_HLL\",\"function\": {\"expression\": \"COUNT_DISTINCT\",\"parameter\": {\"type\": \"column\",\"value\": \"KYLIN_SALES.SELLER_ID\"},\"returntype\": \"hllc(10)\"}},{\"name\": \"TOP_SELLER\",\"function\": {\"expression\": \"TOP_N\",\"parameter\": {\"type\": \"column\",\"value\": \"KYLIN_SALES.PRICE\",\"next_parameter\": {\"type\": \"column\",\"value\": \"KYLIN_SALES.SELLER_ID\"}},\"returntype\": \"topn(100)\",\"configuration\": {\"topn.encoding.KYLIN_SALES.SELLER_ID\": \"dict\",\"topn.encoding_version.KYLIN_SALES.SELLER_ID\": \"1\"}}}],\"rowkey\": {\"rowkey_columns\": [{\"column\": \"KYLIN_SALES.BUYER_ID\",\"encoding\": \"integer:4\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYL IN_SALES.SELLER_ID\",\"encoding\": \"integer:4\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.TRANS_ID\",\"encoding\": \"integer:4\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.PART_DT\",\"encoding\": \"date\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.LEAF_CATEG_ID\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_CATEGORY_GROUPINGS.META_CATEG_NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL2_NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL3_NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"BUYER_ACCOUNT.ACCOUNT_BUYER_LEVEL\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"SELLER_ACCOUNT.ACCOUNT_SELLER_LEVEL\",\"encoding\": \"di ct\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"BUYER_ACCOUNT.ACCOUNT_COUNTRY\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"SELLER_ACCOUNT.ACCOUNT_COUNTRY\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"BUYER_COUNTRY.NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"SELLER_COUNTRY.NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.LSTG_FORMAT_NAME\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.LSTG_SITE_ID\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.OPS_USER_ID\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false},{\"column\": \"KYLIN_SALES.OPS_REGION\",\"encoding\": \"dict\",\"encoding_version\": 1,\"isShardBy\": false}]},\"hbase_mapping\": {\"column_family\": [{\"name\": \"F1 \",\"columns\": [{\"qualifier\": \"M\",\"measure_refs\": [\"GMV_SUM\",\"BUYER_LEVEL_SUM\",\"SELLER_LEVEL_SUM\",\"TRANS_CNT\"]}]},{\"name\": \"F2\",\"columns\": [{\"qualifier\": \"M\",\"measure_refs\": [\"SELLER_CNT_HLL\",\"TOP_SELLER\"]}]}]},\"aggregation_groups\": [{\"includes\": [\"KYLIN_SALES.PART_DT\",\"KYLIN_CATEGORY_GROUPINGS.META_CATEG_NAME\",\"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL2_NAME\",\"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL3_NAME\",\"KYLIN_SALES.LEAF_CATEG_ID\",\"KYLIN_SALES.LSTG_FORMAT_NAME\",\"KYLIN_SALES.LSTG_SITE_ID\",\"KYLIN_SALES.OPS_USER_ID\",\"KYLIN_SALES.OPS_REGION\",\"BUYER_ACCOUNT.ACCOUNT_BUYER_LEVEL\",\"SELLER_ACCOUNT.ACCOUNT_SELLER_LEVEL\",\"BUYER_ACCOUNT.ACCOUNT_COUNTRY\",\"SELLER_ACCOUNT.ACCOUNT_COUNTRY\",\"BUYER_COUNTRY.NAME\",\"SELLER_COUNTRY.NAME\"],\"select_rule\": {\"hierarchy_dims\": [[\"KYLIN_CATEGORY_GROUPINGS.META_CATEG_NAME\",\"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL2_NAME\",\"KYLIN_CATEGORY_GROUPINGS.CATEG_LVL3_NAME\",\"KYLIN_SALES.LEAF_CATEG_ID\"]],\"mand atory_dims\": [\"KYLIN_SALES.PART_DT\"],\"joint_dims\": [[\"BUYER_ACCOUNT.ACCOUNT_COUNTRY\",\"BUYER_COUNTRY.NAME\"],[\"SELLER_ACCOUNT.ACCOUNT_COUNTRY\",\"SELLER_COUNTRY.NAME\"],[\"BUYER_ACCOUNT.ACCOUNT_BUYER_LEVEL\",\"SELLER_ACCOUNT.ACCOUNT_SELLER_LEVEL\"],[\"KYLIN_SALES.LSTG_FORMAT_NAME\",\"KYLIN_SALES.LSTG_SITE_ID\"],[\"KYLIN_SALES.OPS_USER_ID\",\"KYLIN_SALES.OPS_REGION\"]]}}],\"signature\": null,\"notify_list\": [],\"status_need_notify\": [],\"partition_date_start\": 1325376000000,\"partition_date_end\": 3153600000000,\"auto_merge_time_ranges\": [],\"volatile_range\": 0,\"retention_range\": 0,\"engine_type\": 2,\"storage_type\": 2,\"override_kylin_properties\": {\"kylin.cube.aggrgroup.is-mandatory-only-valid\": \"true\",\"kylin.engine.spark.rdd-partition-cut-mb\": \"500\"},\"cuboid_black_list\": [],\"parent_forward\": 3,\"mandatory_dimension_set_list\": [],\"snapshot_table_desc_list\": []}"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"streamingData"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> +</span><span class="nt">"kafkaData"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> +</span><span class="nt">"successful"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> +</span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> +</span><span class="nt">"project"</span><span class="p">:</span><span class="w"> </span><span class="s2">"learn_kylin"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"streamingCube"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="w"> +</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + <h2 id="list-cubes">List cubes</h2> <p><code class="highlighter-rouge">GET /kylin/api/cubes</code></p> @@ -6688,7 +6730,7 @@ python -c "import base64; print base64.s <li>projectName - <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">string</code> Project name.</li> </ul> -<h4 id="response-sample-3">Response Sample</h4> +<h4 id="response-sample-4">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="o">[</span> <span class="o">{</span> <span class="s2">"uuid"</span>:<span class="s2">"1eaca32a-a33e-4b69-83dd-0bb8b1f8c53b"</span>, @@ -6727,7 +6769,7 @@ Get descriptor for specified cube instan <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cube name.</li> </ul> -<h4 id="response-sample-4">Response Sample</h4> +<h4 id="response-sample-5">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="o">[</span> <span class="o">{</span> <span class="s2">"uuid"</span>: <span class="s2">"a24ca905-1fc6-4f67-985c-38fa5aeafd92"</span>, @@ -6989,7 +7031,7 @@ Get descriptor for specified cube instan <li>modelName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Data model name, by default it should be the same with cube name.</li> </ul> -<h4 id="response-sample-5">Response Sample</h4> +<h4 id="response-sample-6">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="o">{</span> <span class="s2">"uuid"</span>: <span class="s2">"ff527b94-f860-44c3-8452-93b17774c647"</span>, <span class="s2">"name"</span>: <span class="s2">"test_kylin_with_slr_model_desc"</span>, @@ -7044,7 +7086,7 @@ Get descriptor for specified cube instan <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cube name.</li> </ul> -<h4 id="request-body-1">Request Body</h4> +<h4 id="request-body-2">Request Body</h4> <ul> <li>startTime - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">long</code> Start timestamp of data to build, e.g. 1388563200000 for 2014-1-1</li> <li>endTime - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">long</code> End timestamp of data to build</li> @@ -7056,7 +7098,7 @@ Get descriptor for specified cube instan </code></pre> </div> -<h4 id="response-sample-6">Response Sample</h4> +<h4 id="response-sample-7">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w"> </span><span class="nt">"uuid"</span><span class="p">:</span><span class="s2">"c143e0e4-ac5f-434d-acf3-46b0d15e3dc6"</span><span class="p">,</span><span class="w"> </span><span class="nt">"last_modified"</span><span class="p">:</span><span class="mi">1407908916705</span><span class="p">,</span><span class="w"> @@ -7126,7 +7168,7 @@ Get descriptor for specified cube instan <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cube name.</li> </ul> -<h4 id="response-sample-7">Response Sample</h4> +<h4 id="response-sample-8">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="o">{</span> <span class="s2">"uuid"</span>:<span class="s2">"1eaca32a-a33e-4b69-83dd-0bb8b1f8c53b"</span>, <span class="s2">"last_modified"</span>:1407909046305, @@ -7182,7 +7224,7 @@ Get descriptor for specified cube instan <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cube name.</li> </ul> -<h4 id="response-sample-8">Response Sample</h4> +<h4 id="response-sample-9">Response Sample</h4> <p>(Same as âEnable Cubeâ)</p> <h2 id="purge-cube">Purge Cube</h2> @@ -7193,7 +7235,7 @@ Get descriptor for specified cube instan <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cube name.</li> </ul> -<h4 id="response-sample-9">Response Sample</h4> +<h4 id="response-sample-10">Response Sample</h4> <p>(Same as âEnable Cubeâ)</p> <h2 id="delete-segment">Delete Segment</h2> @@ -7201,15 +7243,259 @@ Get descriptor for specified cube instan <hr /> +<h2 id="create-model">Create Model</h2> +<p><code class="highlighter-rouge">POST /kylin/api/models</code></p> + +<h4 id="request-body-3">Request Body</h4> +<ul> + <li>modelDescData - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> modelDescData to create</li> + <li>modelName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> modelName to create</li> + <li>projectName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> projectName to which model belongs</li> +</ul> + +<h4 id="request-sample-2">Request Sample</h4> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w"> +</span><span class="nt">"modelDescData"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{\"uuid\": \"0928468a-9fab-4185-9a14-6f2e7c74823f\",\"last_modified\": 0,\"version\": \"3.0.0.20500\",\"name\": \"kylin_test_model\",\"owner\": null,\"is_draft\": false,\"description\": \"\",\"fact_table\": \"DEFAULT.KYLIN_SALES\",\"lookups\": [{\"table\": \"DEFAULT.KYLIN_CAL_DT\",\"kind\": \"LOOKUP\",\"alias\": \"KYLIN_CAL_DT\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"KYLIN_CAL_DT.CAL_DT\"],\"foreign_key\": [\"KYLIN_SALES.PART_DT\"]}},{\"table\": \"DEFAULT.KYLIN_CATEGORY_GROUPINGS\",\"kind\": \"LOOKUP\",\"alias\": \"KYLIN_CATEGORY_GROUPINGS\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"KYLIN_CATEGORY_GROUPINGS.LEAF_CATEG_ID\",\"KYLIN_CATEGORY_GROUPINGS.SITE_ID\"],\"foreign_key\": [\"KYLIN_SALES.LEAF_CATEG_ID\",\"KYLIN_SALES.LSTG_SITE_ID\"]}},{\"table\": \"DEFAULT.KYLIN_ACCOUNT\",\"kind\": \"LOOKUP\",\"alias\": \"BUYER_ACCOUNT\",\"join\": {\"type\": \"inne r\",\"primary_key\": [\"BUYER_ACCOUNT.ACCOUNT_ID\"],\"foreign_key\": [\"KYLIN_SALES.BUYER_ID\"]}},{\"table\": \"DEFAULT.KYLIN_ACCOUNT\",\"kind\": \"LOOKUP\",\"alias\": \"SELLER_ACCOUNT\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"SELLER_ACCOUNT.ACCOUNT_ID\"],\"foreign_key\": [\"KYLIN_SALES.SELLER_ID\"]}},{\"table\": \"DEFAULT.KYLIN_COUNTRY\",\"kind\": \"LOOKUP\",\"alias\": \"BUYER_COUNTRY\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"BUYER_COUNTRY.COUNTRY\"],\"foreign_key\": [\"BUYER_ACCOUNT.ACCOUNT_COUNTRY\"]}},{\"table\": \"DEFAULT.KYLIN_COUNTRY\",\"kind\": \"LOOKUP\",\"alias\": \"SELLER_COUNTRY\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"SELLER_COUNTRY.COUNTRY\"],\"foreign_key\": [\"SELLER_ACCOUNT.ACCOUNT_COUNTRY\"]}}],\"dimensions\": [{\"table\": \"KYLIN_SALES\",\"columns\": [\"TRANS_ID\",\"SELLER_ID\",\"BUYER_ID\",\"PART_DT\",\"LEAF_CATEG_ID\",\"LSTG_FORMAT_NAME\",\"LSTG_SITE_ID\",\"OPS_USER_ID\",\"OPS_REGION\"]},{\"table\": \"KYLIN_CAL_DT\",\"columns\": [\"CAL_DT\",\"WEEK_BEG_DT\",\"MONTH_BEG_DT\",\"YEAR_BEG_DT\"]},{\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"columns\": [\"USER_DEFINED_FIELD1\",\"USER_DEFINED_FIELD3\",\"META_CATEG_NAME\",\"CATEG_LVL2_NAME\",\"CATEG_LVL3_NAME\",\"LEAF_CATEG_ID\",\"SITE_ID\"]},{\"table\": \"BUYER_ACCOUNT\",\"columns\": [\"ACCOUNT_ID\",\"ACCOUNT_BUYER_LEVEL\",\"ACCOUNT_SELLER_LEVEL\",\"ACCOUNT_COUNTRY\",\"ACCOUNT_CONTACT\"]},{\"table\": \"SELLER_ACCOUNT\",\"columns\": [\"ACCOUNT_ID\",\"ACCOUNT_BUYER_LEVEL\",\"ACCOUNT_SELLER_LEVEL\",\"ACCOUNT_COUNTRY\",\"ACCOUNT_CONTACT\"]},{\"table\": \"BUYER_COUNTRY\",\"columns\": [\"COUNTRY\",\"NAME\"]},{\"table\": \"SELLER_COUNTRY\",\"columns\": [\"COUNTRY\",\"NAME\"]}],\"metrics\": [\"KYLIN_SALES.PRICE\",\"KYLIN_SALES.ITEM_COUNT\"],\"filter_condition\": \"\",\"partition_desc\": {\"partition_date_column\": \"KYLIN_SALES.PART_DT\",\"partition_time_column\": null,\"partition_date_start\": 1325376000000,\"partition_date_format\": \"yyyy-MM-dd\",\"partition_time_format\ ": \"HH:mm:ss\",\"partition_type\": \"APPEND\",\"partition_condition_builder\": \"org.apache.kylin.metadata.model.PartitionDesc$DefaultPartitionConditionBuilder\"},\"capacity\": \"MEDIUM\"}"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"modelName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"kylin_test_model"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"project"</span><span class="p">:</span><span class="w"> </span><span class="s2">"learn_kylin"</span><span class="w"> +</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + +<h4 id="response-sample-11">Response Sample</h4> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w"> +</span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2613d739-14c1-38ac-2e37-f36e46fd9976"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"modelName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"kylin_test_model"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"modelDescData"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{\"uuid\": \"0928468a-9fab-4185-9a14-6f2e7c74823f\",\"last_modified\": 0,\"version\": \"3.0.0.20500\",\"name\": \"kylin_test_model\",\"owner\": null,\"is_draft\": false,\"description\": \"\",\"fact_table\": \"DEFAULT.KYLIN_SALES\",\"lookups\": [{\"table\": \"DEFAULT.KYLIN_CAL_DT\",\"kind\": \"LOOKUP\",\"alias\": \"KYLIN_CAL_DT\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"KYLIN_CAL_DT.CAL_DT\"],\"foreign_key\": [\"KYLIN_SALES.PART_DT\"]}},{\"table\": \"DEFAULT.KYLIN_CATEGORY_GROUPINGS\",\"kind\": \"LOOKUP\",\"alias\": \"KYLIN_CATEGORY_GROUPINGS\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"KYLIN_CATEGORY_GROUPINGS.LEAF_CATEG_ID\",\"KYLIN_CATEGORY_GROUPINGS.SITE_ID\"],\"foreign_key\": [\"KYLIN_SALES.LEAF_CATEG_ID\",\"KYLIN_SALES.LSTG_SITE_ID\"]}},{\"table\": \"DEFAULT.KYLIN_ACCOUNT\",\"kind\": \"LOOKUP\",\"alias\": \"BUYER_ACCOUNT\",\"join\": {\"type\": \"inne r\",\"primary_key\": [\"BUYER_ACCOUNT.ACCOUNT_ID\"],\"foreign_key\": [\"KYLIN_SALES.BUYER_ID\"]}},{\"table\": \"DEFAULT.KYLIN_ACCOUNT\",\"kind\": \"LOOKUP\",\"alias\": \"SELLER_ACCOUNT\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"SELLER_ACCOUNT.ACCOUNT_ID\"],\"foreign_key\": [\"KYLIN_SALES.SELLER_ID\"]}},{\"table\": \"DEFAULT.KYLIN_COUNTRY\",\"kind\": \"LOOKUP\",\"alias\": \"BUYER_COUNTRY\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"BUYER_COUNTRY.COUNTRY\"],\"foreign_key\": [\"BUYER_ACCOUNT.ACCOUNT_COUNTRY\"]}},{\"table\": \"DEFAULT.KYLIN_COUNTRY\",\"kind\": \"LOOKUP\",\"alias\": \"SELLER_COUNTRY\",\"join\": {\"type\": \"inner\",\"primary_key\": [\"SELLER_COUNTRY.COUNTRY\"],\"foreign_key\": [\"SELLER_ACCOUNT.ACCOUNT_COUNTRY\"]}}],\"dimensions\": [{\"table\": \"KYLIN_SALES\",\"columns\": [\"TRANS_ID\",\"SELLER_ID\",\"BUYER_ID\",\"PART_DT\",\"LEAF_CATEG_ID\",\"LSTG_FORMAT_NAME\",\"LSTG_SITE_ID\",\"OPS_USER_ID\",\"OPS_REGION\"]},{\"table\": \"KYLIN_CAL_DT\",\"columns\": [\"CAL_DT\",\"WEEK_BEG_DT\",\"MONTH_BEG_DT\",\"YEAR_BEG_DT\"]},{\"table\": \"KYLIN_CATEGORY_GROUPINGS\",\"columns\": [\"USER_DEFINED_FIELD1\",\"USER_DEFINED_FIELD3\",\"META_CATEG_NAME\",\"CATEG_LVL2_NAME\",\"CATEG_LVL3_NAME\",\"LEAF_CATEG_ID\",\"SITE_ID\"]},{\"table\": \"BUYER_ACCOUNT\",\"columns\": [\"ACCOUNT_ID\",\"ACCOUNT_BUYER_LEVEL\",\"ACCOUNT_SELLER_LEVEL\",\"ACCOUNT_COUNTRY\",\"ACCOUNT_CONTACT\"]},{\"table\": \"SELLER_ACCOUNT\",\"columns\": [\"ACCOUNT_ID\",\"ACCOUNT_BUYER_LEVEL\",\"ACCOUNT_SELLER_LEVEL\",\"ACCOUNT_COUNTRY\",\"ACCOUNT_CONTACT\"]},{\"table\": \"BUYER_COUNTRY\",\"columns\": [\"COUNTRY\",\"NAME\"]},{\"table\": \"SELLER_COUNTRY\",\"columns\": [\"COUNTRY\",\"NAME\"]}],\"metrics\": [\"KYLIN_SALES.PRICE\",\"KYLIN_SALES.ITEM_COUNT\"],\"filter_condition\": \"\",\"partition_desc\": {\"partition_date_column\": \"KYLIN_SALES.PART_DT\",\"partition_time_column\": null,\"partition_date_start\": 1325376000000,\"partition_date_format\": \"yyyy-MM-dd\",\"partition_time_format\ ": \"HH:mm:ss\",\"partition_type\": \"APPEND\",\"partition_condition_builder\": \"org.apache.kylin.metadata.model.PartitionDesc$DefaultPartitionConditionBuilder\"},\"capacity\": \"MEDIUM\"}"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"successful"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> +</span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> +</span><span class="nt">"project"</span><span class="p">:</span><span class="w"> </span><span class="s2">"learn_kylin"</span><span class="p">,</span><span class="w"> +</span><span class="nt">"ccInCheck"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> +</span><span class="nt">"seekingExprAdvice"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w"> +</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + +<h2 id="get-modeldescdata">Get ModelDescData</h2> +<p><code class="highlighter-rouge">GET /kylin/api/models</code></p> + +<h5 id="request-parameters-2">Request Parameters</h5> +<ul> + <li>modelName - <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">string</code> Model name.</li> + <li>projectName - <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">string</code> Project Name.</li> + <li>limit - <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">integer</code> Offset used by pagination</li> + <li>offset - <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">integer</code> Models per page</li> +</ul> + +<h4 id="response-sample-12">Response Sample</h4> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="o">[</span> + <span class="o">{</span> + <span class="s2">"uuid"</span>: <span class="s2">"0928468a-9fab-4185-9a14-6f2e7c74823f"</span>, + <span class="s2">"last_modified"</span>: 1568862496000, + <span class="s2">"version"</span>: <span class="s2">"3.0.0.20500"</span>, + <span class="s2">"name"</span>: <span class="s2">"kylin_sales_model"</span>, + <span class="s2">"owner"</span>: null, + <span class="s2">"is_draft"</span>: <span class="nb">false</span>, + <span class="s2">"description"</span>: <span class="s2">""</span>, + <span class="s2">"fact_table"</span>: <span class="s2">"DEFAULT.KYLIN_SALES"</span>, + <span class="s2">"lookups"</span>: <span class="o">[</span> + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"DEFAULT.KYLIN_CAL_DT"</span>, + <span class="s2">"kind"</span>: <span class="s2">"LOOKUP"</span>, + <span class="s2">"alias"</span>: <span class="s2">"KYLIN_CAL_DT"</span>, + <span class="s2">"join"</span>: <span class="o">{</span> + <span class="s2">"type"</span>: <span class="s2">"inner"</span>, + <span class="s2">"primary_key"</span>: <span class="o">[</span> + <span class="s2">"KYLIN_CAL_DT.CAL_DT"</span> + <span class="o">]</span>, + <span class="s2">"foreign_key"</span>: <span class="o">[</span> + <span class="s2">"KYLIN_SALES.PART_DT"</span> + <span class="o">]</span> + <span class="o">}</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"DEFAULT.KYLIN_CATEGORY_GROUPINGS"</span>, + <span class="s2">"kind"</span>: <span class="s2">"LOOKUP"</span>, + <span class="s2">"alias"</span>: <span class="s2">"KYLIN_CATEGORY_GROUPINGS"</span>, + <span class="s2">"join"</span>: <span class="o">{</span> + <span class="s2">"type"</span>: <span class="s2">"inner"</span>, + <span class="s2">"primary_key"</span>: <span class="o">[</span> + <span class="s2">"KYLIN_CATEGORY_GROUPINGS.LEAF_CATEG_ID"</span>, + <span class="s2">"KYLIN_CATEGORY_GROUPINGS.SITE_ID"</span> + <span class="o">]</span>, + <span class="s2">"foreign_key"</span>: <span class="o">[</span> + <span class="s2">"KYLIN_SALES.LEAF_CATEG_ID"</span>, + <span class="s2">"KYLIN_SALES.LSTG_SITE_ID"</span> + <span class="o">]</span> + <span class="o">}</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"DEFAULT.KYLIN_ACCOUNT"</span>, + <span class="s2">"kind"</span>: <span class="s2">"LOOKUP"</span>, + <span class="s2">"alias"</span>: <span class="s2">"BUYER_ACCOUNT"</span>, + <span class="s2">"join"</span>: <span class="o">{</span> + <span class="s2">"type"</span>: <span class="s2">"inner"</span>, + <span class="s2">"primary_key"</span>: <span class="o">[</span> + <span class="s2">"BUYER_ACCOUNT.ACCOUNT_ID"</span> + <span class="o">]</span>, + <span class="s2">"foreign_key"</span>: <span class="o">[</span> + <span class="s2">"KYLIN_SALES.BUYER_ID"</span> + <span class="o">]</span> + <span class="o">}</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"DEFAULT.KYLIN_ACCOUNT"</span>, + <span class="s2">"kind"</span>: <span class="s2">"LOOKUP"</span>, + <span class="s2">"alias"</span>: <span class="s2">"SELLER_ACCOUNT"</span>, + <span class="s2">"join"</span>: <span class="o">{</span> + <span class="s2">"type"</span>: <span class="s2">"inner"</span>, + <span class="s2">"primary_key"</span>: <span class="o">[</span> + <span class="s2">"SELLER_ACCOUNT.ACCOUNT_ID"</span> + <span class="o">]</span>, + <span class="s2">"foreign_key"</span>: <span class="o">[</span> + <span class="s2">"KYLIN_SALES.SELLER_ID"</span> + <span class="o">]</span> + <span class="o">}</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"DEFAULT.KYLIN_COUNTRY"</span>, + <span class="s2">"kind"</span>: <span class="s2">"LOOKUP"</span>, + <span class="s2">"alias"</span>: <span class="s2">"BUYER_COUNTRY"</span>, + <span class="s2">"join"</span>: <span class="o">{</span> + <span class="s2">"type"</span>: <span class="s2">"inner"</span>, + <span class="s2">"primary_key"</span>: <span class="o">[</span> + <span class="s2">"BUYER_COUNTRY.COUNTRY"</span> + <span class="o">]</span>, + <span class="s2">"foreign_key"</span>: <span class="o">[</span> + <span class="s2">"BUYER_ACCOUNT.ACCOUNT_COUNTRY"</span> + <span class="o">]</span> + <span class="o">}</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"DEFAULT.KYLIN_COUNTRY"</span>, + <span class="s2">"kind"</span>: <span class="s2">"LOOKUP"</span>, + <span class="s2">"alias"</span>: <span class="s2">"SELLER_COUNTRY"</span>, + <span class="s2">"join"</span>: <span class="o">{</span> + <span class="s2">"type"</span>: <span class="s2">"inner"</span>, + <span class="s2">"primary_key"</span>: <span class="o">[</span> + <span class="s2">"SELLER_COUNTRY.COUNTRY"</span> + <span class="o">]</span>, + <span class="s2">"foreign_key"</span>: <span class="o">[</span> + <span class="s2">"SELLER_ACCOUNT.ACCOUNT_COUNTRY"</span> + <span class="o">]</span> + <span class="o">}</span> + <span class="o">}</span> + <span class="o">]</span>, + <span class="s2">"dimensions"</span>: <span class="o">[</span> + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"KYLIN_SALES"</span>, + <span class="s2">"columns"</span>: <span class="o">[</span> + <span class="s2">"TRANS_ID"</span>, + <span class="s2">"SELLER_ID"</span>, + <span class="s2">"BUYER_ID"</span>, + <span class="s2">"PART_DT"</span>, + <span class="s2">"LEAF_CATEG_ID"</span>, + <span class="s2">"LSTG_FORMAT_NAME"</span>, + <span class="s2">"LSTG_SITE_ID"</span>, + <span class="s2">"OPS_USER_ID"</span>, + <span class="s2">"OPS_REGION"</span> + <span class="o">]</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"KYLIN_CAL_DT"</span>, + <span class="s2">"columns"</span>: <span class="o">[</span> + <span class="s2">"CAL_DT"</span>, + <span class="s2">"WEEK_BEG_DT"</span>, + <span class="s2">"MONTH_BEG_DT"</span>, + <span class="s2">"YEAR_BEG_DT"</span> + <span class="o">]</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"KYLIN_CATEGORY_GROUPINGS"</span>, + <span class="s2">"columns"</span>: <span class="o">[</span> + <span class="s2">"USER_DEFINED_FIELD1"</span>, + <span class="s2">"USER_DEFINED_FIELD3"</span>, + <span class="s2">"META_CATEG_NAME"</span>, + <span class="s2">"CATEG_LVL2_NAME"</span>, + <span class="s2">"CATEG_LVL3_NAME"</span>, + <span class="s2">"LEAF_CATEG_ID"</span>, + <span class="s2">"SITE_ID"</span> + <span class="o">]</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"BUYER_ACCOUNT"</span>, + <span class="s2">"columns"</span>: <span class="o">[</span> + <span class="s2">"ACCOUNT_ID"</span>, + <span class="s2">"ACCOUNT_BUYER_LEVEL"</span>, + <span class="s2">"ACCOUNT_SELLER_LEVEL"</span>, + <span class="s2">"ACCOUNT_COUNTRY"</span>, + <span class="s2">"ACCOUNT_CONTACT"</span> + <span class="o">]</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"SELLER_ACCOUNT"</span>, + <span class="s2">"columns"</span>: <span class="o">[</span> + <span class="s2">"ACCOUNT_ID"</span>, + <span class="s2">"ACCOUNT_BUYER_LEVEL"</span>, + <span class="s2">"ACCOUNT_SELLER_LEVEL"</span>, + <span class="s2">"ACCOUNT_COUNTRY"</span>, + <span class="s2">"ACCOUNT_CONTACT"</span> + <span class="o">]</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"BUYER_COUNTRY"</span>, + <span class="s2">"columns"</span>: <span class="o">[</span> + <span class="s2">"COUNTRY"</span>, + <span class="s2">"NAME"</span> + <span class="o">]</span> + <span class="o">}</span>, + <span class="o">{</span> + <span class="s2">"table"</span>: <span class="s2">"SELLER_COUNTRY"</span>, + <span class="s2">"columns"</span>: <span class="o">[</span> + <span class="s2">"COUNTRY"</span>, + <span class="s2">"NAME"</span> + <span class="o">]</span> + <span class="o">}</span> + <span class="o">]</span>, + <span class="s2">"metrics"</span>: <span class="o">[</span> + <span class="s2">"KYLIN_SALES.PRICE"</span>, + <span class="s2">"KYLIN_SALES.ITEM_COUNT"</span> + <span class="o">]</span>, + <span class="s2">"filter_condition"</span>: <span class="s2">""</span>, + <span class="s2">"partition_desc"</span>: <span class="o">{</span> + <span class="s2">"partition_date_column"</span>: <span class="s2">"KYLIN_SALES.PART_DT"</span>, + <span class="s2">"partition_time_column"</span>: null, + <span class="s2">"partition_date_start"</span>: 1325376000000, + <span class="s2">"partition_date_format"</span>: <span class="s2">"yyyy-MM-dd"</span>, + <span class="s2">"partition_time_format"</span>: <span class="s2">"HH:mm:ss"</span>, + <span class="s2">"partition_type"</span>: <span class="s2">"APPEND"</span>, + <span class="s2">"partition_condition_builder"</span>: <span class="s2">"org.apache.kylin.metadata.model.PartitionDesc</span><span class="nv">$DefaultPartitionConditionBuilder</span><span class="s2">"</span> + <span class="o">}</span>, + <span class="s2">"capacity"</span>: <span class="s2">"MEDIUM"</span> + <span class="o">}</span> +<span class="o">]</span> +</code></pre> +</div> + +<h2 id="delete-model">Delete Model</h2> +<p><code class="highlighter-rouge">DELETE /kylin/api/models/{modelName}</code></p> + +<h4 id="path-variable-7">Path variable</h4> +<ul> + <li>modelName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Model name you want delete.</li> +</ul> + +<hr /> + <h2 id="resume-job">Resume Job</h2> <p><code class="highlighter-rouge">PUT /kylin/api/jobs/{jobId}/resume</code></p> -<h4 id="path-variable-7">Path variable</h4> +<h4 id="path-variable-8">Path variable</h4> <ul> <li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li> </ul> -<h4 id="response-sample-10">Response Sample</h4> +<h4 id="response-sample-13">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w"> </span><span class="nt">"uuid"</span><span class="p">:</span><span class="s2">"c143e0e4-ac5f-434d-acf3-46b0d15e3dc6"</span><span class="p">,</span><span class="w"> </span><span class="nt">"last_modified"</span><span class="p">:</span><span class="mi">1407908916705</span><span class="p">,</span><span class="w"> @@ -7273,7 +7559,7 @@ Get descriptor for specified cube instan <p>## Pause Job<br /> <code class="highlighter-rouge">PUT /kylin/api/jobs/{jobId}/pause</code></p> -<h4 id="path-variable-8">Path variable</h4> +<h4 id="path-variable-9">Path variable</h4> <ul> <li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li> </ul> @@ -7281,7 +7567,7 @@ Get descriptor for specified cube instan <h2 id="discard-job">Discard Job</h2> <p><code class="highlighter-rouge">PUT /kylin/api/jobs/{jobId}/cancel</code></p> -<h4 id="path-variable-9">Path variable</h4> +<h4 id="path-variable-10">Path variable</h4> <ul> <li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li> </ul> @@ -7289,7 +7575,7 @@ Get descriptor for specified cube instan <h2 id="drop-job">Drop Job</h2> <p><code class="highlighter-rouge">DELETE /kylin/api/jobs/{jobId}/drop</code></p> -<h4 id="path-variable-10">Path variable</h4> +<h4 id="path-variable-11">Path variable</h4> <ul> <li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li> </ul> @@ -7297,24 +7583,24 @@ Get descriptor for specified cube instan <h2 id="get-job-status">Get Job Status</h2> <p><code class="highlighter-rouge">GET /kylin/api/jobs/{jobId}</code></p> -<h4 id="path-variable-11">Path variable</h4> +<h4 id="path-variable-12">Path variable</h4> <ul> <li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li> </ul> -<h4 id="response-sample-11">Response Sample</h4> +<h4 id="response-sample-14">Response Sample</h4> <p>(Same as âResume Jobâ)</p> <h2 id="get-job-step-output">Get job step output</h2> <p><code class="highlighter-rouge">GET /kylin/api/jobs/{jobId}/steps/{stepId}/output</code></p> -<h4 id="path-variable-12">Path Variable</h4> +<h4 id="path-variable-13">Path Variable</h4> <ul> <li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li> <li>stepId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Step id; the step id is composed by jobId with step sequence id; for example, the jobId is âfb479e54-837f-49a2-b457-651fc50be110â, its 3rd step id is âfb479e54-837f-49a2-b457-651fc50be110-3â,</li> </ul> -<h4 id="response-sample-12">Response Sample</h4> +<h4 id="response-sample-15">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w"> </span><span class="nt">"cmd_output"</span><span class="p">:</span><span class="s2">"log string"</span><span class="w"> </span><span class="p">}</span><span class="w"> @@ -7340,7 +7626,7 @@ Get descriptor for specified cube instan </code></pre> </div> -<h4 id="response-sample-13">Response Sample</h4> +<h4 id="response-sample-16">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code>[ { "uuid": "9eb7bccf-4448-4578-9c29-552658b5a2ca", @@ -7404,7 +7690,7 @@ Get descriptor for specified cube instan <li>tableName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> table name to find.</li> </ul> -<h4 id="response-sample-14">Response Sample</h4> +<h4 id="response-sample-17">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="o">{</span> uuid: <span class="s2">"69cc92c0-fc42-4bb9-893f-bd1141c91dbe"</span>, name: <span class="s2">"SAMPLE_07"</span>, @@ -7434,13 +7720,13 @@ Get descriptor for specified cube instan <h2 id="get-hive-tables">Get Hive Tables</h2> <p><code class="highlighter-rouge">GET /kylin/api/tables</code></p> -<h4 id="request-parameters-2">Request Parameters</h4> +<h4 id="request-parameters-3">Request Parameters</h4> <ul> <li>project- <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> will list all tables in the project.</li> <li>ext- <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">boolean</code> set true to get extend info of table.</li> </ul> -<h4 id="response-sample-15">Response Sample</h4> +<h4 id="response-sample-18">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="o">[</span> <span class="o">{</span> uuid: <span class="s2">"53856c96-fe4d-459e-a9dc-c339b1bc3310"</span>, @@ -7490,13 +7776,18 @@ Get descriptor for specified cube instan <h2 id="load-hive-tables">Load Hive Tables</h2> <p><code class="highlighter-rouge">POST /kylin/api/tables/{tables}/{project}</code></p> -<h4 id="request-parameters-3">Request Parameters</h4> +<h4 id="request-parameters-4">Request Parameters</h4> <ul> <li>tables - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> table names you want to load from hive, separated with comma.</li> <li>project - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">String</code> the project which the tables will be loaded into.</li> </ul> -<h4 id="response-sample-16">Response Sample</h4> +<h4 id="request-body-4">Request Body</h4> +<ul> + <li>calculate - <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">boolean</code></li> +</ul> + +<h4 id="response-sample-19">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w"> </span><span class="nt">"result.loaded"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"DEFAULT.SAMPLE_07"</span><span class="p">],</span><span class="w"> </span><span class="nt">"result.unloaded"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"sapmle_08"</span><span class="p">]</span><span class="w"> @@ -7509,7 +7800,7 @@ Get descriptor for specified cube instan <h2 id="wipe-cache">Wipe cache</h2> <p><code class="highlighter-rouge">PUT /kylin/api/cache/{type}/{name}/{action}</code></p> -<h4 id="path-variable-13">Path variable</h4> +<h4 id="path-variable-14">Path variable</h4> <ul> <li>type - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> âMETADATAâ or âCUBEâ</li> <li>name - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cache key, e.g the cube name.</li> @@ -7523,12 +7814,12 @@ Get descriptor for specified cube instan <p><code class="highlighter-rouge">PUT /kylin/api/cubes/{cubeName}/init_start_offsets</code></p> -<h4 id="path-variable-14">Path variable</h4> +<h4 id="path-variable-15">Path variable</h4> <ul> <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cube name</li> </ul> -<h4 id="response-sample-17">Response Sample</h4> +<h4 id="response-sample-20">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="o">{</span> <span class="s2">"result"</span>: <span class="s2">"success"</span>, <span class="s2">"offsets"</span>: <span class="s2">"{0=246059529, 1=253547684, 2=253023895, 3=172996803, 4=165503476, 5=173513896, 6=19200473, 7=26691891, 8=26699895, 9=26694021, 10=19204164, 11=26694597}"</span> @@ -7541,12 +7832,12 @@ Get descriptor for specified cube instan <p>This API is specific for stream cubeâs building;</p> -<h4 id="path-variable-15">Path variable</h4> +<h4 id="path-variable-16">Path variable</h4> <ul> <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cube name</li> </ul> -<h4 id="request-body-2">Request Body</h4> +<h4 id="request-body-5">Request Body</h4> <ul> <li>sourceOffsetStart - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">long</code> The start offset, 0 represents from previous position;</li> @@ -7554,7 +7845,7 @@ Get descriptor for specified cube instan <li>buildType - <code class="highlighter-rouge">required</code> Build type, âBUILDâ, âMERGEâ or âREFRESHâ</li> </ul> -<h4 id="request-sample-1">Request Sample</h4> +<h4 id="request-sample-3">Request Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="o">{</span> <span class="s2">"sourceOffsetStart"</span>: 0, @@ -7564,7 +7855,7 @@ Get descriptor for specified cube instan </code></pre> </div> -<h4 id="response-sample-18">Response Sample</h4> +<h4 id="response-sample-21">Response Sample</h4> <div class="highlighter-rouge"><pre class="highlight"><code><span class="o">{</span> <span class="s2">"uuid"</span>: <span class="s2">"3afd6e75-f921-41e1-8c68-cb60bc72a601"</span>, <span class="s2">"last_modified"</span>: 1480402541240, @@ -7585,7 +7876,7 @@ Get descriptor for specified cube instan <h2 id="check-segment-holes">Check segment holes</h2> <p><code class="highlighter-rouge">GET /kylin/api/cubes/{cubeName}/holes</code></p> -<h4 id="path-variable-16">Path variable</h4> +<h4 id="path-variable-17">Path variable</h4> <ul> <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cube name</li> </ul> @@ -7593,7 +7884,7 @@ Get descriptor for specified cube instan <h2 id="fill-segment-holes">Fill segment holes</h2> <p><code class="highlighter-rouge">PUT /kylin/api/cubes/{cubeName}/holes</code></p> -<h4 id="path-variable-17">Path variable</h4> +<h4 id="path-variable-18">Path variable</h4> <ul> <li>cubeName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cube name</li> </ul>
Modified: kylin/site/feed.xml URL: http://svn.apache.org/viewvc/kylin/site/feed.xml?rev=1869215&r1=1869214&r2=1869215&view=diff ============================================================================== --- kylin/site/feed.xml (original) +++ kylin/site/feed.xml Thu Oct 31 14:08:19 2019 @@ -19,8 +19,8 @@ <description>Apache Kylin Home</description> <link>http://kylin.apache.org/</link> <atom:link href="http://kylin.apache.org/feed.xml"; rel="self" type="application/rss+xml"/> - <pubDate>Mon, 28 Oct 2019 07:20:58 -0700</pubDate> - <lastBuildDate>Mon, 28 Oct 2019 07:20:58 -0700</lastBuildDate> + <pubDate>Thu, 31 Oct 2019 06:59:16 -0700</pubDate> + <lastBuildDate>Thu, 31 Oct 2019 06:59:16 -0700</lastBuildDate> <generator>Jekyll v2.5.3</generator> <item> Modified: kylin/site/index.html URL: http://svn.apache.org/viewvc/kylin/site/index.html?rev=1869215&r1=1869214&r2=1869215&view=diff ============================================================================== --- kylin/site/index.html (original) +++ kylin/site/index.html Thu Oct 31 14:08:19 2019 @@ -6630,7 +6630,7 @@ var _hmt = _hmt || []; <a class="sponsor" href="http://www.xiaomi.com/";> <img src="/images/logo/xiaomi.jpg" /> </a> - <a class="sponsor" href="https://wmsj.qq.com/";> + <a class="sponsor" href="http://www.wanmei.com/";> <img src="/images/logo/wanmei.jpg" /> </a> <a class="sponsor" href="http://www.powerbi.com.cn/";>
