配置SuperSet通过Kyuubi连接DLI进行数据查询和分析

操作流程

图1 操作流程

• 步骤1：安装并配置Kyuubi连接DLI：安装并配置Kyuubi，确保Kyuubi可以连接到DLI。
• 步骤2：安装SuperSet并配置数据连接驱动：配置Superset安装数据连接驱动。
• 步骤3：配置SuperSet连接kyuubi：在BI工具中创建一个新的数据连接，通过JDBC连接Kyuubi。

步骤1：安装并配置Kyuubi连接DLI

如需使用外网访问Kyuubi请确保弹性云服务器绑定弹性公网IP，并配置安全组入方向开启10009和3309端口。

1. 安装JDK。

   在安装和使用Kyuubi前，确保您的开发环境已安装JDK。

   Java SDK要求使用JDK1.8或更高版本。考虑到后续版本的兼容性，推荐使用1.8版本。

   1. 下载JDK。

      从Oracle官网下载并安装JDK1.8版本安装包。

      本例使用jdk-8u261-linux-x64.tar.gz。

   2. 将jdk上传到linux服务器对应的目录下并执行解压命令，此处上传到/usr/local目录下。

      sudo tar -xzf jdk-8u261-linux-x64.tar.gz -C /usr/local/

   3. 配置环境变量。

      编辑.bashrc或.profile文件，添加以下行：

      export JAVA_HOME=/usr/local/jdk-1.8.0_261
      export PATH=$PATH:$JAVA_HOME/bin

   4. 执行以下命令应用环境变量。

      source ~/.bashrc

   5. 执行命令java -version，检查是否安装成功，如下显示版本号信息说明java环境安装成功。

      java version "1.8.0_261"
      Java(TM) SE Runtime Environment (build 1.8.0_261-b12)
      Java HotSpot(TM) 64-Bit Server VM (build 25.261-b12, mixed mode)

2. 安装Kyuubi
   1. 访问Apache Kyuubi的下载Kyuubi安装包。了解更多Kyuubi安装操作。
   2. 解压下载的Kyuubi安装包。

      tar -xzf kyuubi-{version}-bin.tar.gz

   3. 配置环境变量（可选）：

      将Kyuubi的bin目录添加到PATH环境变量中，确保可以在任何位置调用Kyuubi的脚本。

3. 配置Kyuubi连接DLI
   1. 在Kyuubi的根目录下添加DLI驱动。

      在“DLI SDK DOWNLOAD”页面，单击Kyuubi驱动包链接，下载对应版本的驱动包。

      并将该驱动放在kyuubi根目录/externals/engines/jdbc。

      确保插件用户组和权限与其他Jar保持一致。

   2. 执行以下命令修改Kyuubi配置文件。

      cd $KYUUBI_HOME/confvi kyuubi-defaults.conf

      在kyuubi-defaults.conf 中追加如下配置：

      kyuubi.engine.jdbc.connection.url=jdbc:mysql://xxx:xxxkyuubi.engine.jdbc.connection.user=***kyuubi.engine.jdbc.connection.password=***kyuubi.engine.jdbc.type=doriskyuubi.engine.jdbc.driver.class=com.mysql.cj.jdbc.Driverkyuubi.engine.type=jdbc

      配置项说明请参考表1。

      表1 kyuubi配置参数说明

      配置项	说明	是否必选	示例
      kyuubi.engine.type	JDBC服务类型。这里请指定为dli。	是	jdbc
      kyuubi.engine.jdbc.type	引擎类型。请使用dli。	是	dli
      kyuubi.engine.jdbc.driver.class	连接JDBC服务使用的驱动类名。请使用com.huawei.dli.jdbc.DliDriver	是	com.huawei.dli.jdbc.DliDriver
      kyuubi.engine.jdbc.connection.url	JDBC服务连接的URL。 格式：jdbc:dli://{dliendpoint} /{projectId}	是	jdbc:dli://{dliendpoint} /{projectId}
      kyuubi.engine.jdbc.session.initialize.sql	用于指定在建立JDBC会话时执行的初始化SQL语句。	否	select 1 如果在DLI的管理控制台看到select 1，代表初始化成功。
      kyuubi.frontend.protocols	用于指定Kyuubi服务支持的前端协议。Kyuubi支持多种前端协议，允许用户通过不同的接口与Kyuubi进行交互。	是	mysql thrift_binary
      kyuubi.engine.dli.schema.show.name	用于指定当用户执行show schemas或show databases语句时，Kyuubi引擎如何展示数据源接口的模式名称。 true：表示在展示模式名称时，包含 DLI 的名称作为前缀。 false：表示在展示模式名称时，不包含 DLI 的名称。 例如如果配置为true，并且有一个DLI名称为 hive，那么在执行show schemas时，输出为hive.default的格式。 如果配置为false，输出为default的格式。	否	true false
      kyuubi.engine.dli.jdbc.connection.region	DLI的区域名称和服务名称。	是	regionname=ap-southeast-2
      kyuubi.engine.dli.jdbc.connection.queue	DLI服务的队列名称。	是	dli_test
      kyuubi.engine.dli.jdbc.connection.database	用于指定Kyuubi引擎通过JDBC连接到DLI数据源时默认使用的数据库名称。	是	tpch
      kyuubi.engine.dli.jdbc.connection.ak	AK/SK认证密钥。 如果使用AK/SK认证方式。	是	accesskey=your-access-key
      kyuubi.engine.dli.jdbc.connection.sk	DLI的区域名称和服务名称。 如果使用AK/SK认证方式时配置。	是	secretkey=your-secret-key
      kyuubi.engine.dli.jdbc.connection.project	DLI资源所在的项目ID。	是	0b33ea2a7e0010802fe4c009bb05076d
      kyuubi.engine.dli.sql.limit.time.sec	SQL查询的执行时间限制。 默认600s	否	300
      kyuubi.engine.dli.result.line.num.limit	SQL查询的返回的最大条数。 默认返回10万条。 配置为-1代表不限制返回的条数。	是	50000
      kyuubi.engine.dli.small.file.merge	配置是否开启小文件自动合并。默认为false，代表不开启。 true：开启 false：不开启	是	true
      kyuubi.engine.dli.bi.type	用于指定BI工具类型。 支持fine/ grafana/ superset/ tableau/ power/dbt/yongHong	是	fine
      kyuubi.engine.dli.boolean.type.to.int	定义DLI的Boolean类型数据是以1/0返回，还是true/false返回 当BI工具类型为Grafana时，需要设置为true。 true：按1/0返回（1：代表true，0：fales）。 false：按true/false返回。 默认取值false。	否	false
      kyuubi.engine.dli.set.conf.transform.to.annotation	支持在SQL中设置set spark参数。 PowerBI、FineBI、SpuerSet、DBT需要设置为true。	否	true
      kyuubi.engine.dli.set.conf.sql.suffix	支持在SQL中尾端设置set spark参数。 PowerBI、DBT需要设置为true。	否	true
      kyuubi.engine.dli.result.cache.enable	是否开启库表数据缓存，开启后自动缓存库表信息。默认为true。 true：开启 false：不开启	否	true
      kyuubi.engine.dli.cache.limit.line.num	配置缓存的最大条数。 默认返回10万条。 配置为-1代表不限制缓存的最大条数。	否	1000
      kyuubi.engine.dli.cache.time.sec	配置缓存的时间。 默认为1800s。	否	1800
      kyuubi.operation.incremental.collect	kyuubi会预加载select结果数据到缓存加快读取数据，数据量较大的场景防止内存OOM建议关闭。	否	false 配置为false代表关闭预加载。
      kyuubi.engine.jdbc.memory	jdbc engine进程内存 默认为1g，建议改成5g以上加大jdbc engine进程内存使用	否	5g

   3. 快速启动kyuubi。

      进入云服务器的根目录/bin执行以下命令启动kyuubi。

      cd /bin
      ./kyuubi start  restart

      连接成功后，可以执行SQL查询来测试Kyuubi与DLI的连接是否正常工作。

4. （可选）配置主机的host文件提高Kyuubi的访问效率

   为了提高Kyuubi的访问效率，建议在主机的/etc/hosts 配置Kyuubi主机IP的映射关系。

   1. 执行ifconfig查看主机IP地址。
      图2 查看主机IP地址
      
   2. 将该IP配置在/etc/host文件中。
      图3 在/etc/host文件中配置IP地址
      

步骤2：安装SuperSet并配置数据连接驱动

1. 下载并安装SuperSet。

   详细安装操作指导请参考安装SuperSet

   以Docker安装Superset为例：

   1. 安装Docker：

      确保当前主机系统上安装了Docker。

   2. 拉取Superset Docker镜像：

      docker pull apache/superset

   3. 启动Superset容器：

      docker run -p 8088:8088 apache/superset

      启动Superset容器，并将容器的8088端口映射到宿主机的8088端口。

   4. 访问Superset：

      在浏览器中访问 http://localhost:8088，并使用默认的用户名和密码登录（通常为 admin/admin）。

2. 下载数据驱动。获取Apach Hive驱动包，推荐使用pyhive 0.7.0版本。

   安装操作指导请参考安装Hive驱动。

步骤3：配置SuperSet连接kyuubi

1. 打开并登录Superset。
2. 单击“Data > Databases”。
3. 单击“Add Database”。

   在弹出的Database窗口中，选择在步骤步骤2：安装SuperSet并配置数据连接驱动安装的驱动。

4. 配置数据连接的信息。
   • DISPLAY NAME：自定义数据连接名称。
   • SQL ALCHEMY URI：配置数据连接的URL

     数据库类型://username:password@host:port/database

     本例：hive://username:password@100.xx.xxx.243:10009/tpch

   图4 SuperSet配置数据连接
   
5. 单击“TEST connection”测试数据源连接是否成功，如果连接正常单击“OK”保存连接。

常用操作：SQL作业参数设置

1. 确保kyuubi的/conf/kyuubi-defaults.conf配置打开如下参数开关。

   kyuubi.engine.dli.set.conf.transform.to.annotation=true

2. 在sql语句的末尾添加注解参数。

   set 参数
   示例：
   set dli.sql.current.database=tpch
   set dli.sql.shuffle.partitions=100

   图5 SuperSet参数配置示例
   

   在DLI的SQL编辑器的执行效果：Set参数会修改为注释提交到DLI侧执行。

   图6 在DLI的SQL编辑器查看配置的参数