diff --git a/src/.vuepress/public/img/dbeaver-new-1-en.png b/src/.vuepress/public/img/dbeaver-new-1-en.png new file mode 100644 index 000000000..bb1a6571e Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-1-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-1.png b/src/.vuepress/public/img/dbeaver-new-1.png new file mode 100644 index 000000000..f4485574b Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-1.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-10.png b/src/.vuepress/public/img/dbeaver-new-10.png new file mode 100644 index 000000000..43cef6363 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-10.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-2.png b/src/.vuepress/public/img/dbeaver-new-2.png new file mode 100644 index 000000000..fcd740e93 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-2.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-3-en.png b/src/.vuepress/public/img/dbeaver-new-3-en.png new file mode 100644 index 000000000..810968c6a Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-3-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-3.png b/src/.vuepress/public/img/dbeaver-new-3.png new file mode 100644 index 000000000..dc6fb2530 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-3.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-4-en.png b/src/.vuepress/public/img/dbeaver-new-4-en.png new file mode 100644 index 000000000..a90c3c9c7 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-4-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-4.png b/src/.vuepress/public/img/dbeaver-new-4.png new file mode 100644 index 000000000..27f11885e Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-4.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-5-en.png b/src/.vuepress/public/img/dbeaver-new-5-en.png new file mode 100644 index 000000000..a6fa9898b Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-5-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-5.png b/src/.vuepress/public/img/dbeaver-new-5.png new file mode 100644 index 000000000..e39148ded Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-5.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-6-en.png b/src/.vuepress/public/img/dbeaver-new-6-en.png new file mode 100644 index 000000000..23cffa544 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-6-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-6.png b/src/.vuepress/public/img/dbeaver-new-6.png new file mode 100644 index 000000000..5ffe49f91 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-6.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-7-en.png b/src/.vuepress/public/img/dbeaver-new-7-en.png new file mode 100644 index 000000000..f1805fb7d Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-7-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-7.png b/src/.vuepress/public/img/dbeaver-new-7.png new file mode 100644 index 000000000..5e87c492c Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-7.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-8-table-en.png b/src/.vuepress/public/img/dbeaver-new-8-table-en.png new file mode 100644 index 000000000..62f595fec Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-8-table-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-8-table.png b/src/.vuepress/public/img/dbeaver-new-8-table.png new file mode 100644 index 000000000..5c1978d77 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-8-table.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-8-tree-en.png b/src/.vuepress/public/img/dbeaver-new-8-tree-en.png new file mode 100644 index 000000000..3552eb6e8 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-8-tree-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-8-tree.png b/src/.vuepress/public/img/dbeaver-new-8-tree.png new file mode 100644 index 000000000..d0b55874a Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-8-tree.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-9-en.png b/src/.vuepress/public/img/dbeaver-new-9-en.png new file mode 100644 index 000000000..01961437b Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-9-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-9-table-en.png b/src/.vuepress/public/img/dbeaver-new-9-table-en.png new file mode 100644 index 000000000..30c392cc5 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-9-table-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-9.png b/src/.vuepress/public/img/dbeaver-new-9.png new file mode 100644 index 000000000..1b578fbc6 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-9.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-1-en.png b/src/.vuepress/public/img/dbeaver-new-table-1-en.png new file mode 100644 index 000000000..bef9e235d Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-1-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-1.png b/src/.vuepress/public/img/dbeaver-new-table-1.png new file mode 100644 index 000000000..aafc41cf0 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-1.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-2-en.png b/src/.vuepress/public/img/dbeaver-new-table-2-en.png new file mode 100644 index 000000000..bf1f53bf3 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-2-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-2.png b/src/.vuepress/public/img/dbeaver-new-table-2.png new file mode 100644 index 000000000..7e4d795be Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-2.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-3-en.png b/src/.vuepress/public/img/dbeaver-new-table-3-en.png new file mode 100644 index 000000000..bfbc06802 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-3-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-3.png b/src/.vuepress/public/img/dbeaver-new-table-3.png new file mode 100644 index 000000000..92497d9c6 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-3.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-4-en.png b/src/.vuepress/public/img/dbeaver-new-table-4-en.png new file mode 100644 index 000000000..0d11f70d0 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-4-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-4.png b/src/.vuepress/public/img/dbeaver-new-table-4.png new file mode 100644 index 000000000..4771db3b2 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-4.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-5-en.png b/src/.vuepress/public/img/dbeaver-new-table-5-en.png new file mode 100644 index 000000000..0eb702db5 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-5-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-5.png b/src/.vuepress/public/img/dbeaver-new-table-5.png new file mode 100644 index 000000000..25347f907 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-5.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-6-en.png b/src/.vuepress/public/img/dbeaver-new-table-6-en.png new file mode 100644 index 000000000..319a3c0d1 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-6-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-table-6.png b/src/.vuepress/public/img/dbeaver-new-table-6.png new file mode 100644 index 000000000..b6696ae57 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-table-6.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-1-en.png b/src/.vuepress/public/img/dbeaver-new-tree-1-en.png new file mode 100644 index 000000000..c37b96596 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-1-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-1.png b/src/.vuepress/public/img/dbeaver-new-tree-1.png new file mode 100644 index 000000000..0df56cd85 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-1.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-2-en.png b/src/.vuepress/public/img/dbeaver-new-tree-2-en.png new file mode 100644 index 000000000..b8c8842dc Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-2-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-2.png b/src/.vuepress/public/img/dbeaver-new-tree-2.png new file mode 100644 index 000000000..3a6e99bd6 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-2.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-3-en.png b/src/.vuepress/public/img/dbeaver-new-tree-3-en.png new file mode 100644 index 000000000..d5e6ed3e1 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-3-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-3.png b/src/.vuepress/public/img/dbeaver-new-tree-3.png new file mode 100644 index 000000000..c6070ab9c Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-3.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-4-en.png b/src/.vuepress/public/img/dbeaver-new-tree-4-en.png new file mode 100644 index 000000000..ea7590d51 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-4-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-4.png b/src/.vuepress/public/img/dbeaver-new-tree-4.png new file mode 100644 index 000000000..14be46ec0 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-4.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-5-en.png b/src/.vuepress/public/img/dbeaver-new-tree-5-en.png new file mode 100644 index 000000000..ed0205448 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-5-en.png differ diff --git a/src/.vuepress/public/img/dbeaver-new-tree-5.png b/src/.vuepress/public/img/dbeaver-new-tree-5.png new file mode 100644 index 000000000..85679e8f2 Binary files /dev/null and b/src/.vuepress/public/img/dbeaver-new-tree-5.png differ diff --git a/src/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md b/src/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md index 453474c19..ce5e7db14 100644 --- a/src/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md +++ b/src/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md @@ -21,69 +21,110 @@ # DBeaver -DBeaver is an SQL client and database management tool. It can interact with IoTDB using IoTDB's JDBC driver. +## 1. Feature Overview -## 1. Install DBeaver +DBeaver is an open-source universal database management tool that supports core functionalities including data query and visualization, metadata management, data import/export, and driver extensions. It provides a cross-platform graphical interface for various databases (e.g., MySQL, PostgreSQL, Oracle). -* Download DBeaver: https://dbeaver.io/download/ +![](/img/dbeaver-new-1-en.png) -## 2. Install IoTDB +## 2. Prerequisites -* 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 +Ensure DBeaver and IoTDB are installed: +- DBeaver download: https://dbeaver.io/download/ -## 3. Connect IoTDB to DBeaver +- IoTDB download: https://iotdb.apache.org/Download/ -1. Start the IoTDB service. +## 3. Configuration Guide - ```shell - ./sbin/start-server.sh - ``` -2. Launch DBeaver. +### 3.1 Download Driver -3. Open Driver Manager +Select the appropriate version of the JAR package (choose the `jar-with-dependencies.jar` variant): - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/01.png?raw=true) +- Option 1: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/iotdb-jdbc-2.0.3.3-jar-with-dependencies.jar -4. Create a new driver type for IoTDB +- Option 2: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/ - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/02.png) +![](/img/dbeaver-new-2.png) -5. Download `iotdb-jdbc`, from [source1](https://maven.proxy.ustclug.org/maven2/org/apache/iotdb/iotdb-jdbc/) or [source2](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-jdbc/),choose the corresponding jar file,download the suffix `jar-with-dependencies.jar` file. +### 3.2 Configure Driver - ![](/img/table-dbeaver-8.png) +#### Step 1: Open Driver Manager and Create New Driver -6. Add the downloaded jar file, then select `Find Class`. +1. Navigate to `Database` → `Driver Manager` in the toolbar. - ![](/img/table-dbeaver-9.png) +![](/img/dbeaver-new-3-en.png) -7. Edit the driver Settings +2. Click `New` to create a new driver configuration. - ![](/img/table-dbeaver-10.png) +![](/img/dbeaver-new-4-en.png) -8. Open New DataBase Connection and select iotdb +#### Step 2: Configure Driver Details - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/06.png) +1. Under the `Libraries` tab, click `Add` File. -9. Edit JDBC Connection Settings +2. Select the downloaded IoTDB JDBC driver (e.g., `iotdb-jdbc-2.0.3-jar-with-dependencies.jar`). -``` -JDBC URL: jdbc:iotdb://127.0.0.1:6667/?sql_dialect=table -Username: root -Password: root -``` +3. Click `Find Class` to auto-detect the driver class. -![](/img/table-dbeaver-11.png) +![](/img/dbeaver-new-5-en.png) -10. Test Connection +4. Configure the following driver settings: - ![](/img/table-dbeaver-12.png) +* ​Driver Name​​: IoTDB +* ​Class Name​​: org.apache.iotdb.jdbc.IoTDBDriver +* ​URL Template​​: jdbc:iotdb://{host}:{port}/ +* ​Default Port​​: 6667 +* ​​Default User​​: root -4. You can now use IoTDB via DBeaver. + ![](/img/dbeaver-new-6-en.png) -![](/img/table-dbeaver-7.png) \ No newline at end of file +#### Step 3: Create and Test Connection + +1. Click the `Create Connection` icon. + +2. Search for IoTDB, select it, and click Next. Choose the `URL` connection method. + + ![](/img/dbeaver-new-7-en.png) + +3. To complete the `JDBC URL`, append the parameter `?sql_dialect=table` for table model, and enter the IoTDB database password. + + ![](/img/dbeaver-new-8-table-en.png) + +4. Click `Test Connection`. A successful connection will display Connected with server and driver versions. + + ![](/img/dbeaver-new-9-table-en.png) + +## 4. Usage Guide + +1. ​​Database Overview​​ + +In the left-side `​​Database Navigator​`​, you can view database-related information, including: database name, table names, column names, column data types, column comments. + + ![](/img/dbeaver-new-table-1-en.png) + + 2. Table Structure + +Double-click a table in the database list to display its structure in the ​​`Properties​`​ tab on the right panel, including: basic table attributes and detailed column information. + + ![](/img/dbeaver-new-table-2-en.png) + + The `​​Primary Keys`​​ section shows the table's composite primary keys (time + tag columns). + + ![](/img/dbeaver-new-table-3-en.png) + + 3. ​Data View​​ + +Switch to the `Data` tab to explore all stored data for the selected table. + + ![](/img/dbeaver-new-table-4-en.png) + + 4. ​Functions and Data Types​​ + +Under `Database Navigator` → `Procedures`, view all supported functions. + + ![](/img/dbeaver-new-table-5-en.png) + +The `Data Types` tab lists all currently supported data types. + + ![](/img/dbeaver-new-table-6-en.png) \ No newline at end of file diff --git a/src/UserGuide/Master/Tree/Ecosystem-Integration/DBeaver.md b/src/UserGuide/Master/Tree/Ecosystem-Integration/DBeaver.md index f8cce45b1..28b356265 100644 --- a/src/UserGuide/Master/Tree/Ecosystem-Integration/DBeaver.md +++ b/src/UserGuide/Master/Tree/Ecosystem-Integration/DBeaver.md @@ -19,78 +19,109 @@ --> -# DBeaver(IoTDB) +# DBeaver -DBeaver is a SQL client software application and a database administration tool. It can use the JDBC application programming interface (API) to interact with IoTDB via the JDBC driver. +## 1. Feature Overview -## 1. DBeaver Installation +DBeaver is an open-source universal database management tool that supports core functionalities including data query and visualization, metadata management, data import/export, and driver extensions. It provides a cross-platform graphical interface for various databases (e.g., MySQL, PostgreSQL, Oracle). -* From DBeaver site: https://dbeaver.io/download/ +![](/img/dbeaver-new-1-en.png) -## 2. IoTDB Installation +## 2. Prerequisites -* Download binary version - * From IoTDB site: https://iotdb.apache.org/Download/ - * Version >= 0.13.0 -* Or compile from source code - * See https://github.com/apache/iotdb +Ensure DBeaver and IoTDB are installed: -## 3. Connect IoTDB and DBeaver +- DBeaver download: https://dbeaver.io/download/ -1. Start IoTDB server +- IoTDB download: https://iotdb.apache.org/Download/ - ```shell - ./sbin/start-server.sh - ``` -2. Start DBeaver -3. Open Driver Manager +## 3. Configuration Guide - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/01.png) +### 3.1 Download Driver -4. Create a new driver type for IoTDB +Select the appropriate version of the JAR package (choose the `jar-with-dependencies.jar` variant): - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/02.png) +- Option 1: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/iotdb-jdbc-2.0.3.3-jar-with-dependencies.jar -5. Download `iotdb-jdbc`, from [source1](https://maven.proxy.ustclug.org/maven2/org/apache/iotdb/iotdb-jdbc/) or [source2](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-jdbc/),choose the corresponding jar file,download the suffix `jar-with-dependencies.jar` file. - ![](/img/20230920-192746.jpg) - -6. Add the downloaded jar file, then select `Find Class`. +- Option 2: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/ - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/03.png) +![](/img/dbeaver-new-2.png) -7. Edit the driver Settings +### 3.2 Configure Driver - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/05.png) +#### Step 1: Open Driver Manager and Create New Driver - ``` - Driver Name: IoTDB - Driver Type: Generic - URL Template: jdbc:iotdb://{host}:{port}/ - Default Port: 6667 - Default User: root - ``` +1. Navigate to `Database` → `Driver Manager` in the toolbar. -8. Open New DataBase Connection and select iotdb +![](/img/dbeaver-new-3-en.png) - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/06.png) +2. Click `New` to create a new driver configuration. -9. Edit JDBC Connection Settings +![](/img/dbeaver-new-4-en.png) - ``` - JDBC URL: jdbc:iotdb://127.0.0.1:6667/ - Username: root - Password: root - ``` - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/07.png) +#### Step 2: Configure Driver Details -10. Test Connection +1. Under the `Libraries` tab, click `Add` File. - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/08.png) +2. Select the downloaded IoTDB JDBC driver (e.g., `iotdb-jdbc-2.0.3-jar-with-dependencies.jar`). -11. Enjoy IoTDB with DBeaver +3. Click `Find Class` to auto-detect the driver class. - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/09.png) +![](/img/dbeaver-new-5-en.png) -12. DBeaver tree structure display +4. Configure the following driver settings: - ![](/img/dbeaver01.png) \ No newline at end of file +* ​Driver Name​​: IoTDB +* ​Class Name​​: org.apache.iotdb.jdbc.IoTDBDriver +* ​URL Template​​: jdbc:iotdb://{host}:{port}/ +* ​Default Port​​: 6667 +* ​​Default User​​: root + + ![](/img/dbeaver-new-6-en.png) + +#### Step 3: Create and Test Connection + +1. Click the `Create Connection` icon. + +2. Search for IoTDB, select it, and click Next. Choose the `URL` connection method. + + ![](/img/dbeaver-new-7-en.png) + +3. Complete the `JDBC URL` and enter the IoTDB database password. For tree model, select the `Host` connection method. + + ![](/img/dbeaver-new-8-tree-en.png) + +4. Click `Test Connection`. A successful connection will display Connected with server and driver versions. + + ![](/img/dbeaver-new-9-en.png) + + +## 4. Usage Guide + +1. ​​Database Overview​​ + +Navigate to the left-side `Database Navigator` to view database details, including database name, device names, measurement names, and data types. + + ![](/img/dbeaver-new-tree-1-en.png) + + 2. ​​Devices and Measurements​​ + +Double-click a device in the database list to display its properties. The `Columns` tab shows detailed measurement information. + + ![](/img/dbeaver-new-tree-2-en.png) + + 3. ​​Data View​​ + +Switch to the `Data` tab to explore all stored data for the selected measurement. + + ![](/img/dbeaver-new-tree-3-en.png) + + 4. ​​Functions and Data Types​​ + +Under `Database Navigator` → `Procedures`, view all supported functions. + + ![](/img/dbeaver-new-tree-4-en.png) + +The `Data Types` tab lists all currently supported data types. + + ![](/img/dbeaver-new-tree-5-en.png) \ No newline at end of file diff --git a/src/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md b/src/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md index 453474c19..ce5e7db14 100644 --- a/src/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md +++ b/src/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md @@ -21,69 +21,110 @@ # DBeaver -DBeaver is an SQL client and database management tool. It can interact with IoTDB using IoTDB's JDBC driver. +## 1. Feature Overview -## 1. Install DBeaver +DBeaver is an open-source universal database management tool that supports core functionalities including data query and visualization, metadata management, data import/export, and driver extensions. It provides a cross-platform graphical interface for various databases (e.g., MySQL, PostgreSQL, Oracle). -* Download DBeaver: https://dbeaver.io/download/ +![](/img/dbeaver-new-1-en.png) -## 2. Install IoTDB +## 2. Prerequisites -* 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 +Ensure DBeaver and IoTDB are installed: +- DBeaver download: https://dbeaver.io/download/ -## 3. Connect IoTDB to DBeaver +- IoTDB download: https://iotdb.apache.org/Download/ -1. Start the IoTDB service. +## 3. Configuration Guide - ```shell - ./sbin/start-server.sh - ``` -2. Launch DBeaver. +### 3.1 Download Driver -3. Open Driver Manager +Select the appropriate version of the JAR package (choose the `jar-with-dependencies.jar` variant): - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/01.png?raw=true) +- Option 1: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/iotdb-jdbc-2.0.3.3-jar-with-dependencies.jar -4. Create a new driver type for IoTDB +- Option 2: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/ - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/02.png) +![](/img/dbeaver-new-2.png) -5. Download `iotdb-jdbc`, from [source1](https://maven.proxy.ustclug.org/maven2/org/apache/iotdb/iotdb-jdbc/) or [source2](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-jdbc/),choose the corresponding jar file,download the suffix `jar-with-dependencies.jar` file. +### 3.2 Configure Driver - ![](/img/table-dbeaver-8.png) +#### Step 1: Open Driver Manager and Create New Driver -6. Add the downloaded jar file, then select `Find Class`. +1. Navigate to `Database` → `Driver Manager` in the toolbar. - ![](/img/table-dbeaver-9.png) +![](/img/dbeaver-new-3-en.png) -7. Edit the driver Settings +2. Click `New` to create a new driver configuration. - ![](/img/table-dbeaver-10.png) +![](/img/dbeaver-new-4-en.png) -8. Open New DataBase Connection and select iotdb +#### Step 2: Configure Driver Details - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/06.png) +1. Under the `Libraries` tab, click `Add` File. -9. Edit JDBC Connection Settings +2. Select the downloaded IoTDB JDBC driver (e.g., `iotdb-jdbc-2.0.3-jar-with-dependencies.jar`). -``` -JDBC URL: jdbc:iotdb://127.0.0.1:6667/?sql_dialect=table -Username: root -Password: root -``` +3. Click `Find Class` to auto-detect the driver class. -![](/img/table-dbeaver-11.png) +![](/img/dbeaver-new-5-en.png) -10. Test Connection +4. Configure the following driver settings: - ![](/img/table-dbeaver-12.png) +* ​Driver Name​​: IoTDB +* ​Class Name​​: org.apache.iotdb.jdbc.IoTDBDriver +* ​URL Template​​: jdbc:iotdb://{host}:{port}/ +* ​Default Port​​: 6667 +* ​​Default User​​: root -4. You can now use IoTDB via DBeaver. + ![](/img/dbeaver-new-6-en.png) -![](/img/table-dbeaver-7.png) \ No newline at end of file +#### Step 3: Create and Test Connection + +1. Click the `Create Connection` icon. + +2. Search for IoTDB, select it, and click Next. Choose the `URL` connection method. + + ![](/img/dbeaver-new-7-en.png) + +3. To complete the `JDBC URL`, append the parameter `?sql_dialect=table` for table model, and enter the IoTDB database password. + + ![](/img/dbeaver-new-8-table-en.png) + +4. Click `Test Connection`. A successful connection will display Connected with server and driver versions. + + ![](/img/dbeaver-new-9-table-en.png) + +## 4. Usage Guide + +1. ​​Database Overview​​ + +In the left-side `​​Database Navigator​`​, you can view database-related information, including: database name, table names, column names, column data types, column comments. + + ![](/img/dbeaver-new-table-1-en.png) + + 2. Table Structure + +Double-click a table in the database list to display its structure in the ​​`Properties​`​ tab on the right panel, including: basic table attributes and detailed column information. + + ![](/img/dbeaver-new-table-2-en.png) + + The `​​Primary Keys`​​ section shows the table's composite primary keys (time + tag columns). + + ![](/img/dbeaver-new-table-3-en.png) + + 3. ​Data View​​ + +Switch to the `Data` tab to explore all stored data for the selected table. + + ![](/img/dbeaver-new-table-4-en.png) + + 4. ​Functions and Data Types​​ + +Under `Database Navigator` → `Procedures`, view all supported functions. + + ![](/img/dbeaver-new-table-5-en.png) + +The `Data Types` tab lists all currently supported data types. + + ![](/img/dbeaver-new-table-6-en.png) \ No newline at end of file diff --git a/src/UserGuide/latest/Ecosystem-Integration/DBeaver.md b/src/UserGuide/latest/Ecosystem-Integration/DBeaver.md index f8cce45b1..28b356265 100644 --- a/src/UserGuide/latest/Ecosystem-Integration/DBeaver.md +++ b/src/UserGuide/latest/Ecosystem-Integration/DBeaver.md @@ -19,78 +19,109 @@ --> -# DBeaver(IoTDB) +# DBeaver -DBeaver is a SQL client software application and a database administration tool. It can use the JDBC application programming interface (API) to interact with IoTDB via the JDBC driver. +## 1. Feature Overview -## 1. DBeaver Installation +DBeaver is an open-source universal database management tool that supports core functionalities including data query and visualization, metadata management, data import/export, and driver extensions. It provides a cross-platform graphical interface for various databases (e.g., MySQL, PostgreSQL, Oracle). -* From DBeaver site: https://dbeaver.io/download/ +![](/img/dbeaver-new-1-en.png) -## 2. IoTDB Installation +## 2. Prerequisites -* Download binary version - * From IoTDB site: https://iotdb.apache.org/Download/ - * Version >= 0.13.0 -* Or compile from source code - * See https://github.com/apache/iotdb +Ensure DBeaver and IoTDB are installed: -## 3. Connect IoTDB and DBeaver +- DBeaver download: https://dbeaver.io/download/ -1. Start IoTDB server +- IoTDB download: https://iotdb.apache.org/Download/ - ```shell - ./sbin/start-server.sh - ``` -2. Start DBeaver -3. Open Driver Manager +## 3. Configuration Guide - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/01.png) +### 3.1 Download Driver -4. Create a new driver type for IoTDB +Select the appropriate version of the JAR package (choose the `jar-with-dependencies.jar` variant): - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/02.png) +- Option 1: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/iotdb-jdbc-2.0.3.3-jar-with-dependencies.jar -5. Download `iotdb-jdbc`, from [source1](https://maven.proxy.ustclug.org/maven2/org/apache/iotdb/iotdb-jdbc/) or [source2](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-jdbc/),choose the corresponding jar file,download the suffix `jar-with-dependencies.jar` file. - ![](/img/20230920-192746.jpg) - -6. Add the downloaded jar file, then select `Find Class`. +- Option 2: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/ - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/03.png) +![](/img/dbeaver-new-2.png) -7. Edit the driver Settings +### 3.2 Configure Driver - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/05.png) +#### Step 1: Open Driver Manager and Create New Driver - ``` - Driver Name: IoTDB - Driver Type: Generic - URL Template: jdbc:iotdb://{host}:{port}/ - Default Port: 6667 - Default User: root - ``` +1. Navigate to `Database` → `Driver Manager` in the toolbar. -8. Open New DataBase Connection and select iotdb +![](/img/dbeaver-new-3-en.png) - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/06.png) +2. Click `New` to create a new driver configuration. -9. Edit JDBC Connection Settings +![](/img/dbeaver-new-4-en.png) - ``` - JDBC URL: jdbc:iotdb://127.0.0.1:6667/ - Username: root - Password: root - ``` - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/07.png) +#### Step 2: Configure Driver Details -10. Test Connection +1. Under the `Libraries` tab, click `Add` File. - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/08.png) +2. Select the downloaded IoTDB JDBC driver (e.g., `iotdb-jdbc-2.0.3-jar-with-dependencies.jar`). -11. Enjoy IoTDB with DBeaver +3. Click `Find Class` to auto-detect the driver class. - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/09.png) +![](/img/dbeaver-new-5-en.png) -12. DBeaver tree structure display +4. Configure the following driver settings: - ![](/img/dbeaver01.png) \ No newline at end of file +* ​Driver Name​​: IoTDB +* ​Class Name​​: org.apache.iotdb.jdbc.IoTDBDriver +* ​URL Template​​: jdbc:iotdb://{host}:{port}/ +* ​Default Port​​: 6667 +* ​​Default User​​: root + + ![](/img/dbeaver-new-6-en.png) + +#### Step 3: Create and Test Connection + +1. Click the `Create Connection` icon. + +2. Search for IoTDB, select it, and click Next. Choose the `URL` connection method. + + ![](/img/dbeaver-new-7-en.png) + +3. Complete the `JDBC URL` and enter the IoTDB database password. For tree model, select the `Host` connection method. + + ![](/img/dbeaver-new-8-tree-en.png) + +4. Click `Test Connection`. A successful connection will display Connected with server and driver versions. + + ![](/img/dbeaver-new-9-en.png) + + +## 4. Usage Guide + +1. ​​Database Overview​​ + +Navigate to the left-side `Database Navigator` to view database details, including database name, device names, measurement names, and data types. + + ![](/img/dbeaver-new-tree-1-en.png) + + 2. ​​Devices and Measurements​​ + +Double-click a device in the database list to display its properties. The `Columns` tab shows detailed measurement information. + + ![](/img/dbeaver-new-tree-2-en.png) + + 3. ​​Data View​​ + +Switch to the `Data` tab to explore all stored data for the selected measurement. + + ![](/img/dbeaver-new-tree-3-en.png) + + 4. ​​Functions and Data Types​​ + +Under `Database Navigator` → `Procedures`, view all supported functions. + + ![](/img/dbeaver-new-tree-4-en.png) + +The `Data Types` tab lists all currently supported data types. + + ![](/img/dbeaver-new-tree-5-en.png) \ No newline at end of file diff --git a/src/zh/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md b/src/zh/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md index 1d89d8317..fa934d346 100644 --- a/src/zh/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md +++ b/src/zh/UserGuide/Master/Table/Ecosystem-Integration/DBeaver.md @@ -21,67 +21,112 @@ # DBeaver -DBeaver 是一个 SQL 客户端和数据库管理工具。DBeaver 可以使用 IoTDB 的 JDBC 驱动与 IoTDB 进行交互。 +## 1. 功能简介 -## 1. DBeaver 安装 +DBeaver 是一款开源的通用数据库管理工具,支持数据查询与可视化​、元数据管理​、数据导入导出、驱动扩展等核心特性,为多种数据库(如 MySQL、PostgreSQL、Oracle等)提供跨平台的图形化操作界面。 -* DBeaver 下载地址:https://dbeaver.io/download/ +![](/img/dbeaver-new-1.png) -## 2. IoTDB 安装 +## 2. 前置条件 -* 方法1:下载 IoTDB 二进制版本 - * IoTDB 下载地址:https://iotdb.apache.org/Download/ - * 版本 >= 2.0.1 -* 方法2:从 IoTDB 源代码编译 - * 源代码: https://github.com/apache/iotdb - * 编译方法参见以上链接中的 README.md 或 README_ZH.md +安装好 DBeaver、IoTDB: -## 3. 连接 IoTDB 与 DBeaver +- DBeaver 下载地址:https://dbeaver.io/download/ -1. 启动 IoTDB 服务 +- IoTDB 下载地址:https://iotdb.apache.org/Download/ - ```shell - ./sbin/start-server.sh - ``` -2. 启动 DBeaver +## 3. 配置方式 -3. 打开 Driver Manager +### 3.1 下载驱动 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/01.png?raw=true) -4. 为 IoTDB 新建一个驱动类型 +选择对应版本的 jar 包,下载后缀 `jar-with-dependencies.jar` 的包: - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/02.png) +- 链接 1:https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/iotdb-jdbc-2.0.3.3-jar-with-dependencies.jar -5. 下载 jdbc 驱动, 点击下列网址 [地址1](https://maven.proxy.ustclug.org/maven2/org/apache/iotdb/iotdb-jdbc/) 或 [地址2](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-jdbc/),选择对应版本的 jar 包,下载后缀 jar-with-dependencies.jar 的包 +- 链接 2:https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/ - ![](/img/table-dbeaver-8.png) +![](/img/dbeaver-new-2.png) -6. 添加刚刚下载的驱动包,点击 Find Class +### 3.2 配置驱动 - ![](/img/table-dbeaver-9.png) +#### 步骤一:打开驱动管理器并新建驱动 -7. 编辑驱动设置 +1. 打开数据库工具导航到`数据库` -> `驱动管理器`。 - ![](/img/table-dbeaver-10.png) +![](/img/dbeaver-new-3.png) -8. 新建 DataBase Connection, 选择 iotdb +2. 点击`新建`按钮,开始创建新的驱动配置。 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/06.png) +![](/img/dbeaver-new-4.png) -9. 编辑 JDBC 连接设置 +#### 步骤二:配置驱动信息 -``` -JDBC URL: jdbc:iotdb://127.0.0.1:6667/?sql_dialect=table -Username: root -Password: root -``` - - ![](/img/table-dbeaver-11.png) +1. 配置【库】信息,在创建新驱动窗口中,点击`添加文件`按钮。 + +2. 选择下载好的 IoTDB JDBC 驱动文件(如 `iotdb-jdbc-2.0.3-jar-with-dependencies.jar`)。 + +3. 点击`找到类`按钮,自动识别驱动类。 + +![](/img/dbeaver-new-5.png) + +4. 填写以下驱动设置信息: + + - 驱动名称:IoTDB + - 类名:org.apache.iotdb.jdbc.IoTDBDriver + - URL 模版:jdbc:iotdb://{host}:{port}/ + - 默认端口:6667 + - 默认用户:root + + ![](/img/dbeaver-new-6.png) + +#### 步骤三:创建并测试连接 + +1. 点击`创建连接`图标。 + +2. 在搜索框中输入 `IoTDB`,并选择。点击`下一步`,选择 `URL` 的连接方式。 + + ![](/img/dbeaver-new-7.png) + +3. 完善 `JDBC URL`,表模型需在 URL 中补充参数 `?sql_dialect=table`, 并填写 IoTDB 数据库的密码。 + + ![](/img/dbeaver-new-8-table.png) + +4. 点击`测试连接`按钮,如果连接成功,会提示`已连接`,并显示服务器版本和驱动版本。 + + ![](/img/dbeaver-new-9.png) + + ![](/img/dbeaver-new-10.png) + +## 4. 使用方式 + +1. 数据库概览 + +在界面左侧的`数据库导航`中,可以查看数据库相关信息,包括数据库名称、表名称、列名称,列的类型以及列的备注。 + + ![](/img/dbeaver-new-table-1.png) + + 2. 表结构 + +在数据库列表中双击某张表,可在界面右侧展示的`属性`页签查看具体的表结构,包括表的基本属性和列的详细信息等。 + + ![](/img/dbeaver-new-table-2.png) + + 在`唯一键`处可以查看表内的主键(time+tag 列)。 + + ![](/img/dbeaver-new-table-3.png) + + 3. 数据 + +在右侧界面切换到`数据`页签,即可查看该表存储的全部数据。 + + ![](/img/dbeaver-new-table-4.png) + + 4. 函数与数据类型 -10. 测试连接 +在`数据库导航`下的`存储过程`页签中,可以查看数据库支持的所有函数; - ![](/img/table-dbeaver-12.png) + ![](/img/dbeaver-new-table-5.png) -11. 可以开始通过 DBeaver 使用 IoTDB + 在`数据类型`页签中,可以查看数据库当前支持的所有数据类型。 -![](/img/table-dbeaver-7.png) \ No newline at end of file + ![](/img/dbeaver-new-table-6.png) \ No newline at end of file diff --git a/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/DBeaver.md b/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/DBeaver.md index 7a741f788..ffd4bff8f 100644 --- a/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/DBeaver.md +++ b/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/DBeaver.md @@ -19,70 +19,110 @@ --> -# DBeaver(IoTDB) +# DBeaver -DBeaver 是一个 SQL 客户端和数据库管理工具。DBeaver 可以使用 IoTDB 的 JDBC 驱动与 IoTDB 进行交互。 +## 1. 功能简介 -## 1. DBeaver 安装 +DBeaver 是一款开源的通用数据库管理工具,支持数据查询与可视化​、元数据管理​、数据导入导出、驱动扩展等核心特性,为多种数据库(如 MySQL、PostgreSQL、Oracle等)提供跨平台的图形化操作界面。 -* DBeaver 下载地址:https://dbeaver.io/download/ +![](/img/dbeaver-new-1.png) -## 2. IoTDB 安装 +## 2. 前置条件 -* 下载 IoTDB 二进制版本 - * IoTDB 下载地址:https://iotdb.apache.org/Download/ - * 版本 >= 0.13.0 -* 或者从源代码中编译 - * 参考 https://github.com/apache/iotdb +安装好 DBeaver、IoTDB: -## 3. 连接 IoTDB 与 DBeaver +- DBeaver 下载地址:https://dbeaver.io/download/ -1. 启动 IoTDB 服务 +- IoTDB 下载地址:https://iotdb.apache.org/Download/ - ```shell - ./sbin/start-server.sh - ``` -2. 启动 DBeaver +## 3. 配置方式 -3. 打开 Driver Manager +### 3.1 下载驱动 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/01.png?raw=true) -4. 为 IoTDB 新建一个驱动类型 +选择对应版本的 jar 包,下载后缀 `jar-with-dependencies.jar` 的包: - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/02.png) +- 链接 1:https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/iotdb-jdbc-2.0.3.3-jar-with-dependencies.jar -5. 下载 jdbc 驱动, 点击下列网址 [地址1](https://maven.proxy.ustclug.org/maven2/org/apache/iotdb/iotdb-jdbc/) 或 [地址2](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-jdbc/),选择对应版本的 jar 包,下载后缀 jar-with-dependencies.jar 的包 - ![](/img/20230920-192746.jpg) -6. 添加刚刚下载的驱动包,点击 Find Class +- 链接 2:https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/ - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/03.png) +![](/img/dbeaver-new-2.png) -7. 编辑驱动设置 +### 3.2 配置驱动 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/05.png) - -8. 新建 DataBase Connection, 选择 iotdb +#### 步骤一:打开驱动管理器并新建驱动 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/06.png) +1. 打开数据库工具导航到`数据库` -> `驱动管理器`。 -9. 编辑 JDBC 连接设置 +![](/img/dbeaver-new-3.png) - ``` - JDBC URL: jdbc:iotdb://127.0.0.1:6667/ - Username: root - Password: root - ``` - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/07.png) +2. 点击`新建`按钮,开始创建新的驱动配置。 -10. 测试连接 +![](/img/dbeaver-new-4.png) - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/08.png) +#### 步骤二:配置驱动信息 -11. 可以开始通过 DBeaver 使用 IoTDB +1. 配置【库】信息,在创建新驱动窗口中,点击`添加文件`按钮。 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/09.png) +2. 选择下载好的 IoTDB JDBC 驱动文件(如 `iotdb-jdbc-2.0.3-jar-with-dependencies.jar`)。 -12. DBeaver 树型结构展示 +3. 点击`找到类`按钮,自动识别驱动类。 - ![](/img/dbeaver01.png) +![](/img/dbeaver-new-5.png) +4. 填写以下驱动设置信息: + + - 驱动名称:IoTDB + - 类名:org.apache.iotdb.jdbc.IoTDBDriver + - URL 模版:jdbc:iotdb://{host}:{port}/ + - 默认端口:6667 + - 默认用户:root + + ![](/img/dbeaver-new-6.png) + +#### 步骤三:创建并测试连接 + +1. 点击`创建连接`图标。 + +2. 在搜索框中输入 `IoTDB`,并选择。点击`下一步`,选择 `URL` 的连接方式。 + + ![](/img/dbeaver-new-7.png) + +3. 完善 `JDBC URL`,并填写 IoTDB 数据库的密码。树模型可以选择`主机`的连接方式。 + + ![](/img/dbeaver-new-8-tree.png) + +4. 点击`测试连接`按钮,如果连接成功,会提示`已连接`,并显示服务器版本和驱动版本。 + + ![](/img/dbeaver-new-9.png) + + ![](/img/dbeaver-new-10.png) + +## 4. 使用方式 + +1. 数据库概览 + +在界面左侧的`数据库导航`中,可以查看数据库相关信息,包括数据库名称、设备名称、测点名称以及测点类型。 + + ![](/img/dbeaver-new-tree-1.png) + + 2. 设备及测点 + +在左侧数据库列表中,双击选中某个设备,界面右侧将展示该设备的基本属性信息,在`列`标签中可查看测点的详细信息。 + + ![](/img/dbeaver-new-tree-2.png) + + 3. 数据 + +在右侧界面切换到`数据`页签,即可查看该测点存储的全部数据。 + + ![](/img/dbeaver-new-tree-3.png) + + 4. 函数与数据类型 + +在`数据库导航`下的`存储过程`页签中,可以查看数据库支持的所有函数; + + ![](/img/dbeaver-new-tree-4.png) + + 在`数据类型`页签中,可以查看数据库当前支持的所有数据类型。 + + ![](/img/dbeaver-new-tree-5.png) \ No newline at end of file diff --git a/src/zh/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md b/src/zh/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md index 1d89d8317..fa934d346 100644 --- a/src/zh/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md +++ b/src/zh/UserGuide/latest-Table/Ecosystem-Integration/DBeaver.md @@ -21,67 +21,112 @@ # DBeaver -DBeaver 是一个 SQL 客户端和数据库管理工具。DBeaver 可以使用 IoTDB 的 JDBC 驱动与 IoTDB 进行交互。 +## 1. 功能简介 -## 1. DBeaver 安装 +DBeaver 是一款开源的通用数据库管理工具,支持数据查询与可视化​、元数据管理​、数据导入导出、驱动扩展等核心特性,为多种数据库(如 MySQL、PostgreSQL、Oracle等)提供跨平台的图形化操作界面。 -* DBeaver 下载地址:https://dbeaver.io/download/ +![](/img/dbeaver-new-1.png) -## 2. IoTDB 安装 +## 2. 前置条件 -* 方法1:下载 IoTDB 二进制版本 - * IoTDB 下载地址:https://iotdb.apache.org/Download/ - * 版本 >= 2.0.1 -* 方法2:从 IoTDB 源代码编译 - * 源代码: https://github.com/apache/iotdb - * 编译方法参见以上链接中的 README.md 或 README_ZH.md +安装好 DBeaver、IoTDB: -## 3. 连接 IoTDB 与 DBeaver +- DBeaver 下载地址:https://dbeaver.io/download/ -1. 启动 IoTDB 服务 +- IoTDB 下载地址:https://iotdb.apache.org/Download/ - ```shell - ./sbin/start-server.sh - ``` -2. 启动 DBeaver +## 3. 配置方式 -3. 打开 Driver Manager +### 3.1 下载驱动 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/01.png?raw=true) -4. 为 IoTDB 新建一个驱动类型 +选择对应版本的 jar 包,下载后缀 `jar-with-dependencies.jar` 的包: - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/02.png) +- 链接 1:https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/iotdb-jdbc-2.0.3.3-jar-with-dependencies.jar -5. 下载 jdbc 驱动, 点击下列网址 [地址1](https://maven.proxy.ustclug.org/maven2/org/apache/iotdb/iotdb-jdbc/) 或 [地址2](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-jdbc/),选择对应版本的 jar 包,下载后缀 jar-with-dependencies.jar 的包 +- 链接 2:https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/ - ![](/img/table-dbeaver-8.png) +![](/img/dbeaver-new-2.png) -6. 添加刚刚下载的驱动包,点击 Find Class +### 3.2 配置驱动 - ![](/img/table-dbeaver-9.png) +#### 步骤一:打开驱动管理器并新建驱动 -7. 编辑驱动设置 +1. 打开数据库工具导航到`数据库` -> `驱动管理器`。 - ![](/img/table-dbeaver-10.png) +![](/img/dbeaver-new-3.png) -8. 新建 DataBase Connection, 选择 iotdb +2. 点击`新建`按钮,开始创建新的驱动配置。 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/06.png) +![](/img/dbeaver-new-4.png) -9. 编辑 JDBC 连接设置 +#### 步骤二:配置驱动信息 -``` -JDBC URL: jdbc:iotdb://127.0.0.1:6667/?sql_dialect=table -Username: root -Password: root -``` - - ![](/img/table-dbeaver-11.png) +1. 配置【库】信息,在创建新驱动窗口中,点击`添加文件`按钮。 + +2. 选择下载好的 IoTDB JDBC 驱动文件(如 `iotdb-jdbc-2.0.3-jar-with-dependencies.jar`)。 + +3. 点击`找到类`按钮,自动识别驱动类。 + +![](/img/dbeaver-new-5.png) + +4. 填写以下驱动设置信息: + + - 驱动名称:IoTDB + - 类名:org.apache.iotdb.jdbc.IoTDBDriver + - URL 模版:jdbc:iotdb://{host}:{port}/ + - 默认端口:6667 + - 默认用户:root + + ![](/img/dbeaver-new-6.png) + +#### 步骤三:创建并测试连接 + +1. 点击`创建连接`图标。 + +2. 在搜索框中输入 `IoTDB`,并选择。点击`下一步`,选择 `URL` 的连接方式。 + + ![](/img/dbeaver-new-7.png) + +3. 完善 `JDBC URL`,表模型需在 URL 中补充参数 `?sql_dialect=table`, 并填写 IoTDB 数据库的密码。 + + ![](/img/dbeaver-new-8-table.png) + +4. 点击`测试连接`按钮,如果连接成功,会提示`已连接`,并显示服务器版本和驱动版本。 + + ![](/img/dbeaver-new-9.png) + + ![](/img/dbeaver-new-10.png) + +## 4. 使用方式 + +1. 数据库概览 + +在界面左侧的`数据库导航`中,可以查看数据库相关信息,包括数据库名称、表名称、列名称,列的类型以及列的备注。 + + ![](/img/dbeaver-new-table-1.png) + + 2. 表结构 + +在数据库列表中双击某张表,可在界面右侧展示的`属性`页签查看具体的表结构,包括表的基本属性和列的详细信息等。 + + ![](/img/dbeaver-new-table-2.png) + + 在`唯一键`处可以查看表内的主键(time+tag 列)。 + + ![](/img/dbeaver-new-table-3.png) + + 3. 数据 + +在右侧界面切换到`数据`页签,即可查看该表存储的全部数据。 + + ![](/img/dbeaver-new-table-4.png) + + 4. 函数与数据类型 -10. 测试连接 +在`数据库导航`下的`存储过程`页签中,可以查看数据库支持的所有函数; - ![](/img/table-dbeaver-12.png) + ![](/img/dbeaver-new-table-5.png) -11. 可以开始通过 DBeaver 使用 IoTDB + 在`数据类型`页签中,可以查看数据库当前支持的所有数据类型。 -![](/img/table-dbeaver-7.png) \ No newline at end of file + ![](/img/dbeaver-new-table-6.png) \ No newline at end of file diff --git a/src/zh/UserGuide/latest/Ecosystem-Integration/DBeaver.md b/src/zh/UserGuide/latest/Ecosystem-Integration/DBeaver.md index 292bb6349..ffd4bff8f 100644 --- a/src/zh/UserGuide/latest/Ecosystem-Integration/DBeaver.md +++ b/src/zh/UserGuide/latest/Ecosystem-Integration/DBeaver.md @@ -19,69 +19,110 @@ --> -# DBeaver(IoTDB) +# DBeaver -DBeaver 是一个 SQL 客户端和数据库管理工具。DBeaver 可以使用 IoTDB 的 JDBC 驱动与 IoTDB 进行交互。 +## 1. 功能简介 -## 1. DBeaver 安装 +DBeaver 是一款开源的通用数据库管理工具,支持数据查询与可视化​、元数据管理​、数据导入导出、驱动扩展等核心特性,为多种数据库(如 MySQL、PostgreSQL、Oracle等)提供跨平台的图形化操作界面。 -* DBeaver 下载地址:https://dbeaver.io/download/ +![](/img/dbeaver-new-1.png) -## 2. IoTDB 安装 +## 2. 前置条件 -* 下载 IoTDB 二进制版本 - * IoTDB 下载地址:https://iotdb.apache.org/Download/ - * 版本 >= 0.13.0 -* 或者从源代码中编译 - * 参考 https://github.com/apache/iotdb +安装好 DBeaver、IoTDB: -## 3. 连接 IoTDB 与 DBeaver +- DBeaver 下载地址:https://dbeaver.io/download/ -1. 启动 IoTDB 服务 +- IoTDB 下载地址:https://iotdb.apache.org/Download/ - ```shell - ./sbin/start-server.sh - ``` -2. 启动 DBeaver +## 3. 配置方式 -3. 打开 Driver Manager +### 3.1 下载驱动 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/01.png?raw=true) -4. 为 IoTDB 新建一个驱动类型 +选择对应版本的 jar 包,下载后缀 `jar-with-dependencies.jar` 的包: - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/02.png) +- 链接 1:https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/iotdb-jdbc-2.0.3.3-jar-with-dependencies.jar -5. 下载 jdbc 驱动, 点击下列网址 [地址1](https://maven.proxy.ustclug.org/maven2/org/apache/iotdb/iotdb-jdbc/) 或 [地址2](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-jdbc/),选择对应版本的 jar 包,下载后缀 jar-with-dependencies.jar 的包 - ![](/img/20230920-192746.jpg) -6. 添加刚刚下载的驱动包,点击 Find Class +- 链接 2:https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/ - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/03.png) +![](/img/dbeaver-new-2.png) -7. 编辑驱动设置 +### 3.2 配置驱动 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/05.png) - -8. 新建 DataBase Connection, 选择 iotdb +#### 步骤一:打开驱动管理器并新建驱动 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/06.png) +1. 打开数据库工具导航到`数据库` -> `驱动管理器`。 -9. 编辑 JDBC 连接设置 +![](/img/dbeaver-new-3.png) - ``` - JDBC URL: jdbc:iotdb://127.0.0.1:6667/ - Username: root - Password: root - ``` - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/07.png) +2. 点击`新建`按钮,开始创建新的驱动配置。 -10. 测试连接 +![](/img/dbeaver-new-4.png) - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/08.png) +#### 步骤二:配置驱动信息 -11. 可以开始通过 DBeaver 使用 IoTDB +1. 配置【库】信息,在创建新驱动窗口中,点击`添加文件`按钮。 - ![](/img/UserGuide/Ecosystem-Integration/DBeaver/09.png) +2. 选择下载好的 IoTDB JDBC 驱动文件(如 `iotdb-jdbc-2.0.3-jar-with-dependencies.jar`)。 -12. DBeaver 树型结构展示 +3. 点击`找到类`按钮,自动识别驱动类。 - ![](/img/dbeaver01.png) \ No newline at end of file +![](/img/dbeaver-new-5.png) + +4. 填写以下驱动设置信息: + + - 驱动名称:IoTDB + - 类名:org.apache.iotdb.jdbc.IoTDBDriver + - URL 模版:jdbc:iotdb://{host}:{port}/ + - 默认端口:6667 + - 默认用户:root + + ![](/img/dbeaver-new-6.png) + +#### 步骤三:创建并测试连接 + +1. 点击`创建连接`图标。 + +2. 在搜索框中输入 `IoTDB`,并选择。点击`下一步`,选择 `URL` 的连接方式。 + + ![](/img/dbeaver-new-7.png) + +3. 完善 `JDBC URL`,并填写 IoTDB 数据库的密码。树模型可以选择`主机`的连接方式。 + + ![](/img/dbeaver-new-8-tree.png) + +4. 点击`测试连接`按钮,如果连接成功,会提示`已连接`,并显示服务器版本和驱动版本。 + + ![](/img/dbeaver-new-9.png) + + ![](/img/dbeaver-new-10.png) + +## 4. 使用方式 + +1. 数据库概览 + +在界面左侧的`数据库导航`中,可以查看数据库相关信息,包括数据库名称、设备名称、测点名称以及测点类型。 + + ![](/img/dbeaver-new-tree-1.png) + + 2. 设备及测点 + +在左侧数据库列表中,双击选中某个设备,界面右侧将展示该设备的基本属性信息,在`列`标签中可查看测点的详细信息。 + + ![](/img/dbeaver-new-tree-2.png) + + 3. 数据 + +在右侧界面切换到`数据`页签,即可查看该测点存储的全部数据。 + + ![](/img/dbeaver-new-tree-3.png) + + 4. 函数与数据类型 + +在`数据库导航`下的`存储过程`页签中,可以查看数据库支持的所有函数; + + ![](/img/dbeaver-new-tree-4.png) + + 在`数据类型`页签中,可以查看数据库当前支持的所有数据类型。 + + ![](/img/dbeaver-new-tree-5.png) \ No newline at end of file