You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@linkis.apache.org by ca...@apache.org on 2023/03/09 12:17:41 UTC
[linkis-website] branch dev updated: add linkis-integration-with-oceanbase blog (#687)
This is an automated email from the ASF dual-hosted git repository.
casion pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/linkis-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 416d48ab8e add linkis-integration-with-oceanbase blog (#687)
416d48ab8e is described below
commit 416d48ab8e75fb658cb99a33956e3748f8370e9e
Author: zero <wa...@alibaba-inc.com>
AuthorDate: Thu Mar 9 20:17:35 2023 +0800
add linkis-integration-with-oceanbase blog (#687)
* add linkis-integration-with-oceanbase blog
---
.../img/ds-manage-en.png | Bin 0 -> 79229 bytes
.../img/new-en.png | Bin 0 -> 51810 bytes
.../img/ob-conn.png | Bin 0 -> 26485 bytes
.../img/ob-test-en.png | Bin 0 -> 50042 bytes
.../img/publish-1-en.png | Bin 0 -> 32398 bytes
.../img/publish-2-en.png | Bin 0 -> 15267 bytes
.../img/show-status-en.png | Bin 0 -> 70791 bytes
.../index.md | 98 +++++++++++++++++++++
.../img/ds-manage-zh.png | Bin 0 -> 88593 bytes
.../img/new-zh.png | Bin 0 -> 54629 bytes
.../img/ob-conn.png | Bin 0 -> 26485 bytes
.../img/ob-test-zh.png | Bin 0 -> 49104 bytes
.../img/publish-1-zh.png | Bin 0 -> 36343 bytes
.../img/publish-2-zh.png | Bin 0 -> 14699 bytes
.../img/show-status-zh.png | Bin 0 -> 72078 bytes
.../index.md | 98 +++++++++++++++++++++
16 files changed, 196 insertions(+)
diff --git a/blog/2023-03-08-linkis-integration-with-oceanbase/img/ds-manage-en.png b/blog/2023-03-08-linkis-integration-with-oceanbase/img/ds-manage-en.png
new file mode 100644
index 0000000000..0e10e46cec
Binary files /dev/null and b/blog/2023-03-08-linkis-integration-with-oceanbase/img/ds-manage-en.png differ
diff --git a/blog/2023-03-08-linkis-integration-with-oceanbase/img/new-en.png b/blog/2023-03-08-linkis-integration-with-oceanbase/img/new-en.png
new file mode 100644
index 0000000000..344ac056e2
Binary files /dev/null and b/blog/2023-03-08-linkis-integration-with-oceanbase/img/new-en.png differ
diff --git a/blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-conn.png b/blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-conn.png
new file mode 100644
index 0000000000..603b82de73
Binary files /dev/null and b/blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-conn.png differ
diff --git a/blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-test-en.png b/blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-test-en.png
new file mode 100644
index 0000000000..7dddc295b6
Binary files /dev/null and b/blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-test-en.png differ
diff --git a/blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-1-en.png b/blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-1-en.png
new file mode 100644
index 0000000000..0b331e8e1b
Binary files /dev/null and b/blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-1-en.png differ
diff --git a/blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-2-en.png b/blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-2-en.png
new file mode 100644
index 0000000000..04e48709f2
Binary files /dev/null and b/blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-2-en.png differ
diff --git a/blog/2023-03-08-linkis-integration-with-oceanbase/img/show-status-en.png b/blog/2023-03-08-linkis-integration-with-oceanbase/img/show-status-en.png
new file mode 100644
index 0000000000..f5c0ebf53a
Binary files /dev/null and b/blog/2023-03-08-linkis-integration-with-oceanbase/img/show-status-en.png differ
diff --git a/blog/2023-03-08-linkis-integration-with-oceanbase/index.md b/blog/2023-03-08-linkis-integration-with-oceanbase/index.md
new file mode 100644
index 0000000000..cddfae6e47
--- /dev/null
+++ b/blog/2023-03-08-linkis-integration-with-oceanbase/index.md
@@ -0,0 +1,98 @@
+---
+title: Linkis 1.3.2 Integration with OceanBase
+sidebar_position: 3
+---
+
+This article mainly introduces the integration of OceanBase database in `Linkis` 1.3.2 version. OceanBase database is compatible with most functions and syntax of MySQL 5.7/8.0. Therefore, the OceanBase database can be used as MySQL.
+
+## 1. Preparations
+### 1.1 Environment installation
+
+Install and deploy the OceanBase database, see [Quick experience](https://en.oceanbase.com/docs/community-observer-en-10000000000829647)
+
+### 1.2 Environment Verification
+You can use the MySQL command to verify the installation of the OceanBase database.
+```sql
+mysql -h${ip} -P${port} -u${username} -p${password} -D${db_name}
+```
+The connection is successful as shown in the figure below:
+
+
+## 2. Linkis submits OceanBase database tasks
+### 2.1 Submit tasks through the shell
+shell
+
+```shell
+ sh ./bin/linkis-cli -engineType jdbc-4 -codeType jdbc -code "show tables" -submitUser hadoop -proxyUser hadoop -runtimeMap wds.linkis.jdbc.connect.url=jdbc:mysql://${ip} :${port}/${db_name} -runtimeMap wds.linkis.jdbc.driver=com.mysql.jdbc.Driver -runtimeMap wds.linkis.jdbc.username=${username} -runtimeMap wds.linkis.jdbc.password =${password}
+```
+
+### 2.2 Submit tasks through Linkis SDK
+`Linkis` provides `SDK` of `Java` and `Scala` to submit tasks to `Linkis` server. For details, please refer to [JAVA SDK Manual](/docs/latest/user-guide/sdk-manual). For `OceanBase` tasks, you only need to modify `EngineConnType` and `CodeType` parameters in `Demo`:
+```java
+Map<String, Object> labels = new HashMap<String, Object>();
+labels.put (LabelKeyConstant.ENGINE_TYPE_KEY, "jdbc-4"); // required engineType Label
+labels.put(LabelKeyConstant.USER_CREATOR_TYPE_KEY, "hadoop-IDE");// required execute user and creator
+labels.put(LabelKeyConstant.CODE_TYPE_KEY, "jdbc"); // required codeType
+```
+
+### 2.3 Multi-data source support
+Address: Login Management Platform --> Data Source Management
+
+Step 1: Create a new data source
+
+
+
+
+
+Step 2: Connection test
+
+Click Test Connect button to test
+
+
+Step 3: Publish data source
+
+
+
+
+
+Step 4: Submit the OceanBase task by specifying the data source name
+
+Request URL: `http://${gateway_url}:${port}/api/rest_j/v1/entrance/submit` Request
+
+method: POST
+
+Request parameter:
+```json
+{
+ "executionContent": {
+ "code": "show databases",
+ "runType": "jdbc"
+ },
+ "params": {
+ "variable": {},
+ "configuration": {
+ "startup": {},
+ "runtime": {
+ "wds.linkis.engine.runtime.datasource": "ob-test"
+ }
+ }
+ },
+ "labels": {
+ "engineType": "jdbc-4"
+ }
+}
+```
+Response：
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 93,
+ "execID": "exec_id018017linkis-cg-entrance000830fb1364:9104IDE_hadoop_jdbc_0"
+ }
+}
+```
+
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/ds-manage-zh.png b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/ds-manage-zh.png
new file mode 100644
index 0000000000..499915d8e9
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/ds-manage-zh.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/new-zh.png b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/new-zh.png
new file mode 100644
index 0000000000..d70d668603
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/new-zh.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-conn.png b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-conn.png
new file mode 100644
index 0000000000..603b82de73
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-conn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-test-zh.png b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-test-zh.png
new file mode 100644
index 0000000000..cda6281823
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/ob-test-zh.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-1-zh.png b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-1-zh.png
new file mode 100644
index 0000000000..040e0e9141
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-1-zh.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-2-zh.png b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-2-zh.png
new file mode 100644
index 0000000000..69f08b982e
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/publish-2-zh.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/show-status-zh.png b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/show-status-zh.png
new file mode 100644
index 0000000000..7d6c974626
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/img/show-status-zh.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/index.md b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/index.md
new file mode 100644
index 0000000000..0e01d17d8c
--- /dev/null
+++ b/i18n/zh-CN/docusaurus-plugin-content-blog/2023-03-08-linkis-integration-with-oceanbase/index.md
@@ -0,0 +1,98 @@
+---
+title: Linkis 1.3.2 整合OceanBase
+sidebar_position: 3
+---
+
+本文主要介绍在 `Linkis` 1.3.2 版本中，整合 OceanBase 数据库。 OceanBase 数据库兼容 MySQL 5.7/8.0 的绝大部分功能和语法。因此可以将 OceanBase 数据库当成 MySQL 来使用。
+
+## 1. 准备工作
+### 1.1 环境安装
+
+安装部署 OceanBase 数据库，参看[快速体验OceanBase](https://www.oceanbase.com/docs/community-observer-cn-10000000000901197)
+
+### 1.2 环境验证
+可以使用 MySQL 命令验证 OceanBase 数据库安装情况。
+```sql
+mysql -h${ip} -P${port} -u${username} -p${password} -D${db_name}
+```
+连接成功如下图所示：
+
+
+## 2. Linkis提交 OceanBase 数据库任务
+### 2.1 通过 shell 提交任务
+```shell
+ sh ./bin/linkis-cli -engineType jdbc-4 -codeType jdbc -code "show tables" -submitUser hadoop -proxyUser hadoop -runtimeMap wds.linkis.jdbc.connect.url=jdbc:mysql://${ip}:${port}/${db_name} -runtimeMap wds.linkis.jdbc.driver=com.mysql.jdbc.Driver -runtimeMap wds.linkis.jdbc.username=${username} -runtimeMap wds.linkis.jdbc.password=${password}
+```
+
+### 2.2 通过 Linkis SDK 提交任务
+`Linkis` 提供了 `Java` 和 `Scala` 的 `SDK` 向 `Linkis` 服务端提交任务。具体可以参考 [JAVA SDK Manual](/docs/latest/user-guide/sdk-manual)。对于 `OceanBase` 任务您只需要修改 `Demo` 中的 `EngineConnType` 和 `CodeType` 参数即可:
+```java
+Map<String, Object> labels = new HashMap<String, Object>();
+labels.put(LabelKeyConstant.ENGINE_TYPE_KEY, "jdbc-4"); // required engineType Label
+labels.put(LabelKeyConstant.USER_CREATOR_TYPE_KEY, "hadoop-IDE");// required execute user and creator
+labels.put(LabelKeyConstant.CODE_TYPE_KEY, "jdbc"); // required codeType
+```
+
+### 2.3 多数据源支持
+地址：登陆管理台-->数据源管理
+
+步骤1：新建数据源
+
+
+
+
+
+步骤2：连接测试
+
+点击测试连接按钮进行测试
+
+
+步骤3：发布数据源
+
+
+
+
+
+步骤4：通过指定数据源名称提交 OceanBase 任务
+
+请求URL：`http://${gateway_url}:${port}/api/rest_j/v1/entrance/submit`
+
+请求方式：POST
+
+请求参数：
+```json
+{
+ "executionContent": {
+ "code": "show databases",
+ "runType": "jdbc"
+ },
+ "params": {
+ "variable": {},
+ "configuration": {
+ "startup": {},
+ "runtime": {
+ "wds.linkis.engine.runtime.datasource": "ob-test"
+ }
+ }
+ },
+ "labels": {
+ "engineType": "jdbc-4"
+ }
+}
+```
+响应结果：
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 93,
+ "execID": "exec_id018017linkis-cg-entrance000830fb1364:9104IDE_hadoop_jdbc_0"
+ }
+}
+```
+管理台查看任务执行情况：
+
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org