---

layout: dev title: 开发 JDBC 数据源 categories: development permalink: /cn/development/datasource_sdk.html

自 Apache Kylin v2.6.0 起有效

Data source SDK

自 Apache Kylin v2.6.0 起，我们提供一套新的数据源框架 Data source SDK，使用框架提供的 API，开发者可以很轻松实现一个新的数据源，并且适配 SQL 方言。

如何开发

实现新数据源的配置

Data source SDK 提供转换的机制，框架里预定义一个配置文件 default.xml 对应 ANSI SQL 方言。

开发者不需要编码，只需要为新的数据源新建一个配置文件 {dialect}.xml。

配置文件结构：

• 根节点：

<DATASOURCE_DEF NAME="kylin" ID="mysql" DIALECT="mysql"/>

ID 的值通常和配置文件的名字相同。
DIALECT 的值的定义主要是为了区分不同数据库对于标识符的引用。
举个例子 Mysql 使用 ``，Microsoft sql server 使用 []。 Kylin 里定义的 DIALECT 和 Apache Calcite 里定义 DIALECT 的对应关系：

• 属性节点： 定义方言的属性。

• 方法节点： 开发者可以根据数据源方言定义方法的实现。 比如，我们想要实现 Greenplum 作为数据源，但是 Greenplum 不支持 TIMESTAMPDIFF 方法，那我们就可以在 greenplum.xml 里面定义 ：

<FUNCTION_DEF ID="64" EXPRESSION="(CAST($1 AS DATE) - CAST($0 AS DATE))"/>

对比在 default.xml 定义：

<FUNCTION_DEF ID="64" EXPRESSION="TIMESTAMPDIFF(day, $0, $1)"/>

Data source SDK 可以把 default 里定义相同 function id 方法转换成目标方言里的定义。

• 类型节点： 开发者可以根据数据源方言定义数据类型。 还是拿 Greenplum 作为例子，Greenplum 支持 BIGINT 而不是 LONG，那我们可以在 greenplum.xml 定义：

<TYPE_DEF ID="Long" EXPRESSION="BIGINT"/>

对比在 default.xml 定义：

<TYPE_DEF ID="Long" EXPRESSION="LONG"/>

Data source SDK 可以把 default 里定义相同 type id 方法转换成目标方言里的定义。

Adaptor

Adaptor 提供一系列的 API 比如从数据源获取元数据、数据等。
Data source SDK 提供了默认的实现，开发者可以创建一个类继承它，并且有自己的实现。

org.apache.kylin.sdk.datasource.adaptor.DefaultAdaptor

Adaptor 还预留一个方法 fixSql(String sql). 如果根据配置文件转换之后的 SQL 还是和目标方言有些适配问题，开发者可以去实现这个方法做 SQL 最后的修改。

部署

一些新的配置：
{% highlight Groff markup %} kylin.query.pushdown.runner-class-name=org.apache.kylin.query.pushdown.PushdownRunnerSDKImpl kylin.source.default=16 kylin.source.jdbc.dialect={JDBC 方言} kylin.source.jdbc.adaptor={JDBC 连接的数据源对应的适配器类名} kylin.source.jdbc.user={JDBC 连接用户名} kylin.source.jdbc.pass={JDBC 连接密码} kylin.source.jdbc.connection-url={JDBC 连接字符串} kylin.source.jdbc.driver={JDBC 驱动类名} {% endhighlight %}

使用 MySQL 作为例子: {% highlight Groff markup %} kylin.query.pushdown.runner-class-name=org.apache.kylin.query.pushdown.PushdownRunnerSDKImpl kylin.source.default=16 kylin.source.jdbc.dialect=mysql kylin.source.jdbc.adaptor=org.apache.kylin.sdk.datasource.adaptor.MysqlAdaptor kylin.source.jdbc.user={mysql 用户名} kylin.source.jdbc.pass={mysql 用户密码} kylin.source.jdbc.connection-url=jdbc:mysql://{主机url}:3306/{数据库名称} kylin.source.jdbc.driver=com.mysql.jdbc.Driver {% endhighlight %}

新增加的 {dialect}.xml 放置在 $KYLIN_HOME/conf/datasource 目录下。 新开发的 Adaptor 打成 jar 包后放置在在 $KYLIN_HOME/ext 目录下。

其余的配置和更早的 JDBC 连接方式一致，请参考 setup_jdbc_datasource。