Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added src/.vuepress/public/img/datagrip-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-13.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-13.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/datagrip-en-9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/.vuepress/sidebar/V2.0.x/en-Table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ export const enSidebar = {
collapsible: true,
children: [
{ text: 'DBeaver', link: 'DBeaver' },
{ text: 'DataGrip', link: 'DataGrip' },
],
},
],
Expand Down
1 change: 1 addition & 0 deletions src/.vuepress/sidebar/V2.0.x/zh-Table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ export const zhSidebar = {
collapsible: true,
children: [
{ text: 'DBeaver', link: 'DBeaver' },
{ text: 'DataGrip', link: 'DataGrip' },
],
},
],
Expand Down
1 change: 1 addition & 0 deletions src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ export const enSidebar = {
collapsible: true,
children: [
{ text: 'DBeaver', link: 'DBeaver' },
{ text: 'DataGrip', link: 'DataGrip' },
],
},
],
Expand Down
1 change: 1 addition & 0 deletions src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ export const zhSidebar = {
collapsible: true,
children: [
{ text: 'DBeaver', link: 'DBeaver' },
{ text: 'DataGrip', link: 'DataGrip' },
],
},
],
Expand Down
127 changes: 127 additions & 0 deletions src/UserGuide/Master/Table/Ecosystem-Integration/DataGrip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

-->

# DataGrip

## 1. Feature Overview

DataGrip 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).

IoTDB integrates with DataGrip via JDBC, enabling users to navigate time-series data in a tree-like structure similar to managing folders. It also supports cross-database analysis by connecting to other databases (e.g., MySQL, Oracle), significantly enhancing time-series data management capabilities in IoT scenarios.

![](/img/datagrip-en-1.png)

## 2. Prerequisites

Ensure DataGrip and IoTDB are installed:

- DataGrip download: https://www.jetbrains.com/datagrip/download/

- IoTDB download: https://iotdb.apache.org/Download/

## 3. Configuration Guide

### 3.1 Download Driver

Select the appropriate version of the JAR package (choose the `jar-with-dependencies.jar` variant):

- 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

- Option 2: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/

![](/img/datagrip-2.png)

### 3.2 Configure Driver

#### Step 1: Open Driver Manager and Create New Driver

1. Open ​​Database Tool Window​​ from the left sidebar → Click the `+` button to create a new configuration.

2. Select the ​`​Driver​`​ button to start configuring a new driver.

![](/img/datagrip-en-3.png)

#### Step 2: Configure Driver Details

1. In the ​​Drivers​​ section, click the `+` button in the `Create New Driver` window.

![](/img/datagrip-en-4.png)

2. Click the `+` button under ​​Driver Files​​ → Select ​​Custom JARs​​.

3. Choose the downloaded IoTDB JDBC driver file (e.g., `iotdb-jdbc-2.0.5-jar-with-dependencies.jar`).

4. Under the ​​General​​ tab, select the JDBC driver class: `org.apache.iotdb.jdbc.IoTDBDriver`.

5. Set the driver name: ​​IoTDB​​.

![](/img/datagrip-en-5.png)

6. Under the ​​Options​​ tab, add `show version` to the ​​Keep-alive query​​ field in the ​​Connection​​ section.

![](/img/datagrip-en-6.png)

7. Click ​​OK​​.

#### Step 3: Create and Test Connection

1. Click the `+` button in the left sidebar → Select ​​Data Source​​ → Choose the newly created driver.

![](/img/datagrip-en-7.png)

2. Enter the driver name and comments (optional).

3. Configure the ​​JDBC URL​​ and enter the IoTDB database password.

4. Click ​`​Test Connection`​​. If successful, it will display `​​Succeeded​` along with server and driver versions.

![](/img/datagrip-en-8.png)

5. Navigate to ​​Schemas​​ → Select ​​All databases / All schemas​​.

![](/img/datagrip-en-9.png)

6. Click ​​Apply​​ → ​​OK​​.

## 4. Usage Guide

1. Database and Table Structure Overview​​

In the ​`​Database Explorer​​ `(left panel), you can view: Database names, Table names and comments, Primary key info (time + tag columns).

![](/img/datagrip-en-10.png)

2. Modify Table Structure​​

Right-click a table → Use the right panel to edit table properties (e.g., columns, constraints).

![](/img/datagrip-en-11.png)

![](/img/datagrip-en-12.png)

3. Data Operations​​

​​View Data​​: Double-click a table to see all records.

​​Run Queries​​: Right-click a table → ​​New Query Console​​ → Write SQL → Click ​​Execute​​.

![](/img/datagrip-en-13.png)

127 changes: 127 additions & 0 deletions src/UserGuide/latest-Table/Ecosystem-Integration/DataGrip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

-->

# DataGrip

## 1. Feature Overview

DataGrip 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).

IoTDB integrates with DataGrip via JDBC, enabling users to navigate time-series data in a tree-like structure similar to managing folders. It also supports cross-database analysis by connecting to other databases (e.g., MySQL, Oracle), significantly enhancing time-series data management capabilities in IoT scenarios.

![](/img/datagrip-en-1.png)

## 2. Prerequisites

Ensure DataGrip and IoTDB are installed:

- DataGrip download: https://www.jetbrains.com/datagrip/download/

- IoTDB download: https://iotdb.apache.org/Download/

## 3. Configuration Guide

### 3.1 Download Driver

Select the appropriate version of the JAR package (choose the `jar-with-dependencies.jar` variant):

- 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

- Option 2: https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-jdbc/2.0.3.3/

![](/img/datagrip-2.png)

### 3.2 Configure Driver

#### Step 1: Open Driver Manager and Create New Driver

1. Open ​​Database Tool Window​​ from the left sidebar → Click the `+` button to create a new configuration.

2. Select the ​`​Driver​`​ button to start configuring a new driver.

![](/img/datagrip-en-3.png)

#### Step 2: Configure Driver Details

1. In the ​​Drivers​​ section, click the `+` button in the `Create New Driver` window.

![](/img/datagrip-en-4.png)

2. Click the `+` button under ​​Driver Files​​ → Select ​​Custom JARs​​.

3. Choose the downloaded IoTDB JDBC driver file (e.g., `iotdb-jdbc-2.0.5-jar-with-dependencies.jar`).

4. Under the ​​General​​ tab, select the JDBC driver class: `org.apache.iotdb.jdbc.IoTDBDriver`.

5. Set the driver name: ​​IoTDB​​.

![](/img/datagrip-en-5.png)

6. Under the ​​Options​​ tab, add `show version` to the ​​Keep-alive query​​ field in the ​​Connection​​ section.

![](/img/datagrip-en-6.png)

7. Click ​​OK​​.

#### Step 3: Create and Test Connection

1. Click the `+` button in the left sidebar → Select ​​Data Source​​ → Choose the newly created driver.

![](/img/datagrip-en-7.png)

2. Enter the driver name and comments (optional).

3. Configure the ​​JDBC URL​​ and enter the IoTDB database password.

4. Click ​`​Test Connection`​​. If successful, it will display `​​Succeeded​` along with server and driver versions.

![](/img/datagrip-en-8.png)

5. Navigate to ​​Schemas​​ → Select ​​All databases / All schemas​​.

![](/img/datagrip-en-9.png)

6. Click ​​Apply​​ → ​​OK​​.

## 4. Usage Guide

1. Database and Table Structure Overview​​

In the ​`​Database Explorer​​ `(left panel), you can view: Database names, Table names and comments, Primary key info (time + tag columns).

![](/img/datagrip-en-10.png)

2. Modify Table Structure​​

Right-click a table → Use the right panel to edit table properties (e.g., columns, constraints).

![](/img/datagrip-en-11.png)

![](/img/datagrip-en-12.png)

3. Data Operations​​

​​View Data​​: Double-click a table to see all records.

​​Run Queries​​: Right-click a table → ​​New Query Console​​ → Write SQL → Click ​​Execute​​.

![](/img/datagrip-en-13.png)

Loading