Skip to content

Update readme.md #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CritasWang merged 1 commit into from
May 29, 2025
Merged

Update readme.md #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 61 additions & 59 deletions examples/mybatis-generator/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,85 +18,87 @@
under the License.

-->

# Mybatis-Generator Demo

## Introduction

This demo shows how to use IoTDB-Mybatis-Generator
This demo shows how to use IoTDB-Mybatis-Generator

### Version usage

IoTDB: 2.0.2
mybatis-generator-plugin: 1.3.2
IoTDB: 2.0.2
mybatis-generator-plugin: 1.3.2

### 1. Install IoTDB

please refer to [https://iotdb.apache.org/#/Download](https://iotdb.apache.org/#/Download)
please refer to [https://iotdb.apache.org/#/Download](https://iotdb.apache.org/#/Download)

### 2. Startup IoTDB

please refer to [Quick Start](http://iotdb.apache.org/UserGuide/Master/Get%20Started/QuickStart.html)
Then we need to create a database 'test' by cli in table model
```
create database test;
use test;
```
Then we need to create a database 'table'
```
CREATE TABLE mix3 (
time TIMESTAMP TIME,
region STRING TAG,
plant_id STRING TAG,
device_id STRING TAG,
model_id STRING ATTRIBUTE,
maintenance STRING ATTRIBUTE,
temperature FLOAT FIELD,
humidity FLOAT FIELD,
status Boolean FIELD,
arrival_time TIMESTAMP FIELD
) WITH (TTL=31536000000);
```
please refer to [Quick Start](http://iotdb.apache.org/UserGuide/Master/Get%20Started/QuickStart.html)

Then we need to create a database 'test' by cli in table model
```
create database test;
use test;
```
Then we need to create a database 'table'
```
CREATE TABLE mix3 (
time TIMESTAMP TIME,
region STRING TAG,
plant_id STRING TAG,
device_id STRING TAG,
model_id STRING ATTRIBUTE,
maintenance STRING ATTRIBUTE,
temperature FLOAT FIELD,
humidity FLOAT FIELD,
status Boolean FIELD,
arrival_time TIMESTAMP FIELD
) WITH (TTL=31536000000);
```

### 3. Build Dependencies with Maven in your Project

```
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.2</version>
<dependencies>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>mybatis-generator-plugin</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
</configuration>
</plugin>
</plugins>
</build>
```
```
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.2</version>
<dependencies>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>mybatis-generator-plugin</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
</configuration>
</plugin>
</plugins>
</build>
```

### 5. put The generatorConfig.xml in your project

The location of the ` configurationFile ` configuration ` generatorConfig. xml ` file can be found in the ` src/main/resources ` template of this project for reference` Copy its content and place it in the corresponding location
The location of the ` configurationFile ` configuration ` generatorConfig.xml ` file can be found in the ` src/main/resources ` template of this project for reference` Copy its content and place it in the corresponding location

### 6. exec 'mvn mybatis-generator:generate'

Execute the command at the location of the 'pom' in the project:` Mvn mybatis generator: generate generates corresponding Java classes and mapper files
Execute the command at the location of the 'pom' in the project:` Mvn mybatis generator: generate generates corresponding Java classes and mapper files

### 7、the target file location
You can see the target file in your Project
```
org/apache/iotdb/mybatis/plugin/model/Mix.java
org/apache/iotdb/mybatis/plugin/mapper/MixMapper.java
org/apache/iotdb/mybatis/plugin/xml/MixMapper.xml

```

You can see the target file in your Project

```
org/apache/iotdb/mybatis/plugin/model/Mix.java
org/apache/iotdb/mybatis/plugin/mapper/MixMapper.java
org/apache/iotdb/mybatis/plugin/xml/MixMapper.xml
```