This is an automated email from the ASF dual-hosted git repository. xxyu pushed a commit to branch document in repository https://gitbox.apache.org/repos/asf/kylin.git
The following commit(s) were added to refs/heads/document by this push: new 690ac36 KYLIN-4712 Update document 690ac36 is described below commit 690ac3675ef412a529e22cf1b246db7bbf9e4352 Author: yaqian.zhang <598593...@qq.com> AuthorDate: Sun Sep 27 17:55:35 2020 +0800 KYLIN-4712 Update document --- website/_docs/howto/howto_use_cli.cn.md | 17 +++++++++-------- website/_docs/howto/howto_use_cli.md | 17 +++++++++-------- 2 files changed, 18 insertions(+), 16 deletions(-) diff --git a/website/_docs/howto/howto_use_cli.cn.md b/website/_docs/howto/howto_use_cli.cn.md index a73f3f1..709403a 100644 --- a/website/_docs/howto/howto_use_cli.cn.md +++ b/website/_docs/howto/howto_use_cli.cn.md @@ -47,11 +47,11 @@ CubeMetaExtractor.java 用于提取与 cube 相关的信息以达到调试/分 ### 如何使用 类名后至少写两个参数。 {% highlight Groff markup %} -./bin/kylin.sh org.apache.kylin.tool.CubeMetaExtractor -<conf_name> <conf_value> -destDir <your_dest_dir> +./bin/kylin.sh org.apache.kylin.tool.extractor.CubeMetaExtractor -<conf_name> <conf_value> -destDir <your_dest_dir> {% endhighlight %} 例如: {% highlight Groff markup %} -./bin/kylin.sh org.apache.kylin.tool.CubeMetaExtractor -cube querycube -destDir /root/newconfigdir1 +./bin/kylin.sh org.apache.kylin.tool.extractor.CubeMetaExtractor -cube querycube -destDir /root/newconfigdir1 {% endhighlight %} 结果: 命令执行成功后,您想要抽取的 cube / project / hybrid 将会存在于您指定的 destDir 目录中。 @@ -92,12 +92,13 @@ CubeMetaIngester.java 将提取的 cube 注入到另一个 metadata store 中。 下面会列出所有支持的参数: -| Parameter | Description | -| --------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| forceIngest <forceIngest> | Skip the target cube, model and table check and ingest by force. Use in caution because it might break existing cubes! Suggest to backup metadata store first. Default false. | -| overwriteTables <overwriteTables> | If table meta conflicts, overwrite the one in metadata store with the one in srcPath. Use in caution because it might break existing cubes! Suggest to backup metadata store first. Default false. | -| project <project> | (Required) Specify the target project for the new cubes. -| srcPath <srcPath> | (Required) Specify the path to the extracted Cube metadata zip file. | +| Parameter | Description | +| -------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| forceIngest <forceIngest> | Skip the target cube, model and table check and ingest by force. Use in caution because it might break existing cubes! Suggest to backup metadata store first. Default false. | +| overwriteTables <overwriteTables> | If table meta conflicts, overwrite the one in metadata store with the one in srcPath. Use in caution because it might break existing cubes! Suggest to backup metadata store first. Default false. | +| createProjectIdNotExists <createProjectIdNotExists>| If the specified project is not exists, kylin will create it. | +| project <project> | (Required) Specify the target project for the new cubes. | +| srcPath <srcPath> | (Required) Specify the path to the extracted Cube metadata zip file. | ## CubeMigrationCheckCLI.java diff --git a/website/_docs/howto/howto_use_cli.md b/website/_docs/howto/howto_use_cli.md index aadaa7a..85d02cf 100644 --- a/website/_docs/howto/howto_use_cli.md +++ b/website/_docs/howto/howto_use_cli.md @@ -48,11 +48,11 @@ CubeMetaExtractor.java is to extract Cube related info for debugging / distribut ### How to use At least two parameters should be followed. {% highlight Groff markup %} -./bin/kylin.sh org.apache.kylin.tool.CubeMetaExtractor -<conf_name> <conf_value> -destDir <your_dest_dir> +./bin/kylin.sh org.apache.kylin.tool.extractor.CubeMetaExtractor -<conf_name> <conf_value> -destDir <your_dest_dir> {% endhighlight %} For example: {% highlight Groff markup %} -./bin/kylin.sh org.apache.kylin.tool.CubeMetaExtractor -cube kylin_sales_cube -destDir /tmp/kylin_sales_cube +./bin/kylin.sh org.apache.kylin.tool.extractor.CubeMetaExtractor -cube kylin_sales_cube -destDir /tmp/kylin_sales_cube {% endhighlight %} Result: After the command is executed, the cube, project or hybrid you want to extract will be dumped in the specified path. @@ -96,12 +96,13 @@ After the command is successfully executed, the cube you want to ingest will exi All supported parameters are listed below: -| Parameter | Description | -| --------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| forceIngest <forceIngest> | Skip the target Cube, model and table check and ingest by force. Use in caution because it might break existing cubes! Suggest to backup metadata store first. Default false. | -| overwriteTables <overwriteTables> | If table meta conflicts, overwrite the one in metadata store with the one in srcPath. Use in caution because it might break existing cubes! Suggest to backup metadata store first. Default false. | -| project <project> | (Required) Specify the target project for the new cubes. | -| srcPath <srcPath> | (Required) Specify the path to the extracted Cube metadata zip file. | +| Parameter | Description | +| -------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| forceIngest <forceIngest> | Skip the target Cube, model and table check and ingest by force. Use in caution because it might break existing cubes! Suggest to backup metadata store first. Default false. | +| overwriteTables <overwriteTables> | If table meta conflicts, overwrite the one in metadata store with the one in srcPath. Use in caution because it might break existing cubes! Suggest to backup metadata store first. Default false. | +| createProjectIdNotExists <createProjectIdNotExists>| If the specified project is not exists, kylin will create it. | +| project <project> | (Required) Specify the target project for the new cubes. | +| srcPath <srcPath> | (Required) Specify the path to the extracted Cube metadata zip file. | ## CubeMigrationCheckCLI.java