数据源功能使用

数据源功能使用

介绍一下如何使用1.1.0版本的新特性功能数据源

1.数据源功能介绍

1.1 概念

数据源:我们将能提供数据存储的数据库服务称为数据库，如mysql/hive/kafka，数据源定义的是连接到实际数据库的配置信息，配置信息主要是是连接需要的地址，用户认证信息，连接参数等。存储与linkis的数据库的linkisps_dm_datasource*相关的表中
元数据:单指数据库的元数据，是指定义数据结构的数据，数据库各类对象结构的数据。例如数据库中的数据库名，表名，列名，字段的长度、类型等信息数据。

1.2 三个主要模块

linkis-datasource-client 客户端模块，用户数据源的基本管理的DataSourceRemoteClient，以及进行元数据的查询操作的MetaDataRemoteClient.

linkis-datasource-manager-server 数据源管理模块,服务名ps-data-source-manager。对数据源的进行基本的管理，对外提供数据源的新增，查询，修改，连接测试等http接口。对内提供了rpc服务，方便元数据查询模块通过rpc调用，查询数据库建立连接需要的必要信息。

http接口文档
http接口类 org.apache.linkis.metadatamanager.server.restful
rpc接口类 org.apache.linkis.metadatamanager.server.receiver

linkis-metedata-manager-server 元数据查询模块,服务名ps-metadatamanager。提供对数据库元数据的基本查询功能,对外提供了http接口，对内提供了rpc服务，方便数据源管理模块，通过rpc调用，进行该数据源的连通性测试。

http接口文档
http接口类 org.apache.linkis.datasourcemanager.core.restful
rpc接口类 org.apache.linkis.datasourcemanager.core.receivers

1.3 处理逻辑

1.3.1 LinkisDataSourceRemoteClient

功能结构图如下:

LinkisDataSourceRemoteClient客户端根据请求参数，组装http请求，
HTTP请求发送到linkis-ps-data-source-manager
linkis-ps-data-source-manager 会进行基本参数校验，部分接口只能管理员角色能操作
linkis-ps-data-source-manager 与数据库进行基本的数据操作
linkis-ps-data-source-manager 提供的数据源测试连接的接口内部通过rpc方式，调用ps-metadatamanager方法进行连接测试
http请求处理后的数据结果，会通过注解DWSHttpMessageResult功能，进行结果集到实体类的映射转化

LinkisDataSourceRemoteClient接口

GetAllDataSourceTypesResult getAllDataSourceTypes(GetAllDataSourceTypesAction) 查询所有数据源类型
QueryDataSourceEnvResult queryDataSourceEnv(QueryDataSourceEnvAction) 查询数据源可使用的集群配置信息
GetInfoByDataSourceIdResult getInfoByDataSourceId(GetInfoByDataSourceIdAction): 通过数据源id查询数据源信息
QueryDataSourceResult queryDataSource(QueryDataSourceAction) 查询数据源信息
GetConnectParamsByDataSourceIdResult getConnectParams(GetConnectParamsByDataSourceIdAction) 获取连接配置参数
CreateDataSourceResult createDataSource(CreateDataSourceAction) 创建数据源
DataSourceTestConnectResult getDataSourceTestConnect(DataSourceTestConnectAction) 测试数据源是否能正常建立连接
DeleteDataSourceResult deleteDataSource(DeleteDataSourceAction) 删除数据源
ExpireDataSourceResult expireDataSource(ExpireDataSourceAction) 设置数据源为过期状态
GetDataSourceVersionsResult getDataSourceVersions(GetDataSourceVersionsAction) 查询数据源配置的版本列表
PublishDataSourceVersionResult publishDataSourceVersion(PublishDataSourceVersionAction) 发布数据源配置版本
UpdateDataSourceResult updateDataSource(UpdateDataSourceAction) 更新数据源
UpdateDataSourceParameterResult updateDataSourceParameter(UpdateDataSourceParameterAction) 更新数据源配置参数
GetKeyTypeDatasourceResult getKeyDefinitionsByType(GetKeyTypeDatasourceAction) 查询某数据源类型需要的配置属性

1.3.2 LinkisMetaDataRemoteClient

功能结构图如下:

LinkisMetaDataRemoteClient客户端，根据请求参数，组装http请求，
HTTP请求发送到ps-metadatamanager
ps-metadatamanager 会进行基本参数校验，
请求会根据参数 datasourceId，发送RPC请求到linkis-ps-data-source-manager，获取该数据源的类型，连接参数如用户名密码等信息
拿到连接需要的信息后，根据数据源类型，加载对应目录下的lib包，通过反射机制调用对应的函数方法，从而查询到元数据信息
http请求处理后的数据结果，会通过注解DWSHttpMessageResult功能，进行结果集到实体类的映射转化

LinkisMetaDataRemoteClient接口

MetadataGetDatabasesResult getDatabases(MetadataGetDatabasesAction) 查询数据库列表
MetadataGetTablesResult getTables(MetadataGetTablesAction) 查询table数据
MetadataGetTablePropsResult getTableProps(MetadataGetTablePropsAction)
MetadataGetPartitionsResult getPartitions(MetadataGetPartitionsAction) 查询分区表
MetadataGetColumnsResult getColumns(MetadataGetColumnsAction) 查询数据表字段

1.3 源码模块目录结构

1. linkis-public-enhancements/linkis-datasource

4. ├── linkis-datasource-client //客户端代码
5. ├── linkis-datasource-manager //数据源管理模块
6. │   ├── common  //数据源管理公共模块
7. │   └── server  //数据源管理服务模块
8. ├── linkis-metadata //旧版本已有的模块，保留
9. ├── linkis-metadata-manager //元数据查询模块
10. │   ├── common //元数据查询公共模块
11. │   ├── server //元数据查询服务模块
12. │   └── service //支持的数据源类型
13. │       ├── elasticsearch
14. │       ├── hive
15. │       ├── kafka
16. │       └── mysql

1.4 安装包目录结构

1. /lib/linkis-public-enhancements/

4. ├── linkis-ps-data-source-manager
5. ├── linkis-ps-metadatamanager
6. │   └── service
7. │       ├── elasticsearch
8. │       ├── hive
9. │       ├── kafka
10. │       └── mysql

wds.linkis.server.mdm.service.lib.dir 控制反射调用时加载的类路径，参数默认值是/lib/linkis-public-enhancements/linkis-ps-metadatamanager/service

1.5 配置参数

参见调优排障>参数列表#datasource配置参数

2. 数据源功能的启用

linkis的启动脚本中默认不会启动数据源相关的服务两个服务（ps-data-source-manager，ps-metadatamanager），如果想使用数据源服务，可以通过如下方式进行开启: 修改$LINKIS_CONF_DIR/linkis-env.sh中的 export ENABLE_METADATA_MANAGER=true值为true。通过linkis-start-all.sh/linkis-stop-all.sh 进行服务启停时，会进行数据源服务的启动与停止。

通过eureka页面查看服务是否正常启动

注意" class="reference-link">数据源功能使用 - 图6注意

1.linkis的管理台web版本需要配合升级至1.1.0版本才能在linkis管理台上使用数据源管理页面功能。
2.目前数据源中已有mysql/hive/kafak/elasticsearch的jar包, 但是kafak/elasticsearch数据源未经过严格的测试，不保证功能的完整可用性。

3. 数据源的使用

数据源的使用分为三步:

step 1. 创建数据源/配置连接参数
step 2. 发布数据源,选择要使用的连接配置版本
step 3. 数据源使用，查询元数据信息 ,hive/kafka/elasticsearch配置是关联对应的集群环境配置.

3.1 Mysql 数据源

3.1.1 通过管理台创建

只能创建配置数据源，以及测试数据源是否能正常连接，无法进行直接进行元数据查询

数据源管理>新增数据源>选择mysql类型

输入相关的配置信息

录入成功后可以通过连接测试验证是否能够正常进行连接

注意" class="reference-link">数据源功能使用 - 图8注意

通过管理台创建的数据源归属的system是Linkis
创建成功后，还需要进行发布(发布时进行配置参数版本的切换和选择)，才能被正常使用

配置的发布(使用那个配置进行数据源的建连):

点击版本后再弹窗页面选择合适的配置进行发布

3.1.2 使用客户端

scala 代码示例:

1. package org.apache.linkis.datasource.client
2. import java.util
3. import java.util.concurrent.TimeUnit

6. import org.apache.linkis.common.utils.JsonUtils
7. import org.apache.linkis.datasource.client.impl.{LinkisDataSourceRemoteClient, LinkisMetaDataRemoteClient}
8. import org.apache.linkis.datasource.client.request._
9. import org.apache.linkis.datasource.client.response._
10. import org.apache.linkis.datasourcemanager.common.domain.DataSource
11. import org.apache.linkis.httpclient.dws.authentication.StaticAuthenticationStrategy
12. import org.apache.linkis.httpclient.dws.config.DWSClientConfigBuilder
13. import org.junit.jupiter.api.{Disabled, Test}

16. object TestMysqlClient {

19. val gatewayUrl = "http://127.0.0.1:9001"
20. val clientConfig = DWSClientConfigBuilder.newBuilder
21. .addServerUrl(gatewayUrl)
22. .connectionTimeout(30000)
23. .discoveryEnabled(false)
24. .discoveryFrequency(1, TimeUnit.MINUTES)
25. .loadbalancerEnabled(true)
26. .maxConnectionSize(1)
27. .retryEnabled(false)
28. .readTimeout(30000)
29. .setAuthenticationStrategy(new StaticAuthenticationStrategy)
30. .setAuthTokenKey("hadoop")
31. .setAuthTokenValue("xxxxx")
32. .setDWSVersion("v1")

35. val dataSourceclient = new LinkisDataSourceRemoteClient(clientConfig.build())

38. val clientConfig2 = DWSClientConfigBuilder.newBuilder
39. .addServerUrl(gatewayUrl)
40. .connectionTimeout(30000)
41. .discoveryEnabled(false)
42. .discoveryFrequency(1, TimeUnit.MINUTES)
43. .loadbalancerEnabled(true)
44. .maxConnectionSize(1)
45. .retryEnabled(false)
46. .readTimeout(30000)
47. .setAuthenticationStrategy(new StaticAuthenticationStrategy)
48. .setAuthTokenKey("hadoop")
49. .setAuthTokenValue("xxxxx")
50. .setDWSVersion("v1")

53. val metaDataClient = new LinkisMetaDataRemoteClient(clientConfig2.build())

56. @Test
57. @Disabled
58. def testCreateDataSourceMysql: Unit = {
59. val user = "hadoop"
60. val system = "Linkis"

63. //创建数据源
64. val dataSource = new DataSource();
65. dataSource.setDataSourceName("for-mysql-test")
66. dataSource.setDataSourceDesc("this is for mysql test")
67. dataSource.setCreateSystem(system)
68. dataSource.setDataSourceTypeId(1L)

71. val map = JsonUtils.jackson.readValue(JsonUtils.jackson.writeValueAsString(dataSource), new util.HashMap[String, Any]().getClass)
72. val createDataSourceAction: CreateDataSourceAction = CreateDataSourceAction.builder()
73. .setUser(user)
74. .addRequestPayloads(map)
75. .build()
76. val createDataSourceResult: CreateDataSourceResult = dataSourceclient.createDataSource(createDataSourceAction)
77. val dataSourceId = createDataSourceResult.getInsertId

82. //设置连接参数
83. val params = new util.HashMap[String, Any]

86. val connectParams = new util.HashMap[String, Any]
87. connectParams.put("host", "127.0.0.1")
88. connectParams.put("port", "36000")
89. connectParams.put("username", "db username")
90. connectParams.put("password", "db password")

93. params.put("connectParams", connectParams)
94. params.put("comment", "init")

97. val updateParameterAction: UpdateDataSourceParameterAction = UpdateDataSourceParameterAction.builder()
98. .setUser(user)
99. .setDataSourceId(dataSourceId)
100. .addRequestPayloads(params)
101. .build()
102. val updateParameterResult: UpdateDataSourceParameterResult = dataSourceclient.updateDataSourceParameter(updateParameterAction)

105. val version: Long = updateParameterResult.getVersion

108. //发布配置版本
109. dataSourceclient.publishDataSourceVersion(
110. PublishDataSourceVersionAction.builder()
111. .setDataSourceId(dataSourceId)
112. .setUser(user)
113. .setVersion(version)
114. .build())

117. //使用示例
118. val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
119. .setUser(user)
120. .setDataSourceId(dataSourceId)
121. .setSystem(system)
122. .build()
123. val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)

126. val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
127. .setUser(user)
128. .setDataSourceId(dataSourceId)
129. .setDatabase("linkis")
130. .setSystem(system)
131. .build()
132. val metadataGetTablesResult: MetadataGetTablesResult = metaDataClient.getTables(metadataGetTablesAction)

135. val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
136. .setUser(user)
137. .setDataSourceId(dataSourceId)
138. .setDatabase("linkis")
139. .setSystem(system)
140. .setTable("linkis_datasource")
141. .build()
142. val metadataGetColumnsResult: MetadataGetColumnsResult = metaDataClient.getColumns(metadataGetColumnsAction)

144. }
145. }

3.2 Hive 数据源

3.2.1 通过管理台创建

只能创建配置数据源，以及测试数据源是否能正常连接，无法进行直接进行元数据查询

先需要进行集群环境信息的配置

表linkis_ps_dm_datasource_env

1. INSERT INTO `linkis_ps_dm_datasource_env`
2. (`env_name`, `env_desc`, `datasource_type_id`, `parameter`,`create_user`,`modify_user`)
3. VALUES
4. ('testEnv', '测试环境', 4,
5. '{\r\n    "uris": "thrift://clustername:9083",\r\n    "keytab": "4dd408ad-a2f9-4501-83b3-139290977ca2",\r\n    "principle":"hadoop@WEBANK.COM",\r\n    "hadoopConf":{"hive.metastore.execute.setugi":"true"}\r\n}',
6. 'user','user');

主键id作为envId，在建立连接时，需要通过此envId参数，获取集群配置相关信息。配置字段解释:

1. {
2. "uris": "thrift://clustername:9083", # 必选 如果未开启kerberos认证 下列[keytab][principle]参数可以为空
3. "keytab": "bml resource id",//keytab 存储再物料库中的resourceId,目前需要通过http接口手动上传。
4. "principle":"hadoop@WEBANK.COM" //认证的principle
5. "hadoopConf":{} //额外的连接参数 可选
6. }

keytab的resourceId获取方式，目前基础数据管理功能还在规划中，可以通过http接口请求获取到参考示例

1. curl --form "file=@文件路径"  \
2. --form system=子系统名   \
3. -H "Token-Code:认证token" \
4. -H "Token-User:认证用户名"  \
5. http://linkis-gatewayip:port/api/rest_j/v1/bml/upload

8. 示例:
9. curl --form "file=@/appcom/keytab/hadoop.keytab"  \
10. --form system=ABCD   \
11. -H "Token-Code:QML-AUTH" \
12. -H "Token-User:hadoop"  \
13. http://127.0.0.1:9001/api/rest_j/v1/bml/upload

16. 请求结果中的resourceId 即为对应的`bml resource id`值
17. {"method":"/bml/upload","status":0,"message":"The task of submitting and uploading resources was successful(提交上传资源任务成功)","data":{"resourceId":"6e4e54fc-cc97-4d0d-8d5e-a311129ec84e","version":"v000001","taskId":35}}

web端创建:

3.2.2 使用客户端

1. package org.apache.linkis.datasource.client

4. import java.util
5. import java.util.concurrent.TimeUnit

8. import org.apache.linkis.common.utils.JsonUtils
9. import org.apache.linkis.datasource.client.impl.{LinkisDataSourceRemoteClient, LinkisMetaDataRemoteClient}
10. import org.apache.linkis.datasource.client.request._
11. import org.apache.linkis.datasource.client.response._
12. import org.apache.linkis.datasourcemanager.common.domain.DataSource
13. import org.apache.linkis.httpclient.dws.authentication.StaticAuthenticationStrategy
14. import org.apache.linkis.httpclient.dws.config.DWSClientConfigBuilder
15. import org.junit.jupiter.api.{Disabled, Test}

18. object TestHiveClient {
19. val gatewayUrl = "http://127.0.0.1:9001"
20. val clientConfig = DWSClientConfigBuilder.newBuilder
21. .addServerUrl(gatewayUrl)
22. .connectionTimeout(30000)
23. .discoveryEnabled(false)
24. .discoveryFrequency(1, TimeUnit.MINUTES)
25. .loadbalancerEnabled(true)
26. .maxConnectionSize(1)
27. .retryEnabled(false)
28. .readTimeout(30000)
29. .setAuthenticationStrategy(new StaticAuthenticationStrategy)
30. .setAuthTokenKey("hadoop")
31. .setAuthTokenValue("xxxxx")
32. .setDWSVersion("v1")

35. val dataSourceclient = new LinkisDataSourceRemoteClient(clientConfig.build())

38. val clientConfig2 = DWSClientConfigBuilder.newBuilder
39. .addServerUrl(gatewayUrl)
40. .connectionTimeout(30000)
41. .discoveryEnabled(false)
42. .discoveryFrequency(1, TimeUnit.MINUTES)
43. .loadbalancerEnabled(true)
44. .maxConnectionSize(1)
45. .retryEnabled(false)
46. .readTimeout(30000)
47. .setAuthenticationStrategy(new StaticAuthenticationStrategy)
48. .setAuthTokenKey("hadoop")
49. .setAuthTokenValue("xxxxx")
50. .setDWSVersion("v1")

53. val metaDataClient = new LinkisMetaDataRemoteClient(clientConfig2.build())

58. @Test
59. @Disabled
60. def testCreateDataSourceMysql: Unit = {
61. val user = "hadoop"
62. val system = "Linkis"

65. //创建数据源
66. val dataSource = new DataSource();
67. dataSource.setDataSourceName("for-hive-test")
68. dataSource.setDataSourceDesc("this is for hive test")
69. dataSource.setCreateSystem(system)
70. dataSource.setDataSourceTypeId(4L)

73. val map = JsonUtils.jackson.readValue(JsonUtils.jackson.writeValueAsString(dataSource), new util.HashMap[String, Any]().getClass)
74. val createDataSourceAction: CreateDataSourceAction = CreateDataSourceAction.builder()
75. .setUser(user)
76. .addRequestPayloads(map)
77. .build()
78. val createDataSourceResult: CreateDataSourceResult = dataSourceclient.createDataSource(createDataSourceAction)
79. val dataSourceId = createDataSourceResult.getInsertId

82. //设置连接参数
83. val params = new util.HashMap[String, Any]
84. val connectParams = new util.HashMap[String, Any]
85. connectParams.put("envId", "3")
86. params.put("connectParams", connectParams)
87. params.put("comment", "init")

90. val updateParameterAction: UpdateDataSourceParameterAction = UpdateDataSourceParameterAction.builder()
91. .setUser(user)
92. .setDataSourceId(dataSourceId)
93. .addRequestPayloads(params)
94. .build()
95. val updateParameterResult: UpdateDataSourceParameterResult = dataSourceclient.updateDataSourceParameter(updateParameterAction)

98. val version: Long = updateParameterResult.getVersion

101. //发布配置版本
102. dataSourceclient.publishDataSourceVersion(
103. PublishDataSourceVersionAction.builder()
104. .setDataSourceId(dataSourceId)
105. .setUser(user)
106. .setVersion(version)
107. .build())

110. //使用示例
111. val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
112. .setUser(user)
113. .setDataSourceId(dataSourceId)
114. .setSystem(system)
115. .build()
116. val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)

119. val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
120. .setUser(user)
121. .setDataSourceId(dataSourceId)
122. .setDatabase("linkis_test_ind")
123. .setSystem(system)
124. .build()
125. val metadataGetTablesResult: MetadataGetTablesResult = metaDataClient.getTables(metadataGetTablesAction)

132. val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
133. .setUser(user)
134. .setDataSourceId(dataSourceId)
135. .setDatabase("linkis_test_ind")
136. .setSystem(system)
137. .setTable("test")
138. .build()
139. val metadataGetColumnsResult: MetadataGetColumnsResult = metaDataClient.getColumns(metadataGetColumnsAction)

142. }
143. }