实用 CLI 工具

实用 CLI 工具

Kylin 提供一些方便实用的工具类。这篇文档会介绍以下几个工具类：KylinConfigCLI.java，CubeMetaExtractor.java，CubeMetaIngester.java，CubeMigrationCLI.java 和 CubeMigrationCheckCLI.java。在使用这些工具类前，首先要切换到 KYLIN_HOME 目录下。

KylinConfigCLI.java

作用

KylinConfigCLI 工具类会将您输入的 Kylin 参数的值输出。

如何使用

类名后只能写一个参数，conf_name 即您想要知道其值的参数名称。

./bin/kylin.sh org.apache.kylin.tool.KylinConfigCLI <conf_name>

例如：

./bin/kylin.sh org.apache.kylin.tool.KylinConfigCLI kylin.server.mode

结果：

all

如果您不知道参数的准确名称，您可以使用以下命令，然后所有以该前缀为前缀的参数的值都会被列出。

./bin/kylin.sh org.apache.kylin.tool.KylinConfigCLI <prefix>.

例如：

./bin/kylin.sh org.apache.kylin.tool.KylinConfigCLI kylin.job.

结果：

max-concurrent-jobs=10
retry=3
sampling-percentage=100

CubeMetaExtractor.java

作用

CubeMetaExtractor.java 用于提取与 cube 相关的信息以达到调试/分发的目的。

如何使用

类名后至少写两个参数。

./bin/kylin.sh org.apache.kylin.tool.CubeMetaExtractor -<conf_name> <conf_value> -destDir <your_dest_dir>

例如：

./bin/kylin.sh org.apache.kylin.tool.CubeMetaExtractor -cube querycube -destDir /root/newconfigdir1

结果：
命令执行成功后，您想要抽取的 cube / project / hybrid 将会存在于您指定的 destDir 目录中。

下面会列出所有支持的参数：

Parameter	Description
allProjects	Specify realizations in all projects to extract
compress	Specify whether to compress the output with zip. Default true.
cube	Specify which Cube to extract
destDir	(Required) Specify the dest dir to save the related information
hybrid	Specify which hybrid to extract
includeJobs	Set this to true if want to extract job info/outputs too. Default false
includeSegmentDetails	Set this to true if want to extract segment details too, such as dict, tablesnapshot. Default false
includeSegments	Set this to true if want extract the segments info. Default true
onlyOutput	When include jobs, only extract output of job. Default true
packagetype	Specify the package type
project	Specify realizations in which project to extract
submodule	Specify whether this is a submodule of other CLI tool. Default false.

CubeMetaIngester.java

作用

CubeMetaIngester.java 将提取的 cube 注入到另一个 metadata store 中。目前其只支持注入 cube。

如何使用

类名后至少写两个参数。请确保您想要注入的 cube 在要注入的 project 中不存在。注意：zip 文件解压后必须只能包含一个目录。

./bin/kylin.sh org.apache.kylin.tool.CubeMetaIngester -project <target_project> -srcPath <your_src_dir>

例如：

./bin/kylin.sh org.apache.kylin.tool.CubeMetaIngester -project querytest -srcPath /root/newconfigdir1/cubes.zip

结果：
命令执行成功后，您想要注入的 cube 将会存在于您指定的 srcPath 目录中。

下面会列出所有支持的参数：

Parameter	Description
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	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	(Required) Specify the target project for the new cubes.
srcPath	(Required) Specify the path to the extracted Cube metadata zip file.

CubeMigrationCLI.java

作用

CubeMigrationCLI.java 用于迁移 cubes。例如：将 cube 从测试环境迁移到生产环境。请注意，不同的环境是共享相同的 Hadoop 集群，包括 HDFS，HBase 和 HIVE。此 CLI 不支持跨 Hadoop 集群的数据迁移。

如何使用

前八个参数必须有且次序不能改变。

./bin/kylin.sh org.apache.kylin.tool.CubeMigrationCLI <srcKylinConfigUri> <dstKylinConfigUri> <cubeName> <projectName> <copyAclOrNot> <purgeOrNot> <overwriteIfExists> <realExecute> <migrateSegmentOrNot>

例如：

./bin/kylin.sh org.apache.kylin.tool.CubeMigrationCLI kylin-qa:7070 kylin-prod:7070 kylin_sales_cube learn_kylin true false false true false

命令执行成功后，请 reload metadata，您想要迁移的 cube 将会存在于迁移后的 project 中。

下面会列出所有支持的参数：
　如果您使用 cubeName 这个参数，但想要迁移的 cube 所对应的 model 在要迁移的环境中不存在，model 的数据也会迁移过去。
　如果您将 overwriteIfExists 设置为 false，且该 cube 已存在于要迁移的环境中，当您运行命令，cube 存在的提示信息将会出现。
　如果您将 migrateSegmentOrNot 设置为 true，请保证 Kylin metadata 的 HDFS 目录存在且 Cube 的状态为 READY。

Parameter	Description
srcKylinConfigUri	The URL of the source environment’s Kylin configuration. It can be `host:7070`, or an absolute file path to the `kylin.properties`.
dstKylinConfigUri	The URL of the target environment’s Kylin configuration.
cubeName	the name of Cube to be migrated.(Make sure it exist)
projectName	The target project in the target environment.(Make sure it exist)
copyAclOrNot	`true` or `false`: whether copy Cube ACL to target environment.
purgeOrNot	`true` or `false`: whether purge the Cube from src server after the migration.
overwriteIfExists	`true` or `false`: overwrite cube if it already exists in the target environment.
realExecute	`true` or `false`: if false, just print the operations to take, if true, do the real migration.
migrateSegmentOrNot	(Optional) true or false: whether copy segment data to target environment. Default true.

CubeMigrationCheckCLI.java

作用

CubeMigrationCheckCLI.java 用于在迁移 Cube 之后检查“KYLIN_HOST”属性是否与 dst 中所有 Cube segment 对应的 HTable 的 MetadataUrlPrefix 一致。CubeMigrationCheckCLI.java 会在 CubeMigrationCLI.java 中被调用，通常不单独使用。

如何使用

./bin/kylin.sh org.apache.kylin.tool.CubeMigrationCheckCLI -fix <conf_value> -dstCfgUri <dstCfgUri_value> -cube <cube_name>

例如：

./bin/kylin.sh org.apache.kylin.tool.CubeMigrationCheckCLI -fix true -dstCfgUri kylin-prod:7070 -cube querycube

下面会列出所有支持的参数：

Parameter	Description
fix	Fix the inconsistent Cube segments’ HOST, default false
dstCfgUri	The KylinConfig of the Cube’s new home
cube	The name of Cube migrated