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
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ If using .NET 5.0 or a later version of the SDK, enter the following command to
```Plain
dotnet add package Apache.IoTDB
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Read/Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ If using .NET 5.0 or a later version of the SDK, enter the following command to
```Plain
dotnet add package Apache.IoTDB
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Read/Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ Clone the source code from git:
git clone https://github.com/apache/iotdb.git
```

The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 1.3.2):
The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 2.0.6):
```shell
git checkout rc/1.3.2
git checkout rc/2.0.6
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

Run Maven to compile in the IoTDB root directory:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ Clone the source code from git:
git clone https://github.com/apache/iotdb.git
```

The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 1.3.2):
The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 2.0.6):
```shell
git checkout rc/1.3.2
git checkout rc/2.0.6
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

Run Maven to compile in the IoTDB root directory:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ cd $GOPATH/src/iotdb-client-go-example/session_example
curl -o session_example.go -L https://github.com/apache/iotdb-client-go/raw/main/example/session_example.go
go run session_example.go
```
* Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. ITableSession Interface
### 2.1 Description
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ cd $GOPATH/src/iotdb-client-go-example/session_example
curl -o session_example.go -L https://github.com/apache/iotdb-client-go/raw/main/example/session_example.go
go run session_example.go
```
* Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. ITableSession Interface
### 2.1 Description
Expand Down
7 changes: 4 additions & 3 deletions src/UserGuide/Master/Table/API/Programming-JDBC_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Add the following dependency to your Maven `pom.xml` file:
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. Read and Write Operations

Expand All @@ -66,13 +67,13 @@ Add the following dependency to your Maven `pom.xml` file:

## 3. Sample Code

**Note:** When using the Table Model, you must specify the `sql_dialect` parameter as `table` in the URL. Example:
**Note:** When using the Table Mode, you must specify the `sql_dialect` parameter as `table` in the URL. Example:

```Java
String url = "jdbc:iotdb://127.0.0.1:6667?sql_dialect=table";
```

You can find the full example code at [GitHub Repository](https://github.com/apache/iotdb/blob/master/example/jdbc/src/main/java/org/apache/iotdb/TableModelJDBCExample.java).
You can find the full example code at [GitHub Repository](https://github.com/apache/iotdb/blob/rc/2.0.1/example/jdbc/src/main/java/org/apache/iotdb/TableModelJDBCExample.java).

Here is an excerpt of the sample code:

Expand Down Expand Up @@ -133,7 +134,7 @@ public class TableModelJDBCExample {
"create table test1.table1(region_id STRING TAG, plant_id STRING TAG, device_id STRING TAG, model STRING ATTRIBUTE, temperature FLOAT FIELD, humidity DOUBLE FIELD) with (TTL=3600000)");

statement.execute(
"create table table2(region_id STRING TAG, plant_id STRING TAG, color STRING ATTRIBUTE, temperature FLOAT FIELD, speed DOUBLE FIELD) with (TTL=6600000)");
"create table table2(region_id STRING ID, plant_id STRING ID, color STRING ATTRIBUTE, temperature FLOAT MEASUREMENT, speed DOUBLE MEASUREMENT) with (TTL=6600000)");

// show tables from current database
try (ResultSet resultSet = statement.executeQuery("SHOW TABLES")) {
Expand Down
3 changes: 2 additions & 1 deletion src/UserGuide/Master/Table/API/Programming-JDBC_timecho.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Add the following dependency to your Maven `pom.xml` file:
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. Read and Write Operations

Expand All @@ -66,7 +67,7 @@ Add the following dependency to your Maven `pom.xml` file:

## 3. Sample Code

**Note:** When using the Table Model, you must specify the `sql_dialect` parameter as `table` in the URL. Example:
**Note:** When using the Table Mode, you must specify the `sql_dialect` parameter as `table` in the URL. Example:

```Java
String url = "jdbc:iotdb://127.0.0.1:6667?sql_dialect=table";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ IoTDB provides a Java native client driver and a session pool management mechani
</dependencies>
```
* The latest version of `iotdb-session` can be viewed [here](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-session/)
* Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Read and Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ IoTDB provides a Java native client driver and a session pool management mechani
</dependencies>
```
* The latest version of `iotdb-session` can be viewed [here](https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-session/)
* Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Read and Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ To use the IoTDB Python API, install the required package using pip:
```shell
pip3 install apache-iotdb>=2.0
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. Read and Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ To use the IoTDB Python API, install the required package using pip:
```shell
pip3 install apache-iotdb>=2.0
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. Read and Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ To install an older version, specify the version explicitly
# Install v0.12.1.2
dotnet add package Apache.IoTDB --version 0.12.1.2
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Quick Start

Expand Down
5 changes: 3 additions & 2 deletions src/UserGuide/Master/Tree/API/Programming-Cpp-Native-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ Clone the source code from git:
git clone https://github.com/apache/iotdb.git
```

The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 1.3.2):
The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 2.0.6):
```shell
git checkout rc/1.3.2
git checkout rc/2.0.6
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

Run Maven to compile in the IoTDB root directory:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Create a Maven project and import the following dependencies(JDK >= 1.8, Maven
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

### 2.2 Code Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Create a Maven project and import the following dependencies(JDK >= 1.8, Maven
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

### 2.2 Code Example

Expand Down
2 changes: 2 additions & 0 deletions src/UserGuide/Master/Tree/API/Programming-Go-Native-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ This article focuses on the usage of `SessionPool`, covering the complete proces
# Compile and run the program
go run session_example.go
```

* Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. Core Steps

Expand Down
3 changes: 2 additions & 1 deletion src/UserGuide/Master/Tree/API/Programming-JDBC_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,11 @@ mvn clean install -pl iotdb-client/jdbc -am -DskipTests
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-jdbc</artifactId>
<version>1.3.1</version>
<version>${project.version}</version>
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 4. Coding Examples

Expand Down
3 changes: 2 additions & 1 deletion src/UserGuide/Master/Tree/API/Programming-JDBC_timecho.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,11 @@ mvn clean install -pl iotdb-client/jdbc -am -DskipTests
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-jdbc</artifactId>
<version>1.3.1</version>
<version>${project.version}</version>
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 4. Coding Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Create a Maven project and add the following dependencies to the pom.xml file (J
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

### 2.2 Creating a Connection Pool Instance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Create a Maven project and add the following dependencies to the pom.xml file (J
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

### 2.2 Creating a Connection Pool Instance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ You have to install thrift (>=0.13) before using the package.

First, download the package: `pip3 install apache-iotdb>=2.0`

Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

You can get an example of using the package to read and write data at here:[Session Example](https://github.com/apache/iotdb/blob/rc/2.0.1/iotdb-client/client-py/session_example.py)

An example of aligned timeseries: [Aligned Timeseries Session Example](https://github.com/apache/iotdb/blob/rc/2.0.1/iotdb-client/client-py/session_aligned_timeseries_example.py)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ You have to install thrift (>=0.13) before using the package.

First, download the package: `pip3 install apache-iotdb>=2.0`

Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

You can get an example of using the package to read and write data at here:[Session Example](https://github.com/apache/iotdb/blob/rc/2.0.1/iotdb-client/client-py/session_example.py)

An example of aligned timeseries: [Aligned Timeseries Session Example](https://github.com/apache/iotdb/blob/rc/2.0.1/iotdb-client/client-py/session_aligned_timeseries_example.py)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ If using .NET 5.0 or a later version of the SDK, enter the following command to
```Plain
dotnet add package Apache.IoTDB
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Read/Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ If using .NET 5.0 or a later version of the SDK, enter the following command to
```Plain
dotnet add package Apache.IoTDB
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Read/Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ Clone the source code from git:
git clone https://github.com/apache/iotdb.git
```

The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 1.3.2):
The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 2.0.6):
```shell
git checkout rc/1.3.2
git checkout rc/2.0.6
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

Run Maven to compile in the IoTDB root directory:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ Clone the source code from git:
git clone https://github.com/apache/iotdb.git
```

The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 1.3.2):
The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 2.0.6):
```shell
git checkout rc/1.3.2
git checkout rc/2.0.6
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

Run Maven to compile in the IoTDB root directory:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ cd $GOPATH/src/iotdb-client-go-example/session_example
curl -o session_example.go -L https://github.com/apache/iotdb-client-go/raw/main/example/session_example.go
go run session_example.go
```
* Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. ITableSession Interface
### 2.1 Description
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ cd $GOPATH/src/iotdb-client-go-example/session_example
curl -o session_example.go -L https://github.com/apache/iotdb-client-go/raw/main/example/session_example.go
go run session_example.go
```
* Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. ITableSession Interface
### 2.1 Description
Expand Down
1 change: 1 addition & 0 deletions src/UserGuide/latest-Table/API/Programming-JDBC_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Add the following dependency to your Maven `pom.xml` file:
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. Read and Write Operations

Expand Down
1 change: 1 addition & 0 deletions src/UserGuide/latest-Table/API/Programming-JDBC_timecho.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Add the following dependency to your Maven `pom.xml` file:
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. Read and Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ IoTDB provides a Java native client driver and a session pool management mechani
</dependencies>
```
* The latest version of `iotdb-session` can be viewed [here](https://repo1.maven.org/maven2/org/apache/iotdb/iotdb-session/)
* Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Read and Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ IoTDB provides a Java native client driver and a session pool management mechani
</dependencies>
```
* The latest version of `iotdb-session` can be viewed [here](https://repo1.maven.org/maven2/com/timecho/iotdb/iotdb-session/)
* Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Read and Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ To use the IoTDB Python API, install the required package using pip:
```shell
pip3 install apache-iotdb>=2.0
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. Read and Write Operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ To use the IoTDB Python API, install the required package using pip:
```shell
pip3 install apache-iotdb>=2.0
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 2. Read and Write Operations

Expand Down
1 change: 1 addition & 0 deletions src/UserGuide/latest/API/Programming-CSharp-Native-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ To install an older version, specify the version explicitly
# Install v0.12.1.2
dotnet add package Apache.IoTDB --version 0.12.1.2
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

## 3. Quick Start

Expand Down
5 changes: 3 additions & 2 deletions src/UserGuide/latest/API/Programming-Cpp-Native-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ Clone the source code from git:
git clone https://github.com/apache/iotdb.git
```

The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 1.3.2):
The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 2.0.6):
```shell
git checkout rc/1.3.2
git checkout rc/2.0.6
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

Run Maven to compile in the IoTDB root directory:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Create a Maven project and import the following dependencies(JDK >= 1.8, Maven
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

### 2.2 Code Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Create a Maven project and import the following dependencies(JDK >= 1.8, Maven
</dependency>
</dependencies>
```
Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.

### 2.2 Code Example

Expand Down
Loading
Loading