diff --git a/src/.vuepress/public/img/table-dbeaver-1.png b/src/.vuepress/public/img/table-dbeaver-1.png new file mode 100644 index 000000000..37e2ce15d Binary files /dev/null and b/src/.vuepress/public/img/table-dbeaver-1.png differ diff --git a/src/.vuepress/public/img/table-dbeaver-2.png b/src/.vuepress/public/img/table-dbeaver-2.png new file mode 100644 index 000000000..f8e64dd10 Binary files /dev/null and b/src/.vuepress/public/img/table-dbeaver-2.png differ diff --git a/src/.vuepress/public/img/table-dbeaver-3.png b/src/.vuepress/public/img/table-dbeaver-3.png new file mode 100644 index 000000000..84fb53d66 Binary files /dev/null and b/src/.vuepress/public/img/table-dbeaver-3.png differ diff --git a/src/.vuepress/public/img/table-dbeaver-4.png b/src/.vuepress/public/img/table-dbeaver-4.png new file mode 100644 index 000000000..213dec911 Binary files /dev/null and b/src/.vuepress/public/img/table-dbeaver-4.png differ diff --git a/src/.vuepress/public/img/table-dbeaver-5.png b/src/.vuepress/public/img/table-dbeaver-5.png new file mode 100644 index 000000000..8f3b5af33 Binary files /dev/null and b/src/.vuepress/public/img/table-dbeaver-5.png differ diff --git a/src/.vuepress/public/img/table-dbeaver-6.png b/src/.vuepress/public/img/table-dbeaver-6.png new file mode 100644 index 000000000..b7fabb7ce Binary files /dev/null and b/src/.vuepress/public/img/table-dbeaver-6.png differ diff --git a/src/.vuepress/public/img/table-dbeaver-7.png b/src/.vuepress/public/img/table-dbeaver-7.png new file mode 100644 index 000000000..d90ac8251 Binary files /dev/null and b/src/.vuepress/public/img/table-dbeaver-7.png differ diff --git a/src/.vuepress/sidebar/V2.0.x/en-Table.ts b/src/.vuepress/sidebar/V2.0.x/en-Table.ts index c18104d3d..2093e570e 100644 --- a/src/.vuepress/sidebar/V2.0.x/en-Table.ts +++ b/src/.vuepress/sidebar/V2.0.x/en-Table.ts @@ -127,6 +127,14 @@ export const enSidebar = { { text: 'RESTAPI V1 ', link: 'RestAPI-V1' }, ], }, + { + text: 'Ecosystem Integration', + collapsible: true, + prefix: 'Ecosystem-Integration/', + children: [ + { text: 'DBeaver', link: 'DBeaver' }, + ], + }, { text: 'SQL Manual', collapsible: true, diff --git a/src/.vuepress/sidebar/V2.0.x/zh-Table.ts b/src/.vuepress/sidebar/V2.0.x/zh-Table.ts index b8216372c..aad81b998 100644 --- a/src/.vuepress/sidebar/V2.0.x/zh-Table.ts +++ b/src/.vuepress/sidebar/V2.0.x/zh-Table.ts @@ -119,6 +119,14 @@ export const zhSidebar = { { text: 'RESTAPI V1 ', link: 'RestServiceV1' }, ], }, + { + text: '系统集成', + collapsible: true, + prefix: 'Ecosystem-Integration/', + children: [ + { text: 'DBeaver', link: 'DBeaver' }, + ], + }, { text: 'SQL手册', collapsible: true, diff --git a/src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts b/src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts index 43ebeac33..e34adcdf3 100644 --- a/src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts +++ b/src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts @@ -132,6 +132,14 @@ export const enSidebar = { { text: 'RESTAPI V1 ', link: 'RestAPI-V1' }, ], }, + { + text: 'Ecosystem Integration', + collapsible: true, + prefix: 'Ecosystem-Integration/', + children: [ + { text: 'DBeaver', link: 'DBeaver' }, + ], + }, { text: 'SQL Manual', collapsible: true, diff --git a/src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts b/src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts index 215fe2d71..058d1ba58 100644 --- a/src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts +++ b/src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts @@ -123,6 +123,14 @@ export const zhSidebar = { { text: 'RESTAPI V1 ', link: 'RestServiceV1' }, ], }, + { + text: '系统集成', + collapsible: true, + prefix: 'Ecosystem-Integration/', + children: [ + { text: 'DBeaver', link: 'DBeaver' }, + ], + }, { text: 'SQL手册', collapsible: true, diff --git a/src/UserGuide/Master/Table/API/Programming-CSharp-Native-API.md b/src/UserGuide/Master/Table/API/Programming-CSharp-Native-API.md index 11e3d1c7b..9f2f5cf7d 100644 --- a/src/UserGuide/Master/Table/API/Programming-CSharp-Native-API.md +++ b/src/UserGuide/Master/Table/API/Programming-CSharp-Native-API.md @@ -18,6 +18,7 @@ under the License. --> +# C# Native API ## 1. Feature Overview diff --git a/src/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md b/src/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md new file mode 100644 index 000000000..3c494fbbe --- /dev/null +++ b/src/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md @@ -0,0 +1,77 @@ + + +# DBeaver + +DBeaver is an SQL client and database management tool. It can interact with IoTDB using IoTDB's JDBC driver. + +## 1. Install DBeaver + +* Download DBeaver: https://dbeaver.io/download/ + +## 2. Install IoTDB + +* Method 1: Download IoTDB binary release + * Download: https://iotdb.apache.org/Download/ + * Version requirement: ≥ 2.0.1 +* Method 2: Build from source + * Source code: https://github.com/apache/iotdb + * Follow compilation instructions in README.md or README_ZH.md + + +## 3. Connect IoTDB to DBeaver + +1. Start the IoTDB service. + + ```shell + ./sbin/start-server.sh + ``` +2. Launch DBeaver. + +3. Create a new database connection: + + 1. Go to `DBeaver > Database > New Database Connection`, or click the `"+"` icon in the top-left corner. + + ![](/img/table-dbeaver-1.png) + + ![](/img/table-dbeaver-2.png) + + 2. Select the IoTDB driver (under `"All"` or `"Timeseries"` categories). + + ![](/img/table-dbeaver-3.png) + + 3. Configure the connection based on your IoTDB model:(Username = Password = root) + + 1. For Tree Model: Use the default Host method + + ![](/img/table-dbeaver-4.png) + + 2. For Table Model: Use the URL method and append `?sql_dialect=table` to enable table mode. + + ![](/img/table-dbeaver-5.png) + + 4. Click `Test` Connection – if successful, the IoTDB version will be displayed. + + ![](/img/table-dbeaver-6.png) + +4. You can now use IoTDB via DBeaver. + +![](/img/table-dbeaver-7.png) \ No newline at end of file diff --git a/src/UserGuide/latest-Table/API/Programming-CSharp-Native-API.md b/src/UserGuide/latest-Table/API/Programming-CSharp-Native-API.md index 11e3d1c7b..9f2f5cf7d 100644 --- a/src/UserGuide/latest-Table/API/Programming-CSharp-Native-API.md +++ b/src/UserGuide/latest-Table/API/Programming-CSharp-Native-API.md @@ -18,6 +18,7 @@ under the License. --> +# C# Native API ## 1. Feature Overview diff --git a/src/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md b/src/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md new file mode 100644 index 000000000..3c494fbbe --- /dev/null +++ b/src/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md @@ -0,0 +1,77 @@ + + +# DBeaver + +DBeaver is an SQL client and database management tool. It can interact with IoTDB using IoTDB's JDBC driver. + +## 1. Install DBeaver + +* Download DBeaver: https://dbeaver.io/download/ + +## 2. Install IoTDB + +* Method 1: Download IoTDB binary release + * Download: https://iotdb.apache.org/Download/ + * Version requirement: ≥ 2.0.1 +* Method 2: Build from source + * Source code: https://github.com/apache/iotdb + * Follow compilation instructions in README.md or README_ZH.md + + +## 3. Connect IoTDB to DBeaver + +1. Start the IoTDB service. + + ```shell + ./sbin/start-server.sh + ``` +2. Launch DBeaver. + +3. Create a new database connection: + + 1. Go to `DBeaver > Database > New Database Connection`, or click the `"+"` icon in the top-left corner. + + ![](/img/table-dbeaver-1.png) + + ![](/img/table-dbeaver-2.png) + + 2. Select the IoTDB driver (under `"All"` or `"Timeseries"` categories). + + ![](/img/table-dbeaver-3.png) + + 3. Configure the connection based on your IoTDB model:(Username = Password = root) + + 1. For Tree Model: Use the default Host method + + ![](/img/table-dbeaver-4.png) + + 2. For Table Model: Use the URL method and append `?sql_dialect=table` to enable table mode. + + ![](/img/table-dbeaver-5.png) + + 4. Click `Test` Connection – if successful, the IoTDB version will be displayed. + + ![](/img/table-dbeaver-6.png) + +4. You can now use IoTDB via DBeaver. + +![](/img/table-dbeaver-7.png) \ No newline at end of file diff --git a/src/zh/UserGuide/Master/Table/API/Programming-CSharp-Native-API.md b/src/zh/UserGuide/Master/Table/API/Programming-CSharp-Native-API.md index bd69fb2cb..b6ec99f11 100644 --- a/src/zh/UserGuide/Master/Table/API/Programming-CSharp-Native-API.md +++ b/src/zh/UserGuide/Master/Table/API/Programming-CSharp-Native-API.md @@ -18,6 +18,7 @@ under the License. --> +# C# 原生接口 ## 1. 功能介绍 diff --git a/src/zh/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md b/src/zh/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md new file mode 100644 index 000000000..1c425c840 --- /dev/null +++ b/src/zh/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md @@ -0,0 +1,74 @@ + + +# DBeaver + +DBeaver 是一个 SQL 客户端和数据库管理工具。DBeaver 可以使用 IoTDB 的 JDBC 驱动与 IoTDB 进行交互。 + +## 1. DBeaver 安装 + +* DBeaver 下载地址：https://dbeaver.io/download/ + +## 2. IoTDB 安装 + +* 方法1：下载 IoTDB 二进制版本 + * IoTDB 下载地址：https://iotdb.apache.org/Download/ + * 版本 >= 2.0.1 +* 方法2：从 IoTDB 源代码编译 + * 源代码： https://github.com/apache/iotdb + * 编译方法参见以上链接中的 README.md 或 README_ZH.md + +## 3. 连接 IoTDB 与 DBeaver + +1. 启动 IoTDB 服务 + + ```shell + ./sbin/start-server.sh + ``` +2. 启动 DBeaver + +3. 新建 Database Connection + + 1. 点击 DBeaver > Database > New Database Connection，或者直接点击左上角图标 + + ![](/img/table-dbeaver-1.png) + + 2. 选择 IoTDB 驱动（可在 All 或 Timeseries 分类中找到） + + ![](/img/table-dbeaver-2.png) + + 3. 根据要连接的IoTDB是树模型或表模型，选择不同的连接方式（Username = Password = root） + + 1. 欲连接树模型IoTDB，使用默认的Host方法进行连接即可，如下图所示 + + ![](/img/table-dbeaver-3.png) + + 2. 欲连接表模型IoTDB，使用URL方法连接，需在URL后面添加 ?sql_dialect=table 启用表模式 + + ![](/img/table-dbeaver-4.png) + + 4. 通过 Test Connection 测试连接，能够显示对应的IoTDB版本号即连接成功 + + ![](/img/table-dbeaver-5.png) + +4. 可以开始通过 DBeaver 使用 IoTDB + +![](/img/table-dbeaver-6.png) \ No newline at end of file diff --git a/src/zh/UserGuide/latest-Table/API/Programming-CSharp-Native-API.md b/src/zh/UserGuide/latest-Table/API/Programming-CSharp-Native-API.md index bd69fb2cb..b6ec99f11 100644 --- a/src/zh/UserGuide/latest-Table/API/Programming-CSharp-Native-API.md +++ b/src/zh/UserGuide/latest-Table/API/Programming-CSharp-Native-API.md @@ -18,6 +18,7 @@ under the License. --> +# C# 原生接口 ## 1. 功能介绍 diff --git a/src/zh/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md b/src/zh/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md new file mode 100644 index 000000000..e59dad47c --- /dev/null +++ b/src/zh/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md @@ -0,0 +1,76 @@ + + +# DBeaver + +DBeaver 是一个 SQL 客户端和数据库管理工具。DBeaver 可以使用 IoTDB 的 JDBC 驱动与 IoTDB 进行交互。 + +## 1. DBeaver 安装 + +* DBeaver 下载地址：https://dbeaver.io/download/ + +## 2. IoTDB 安装 + +* 方法1：下载 IoTDB 二进制版本 + * IoTDB 下载地址：https://iotdb.apache.org/Download/ + * 版本 >= 2.0.1 +* 方法2：从 IoTDB 源代码编译 + * 源代码： https://github.com/apache/iotdb + * 编译方法参见以上链接中的 README.md 或 README_ZH.md + +## 3. 连接 IoTDB 与 DBeaver + +1. 启动 IoTDB 服务 + + ```shell + ./sbin/start-server.sh + ``` +2. 启动 DBeaver + +3. 新建 Database Connection + + 1. 点击 DBeaver > Database > New Database Connection，或者直接点击左上角图标 + + ![](/img/table-dbeaver-1.png) + + ![](/img/table-dbeaver-2.png) + + 2. 选择 IoTDB 驱动（可在 All 或 Timeseries 分类中找到） + + ![](/img/table-dbeaver-3.png) + + 3. 根据要连接的IoTDB是树模型或表模型，选择不同的连接方式（Username = Password = root） + + 1. 欲连接树模型IoTDB，使用默认的Host方法进行连接即可，如下图所示 + + ![](/img/table-dbeaver-4.png) + + 2. 欲连接表模型IoTDB，使用URL方法连接，需在URL后面添加 ?sql_dialect=table 启用表模式 + + ![](/img/table-dbeaver-5.png) + + 4. 通过 Test Connection 测试连接，能够显示对应的IoTDB版本号即连接成功 + + ![](/img/table-dbeaver-6.png) + +4. 可以开始通过 DBeaver 使用 IoTDB + +![](/img/table-dbeaver-7.png) \ No newline at end of file