This is an automated email from the ASF dual-hosted git repository.
critas pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 3122ed2f add write back sink to table model data sync (#671)
3122ed2f is described below
commit 3122ed2f42f36f465c6ad8e754699cc894029ae2
Author: leto-b <[email protected]>
AuthorDate: Fri Mar 28 10:09:33 2025 +0800
add write back sink to table model data sync (#671)
* add write back sink to table model data sync
* add opc ua sink and delete apache
---
.../Master/Table/User-Manual/Data-Sync_apache.md | 12 +++---
.../Master/Table/User-Manual/Data-Sync_timecho.md | 48 +++++++++++++++++-----
.../latest-Table/User-Manual/Data-Sync_apache.md | 12 +++---
.../latest-Table/User-Manual/Data-Sync_timecho.md | 48 +++++++++++++++++-----
.../Master/Table/User-Manual/Data-Sync_apache.md | 4 +-
.../Master/Table/User-Manual/Data-Sync_timecho.md | 34 +++++++++++++--
.../latest-Table/User-Manual/Data-Sync_apache.md | 4 +-
.../latest-Table/User-Manual/Data-Sync_timecho.md | 34 +++++++++++++--
8 files changed, 154 insertions(+), 42 deletions(-)
diff --git a/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
b/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
index df9ed3a3..099a8a20 100644
--- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
@@ -401,7 +401,7 @@ WITH SINK (
```
-## 4. Reference: Notes
+## Reference: Notes
You can adjust the parameters for data synchronization by modifying the IoTDB
configuration file (`iotdb-system.properties`), such as the directory for
storing synchronized data. The complete configuration is as follows:
@@ -464,9 +464,9 @@ pipe_sink_max_client_number=16
pipe_all_sinks_rate_limit_bytes_per_second=-1
```
-## 5. Reference: Parameter Description
+## Reference: Parameter Description
-### 5.1 source parameter
+### source parameter
| **Parameter** | **Description**
| **Value Range** |
**Required** | **Default Value** |
| :----------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :----------- |
:---------------------------------------------------------- |
@@ -485,9 +485,9 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
> - True (recommended): Under this value, the task will process and send the
> data in real-time. Its characteristics are high timeliness and low
> throughput.
> - False: Under this value, the task will process and send the data in
> batches (according to the underlying data files). Its characteristics are
> low timeliness and high throughput.
-### 5.2 sink parameter
+### sink parameter
-#### 5.2.1 iotdb-thrift-sink
+#### iotdb-thrift-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
@@ -502,7 +502,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | When the selected RPC compression algorithm is
zstd, this parameter can be used to additionally configure the compression
level of the zstd algorithm. | Int: [-131072, 22]
| No | 3 |
| rate-limit-bytes-per-second | The maximum number of bytes allowed to be
transmitted per second. The compressed bytes (such as after compression) are
calculated. If it is less than 0, there is no limit. | Double:
[Double.MIN_VALUE, Double.MAX_VALUE] | No | -1 |
-#### 5.2.2 iotdb-thrift-ssl-sink
+#### iotdb-thrift-ssl-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
diff --git a/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
b/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
index 65508753..e8383920 100644
--- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
@@ -189,8 +189,8 @@ Detailed introduction of pre-installed plugins is as
follows (for detailed param
<td>Default processor plugin that does not process incoming
data.</td>
</tr>
<tr>
- <td rowspan="4">sink Plugin</td>
- <td rowspan="4">Supported</td>
+ <td rowspan="6">sink Plugin</td>
+ <td rowspan="6">Supported</td>
<td>do-nothing-sink</td>
<td>Does not process outgoing data.</td>
</tr>
@@ -206,6 +206,14 @@ Detailed introduction of pre-installed plugins is as
follows (for detailed param
<td>iotdb-thrift-ssl-sink</td>
<td>Used for data transmission between IoTDB instances (V2.0.0+).
Uses Thrift RPC framework with a multi-threaded sync blocking IO model,
suitable for high-security scenarios.</td>
</tr>
+ <tr>
+ <td>write-back-sink</td>
+ <td>A data write-back plugin for IoTDB (V2.0.2 and above) to
achieve the effect of materialized views.</td>
+ </tr>
+ <tr>
+ <td>opc-ua-sink</td>
+ <td>An OPC UA protocol data transfer plugin for IoTDB (V2.0.2 and
above), supporting both Client/Server and Pub/Sub communication modes. </td>
+ </tr>
</tbody>
</table>
@@ -418,7 +426,7 @@ WITH SINK (
)
```
-## 4. Reference: Notes
+## Reference: Notes
You can adjust the parameters for data synchronization by modifying the IoTDB
configuration file (`iotdb-system.properties`), such as the directory for
storing synchronized data. The complete configuration is as follows:
@@ -491,9 +499,9 @@ pipe_air_gap_receiver_port=9780
pipe_all_sinks_rate_limit_bytes_per_second=-1
```
-## 5. Reference: Parameter Description
+## Reference: Parameter Description
-### 5.1 source parameter
+### source parameter
| **Parameter** | **Description**
| **Value Range** |
**Required** | **Default Value** |
| :----------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :----------- |
:---------------------------------------------------------- |
@@ -512,9 +520,9 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
> - True (recommended): Under this value, the task will process and send the
> data in real-time. Its characteristics are high timeliness and low
> throughput.
> - False: Under this value, the task will process and send the data in
> batches (according to the underlying data files). Its characteristics are
> low timeliness and high throughput.
-### 5.2 sink parameter
+### sink parameter
-#### 5.2.1 iotdb-thrift-sink
+#### iotdb-thrift-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
@@ -529,7 +537,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | When the selected RPC compression algorithm is
zstd, this parameter can be used to additionally configure the compression
level of the zstd algorithm. | Int: [-131072, 22]
| No | 3 |
| rate-limit-bytes-per-second | The maximum number of bytes allowed to be
transmitted per second. The compressed bytes (such as after compression) are
calculated. If it is less than 0, there is no limit. | Double:
[Double.MIN_VALUE, Double.MAX_VALUE] | No | -1 |
-#### 5.2.2 iotdb-air-gap-sink
+#### iotdb-air-gap-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
| :--------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
@@ -542,7 +550,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| rate-limit-bytes-per-second | The maximum number of bytes allowed to be
transmitted per second. The compressed bytes (such as after compression) are
calculated. If it is less than 0, there is no limit. | Double:
[Double.MIN_VALUE, Double.MAX_VALUE] | No | -1 |
| air-gap.handshake-timeout-ms | The timeout duration for the handshake
requests when the sender and receiver attempt to establish a connection for the
first time, in milliseconds. | Integer
| No | 5000 |
-#### 5.2.3 iotdb-thrift-ssl-sink
+#### iotdb-thrift-ssl-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
@@ -557,4 +565,24 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | When the selected RPC compression algorithm is
zstd, this parameter can be used to additionally configure the compression
level of the zstd algorithm. | Int: [-131072, 22]
| No | 3 |
| rate-limit-bytes-per-second | Maximum bytes allowed per second for
transmission (calculated after compression). Set to a value less than 0 for no
limit. | Double: [Double.MIN_VALUE, Double.MAX_VALUE] | No
| -1 |
| ssl.trust-store-path | Path to the trust store certificate for SSL
connection. | String.Example:
'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | Yes | -
|
-| ssl.trust-store-pwd | Password for the trust store certificate.
| Integer |
Yes | - |
\ No newline at end of file
+| ssl.trust-store-pwd | Password for the trust store certificate.
| Integer |
Yes | - |
+
+#### write-back-sink
+
+| **Parameter** | **Description**
| **value Range**
| **Required** | **Default Value** |
+| ---------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | --------
|--------------|
+| sink | write-back-sink
| String: write-back-sink | Yes
| - |
+
+#### opc-ua-sink
+
+| **Parameter** | **Description**
|Value Range
| Required | Default Value
|
+|:-------------------------------------|:-------------------------------------------------------------------------------------------------------|
:-------------------------------------
|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| sink | opc-ua-sink
| String:
opc-ua-sink | Yes | -
|
+| sink.opcua.model | OPC UA model used
| String:
client-server / pub-sub | No | pub-sub
|
+| sink.opcua.tcp.port | OPC UA's TCP port
| Integer:
[0, 65536] | No | 12686
|
+| sink.opcua.https.port | OPC UA's HTTPS port
| Integer:
[0, 65536] | No | 8443
|
+| sink.opcua.security.dir | Directory for OPC UA's keys and
certificates |
String: Path, supports absolute and relative directories | No |
Opc_security folder`<httpsPort: tcpPort>`in the conf directory of the DataNode
related to iotdb <br> If there is no conf directory for iotdb (such as
launching DataNode in IDEA), it will be the iotdb_opc_Security
folder`<httpsPort: tcpPort>`in the user's home directory |
+| sink.opcua.enable-anonymous-access | Whether OPC UA allows anonymous
access |
Boolean | No | true
|
+| sink.user | User for OPC UA, specified in the
configuration |
String | No | root
|
+| sink.password | Password for OPC UA, specified in the
configuration | String
| No | root
|
+| sink.opcua.placeholder | A placeholder string used to
substitute for null mapping paths when the value of the ID column is null |
String | Optional | "null"
|
\ No newline at end of file
diff --git a/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
b/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
index df9ed3a3..099a8a20 100644
--- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
@@ -401,7 +401,7 @@ WITH SINK (
```
-## 4. Reference: Notes
+## Reference: Notes
You can adjust the parameters for data synchronization by modifying the IoTDB
configuration file (`iotdb-system.properties`), such as the directory for
storing synchronized data. The complete configuration is as follows:
@@ -464,9 +464,9 @@ pipe_sink_max_client_number=16
pipe_all_sinks_rate_limit_bytes_per_second=-1
```
-## 5. Reference: Parameter Description
+## Reference: Parameter Description
-### 5.1 source parameter
+### source parameter
| **Parameter** | **Description**
| **Value Range** |
**Required** | **Default Value** |
| :----------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :----------- |
:---------------------------------------------------------- |
@@ -485,9 +485,9 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
> - True (recommended): Under this value, the task will process and send the
> data in real-time. Its characteristics are high timeliness and low
> throughput.
> - False: Under this value, the task will process and send the data in
> batches (according to the underlying data files). Its characteristics are
> low timeliness and high throughput.
-### 5.2 sink parameter
+### sink parameter
-#### 5.2.1 iotdb-thrift-sink
+#### iotdb-thrift-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
@@ -502,7 +502,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | When the selected RPC compression algorithm is
zstd, this parameter can be used to additionally configure the compression
level of the zstd algorithm. | Int: [-131072, 22]
| No | 3 |
| rate-limit-bytes-per-second | The maximum number of bytes allowed to be
transmitted per second. The compressed bytes (such as after compression) are
calculated. If it is less than 0, there is no limit. | Double:
[Double.MIN_VALUE, Double.MAX_VALUE] | No | -1 |
-#### 5.2.2 iotdb-thrift-ssl-sink
+#### iotdb-thrift-ssl-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
diff --git a/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
b/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
index 65508753..e8383920 100644
--- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
@@ -189,8 +189,8 @@ Detailed introduction of pre-installed plugins is as
follows (for detailed param
<td>Default processor plugin that does not process incoming
data.</td>
</tr>
<tr>
- <td rowspan="4">sink Plugin</td>
- <td rowspan="4">Supported</td>
+ <td rowspan="6">sink Plugin</td>
+ <td rowspan="6">Supported</td>
<td>do-nothing-sink</td>
<td>Does not process outgoing data.</td>
</tr>
@@ -206,6 +206,14 @@ Detailed introduction of pre-installed plugins is as
follows (for detailed param
<td>iotdb-thrift-ssl-sink</td>
<td>Used for data transmission between IoTDB instances (V2.0.0+).
Uses Thrift RPC framework with a multi-threaded sync blocking IO model,
suitable for high-security scenarios.</td>
</tr>
+ <tr>
+ <td>write-back-sink</td>
+ <td>A data write-back plugin for IoTDB (V2.0.2 and above) to
achieve the effect of materialized views.</td>
+ </tr>
+ <tr>
+ <td>opc-ua-sink</td>
+ <td>An OPC UA protocol data transfer plugin for IoTDB (V2.0.2 and
above), supporting both Client/Server and Pub/Sub communication modes. </td>
+ </tr>
</tbody>
</table>
@@ -418,7 +426,7 @@ WITH SINK (
)
```
-## 4. Reference: Notes
+## Reference: Notes
You can adjust the parameters for data synchronization by modifying the IoTDB
configuration file (`iotdb-system.properties`), such as the directory for
storing synchronized data. The complete configuration is as follows:
@@ -491,9 +499,9 @@ pipe_air_gap_receiver_port=9780
pipe_all_sinks_rate_limit_bytes_per_second=-1
```
-## 5. Reference: Parameter Description
+## Reference: Parameter Description
-### 5.1 source parameter
+### source parameter
| **Parameter** | **Description**
| **Value Range** |
**Required** | **Default Value** |
| :----------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :----------- |
:---------------------------------------------------------- |
@@ -512,9 +520,9 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
> - True (recommended): Under this value, the task will process and send the
> data in real-time. Its characteristics are high timeliness and low
> throughput.
> - False: Under this value, the task will process and send the data in
> batches (according to the underlying data files). Its characteristics are
> low timeliness and high throughput.
-### 5.2 sink parameter
+### sink parameter
-#### 5.2.1 iotdb-thrift-sink
+#### iotdb-thrift-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
@@ -529,7 +537,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | When the selected RPC compression algorithm is
zstd, this parameter can be used to additionally configure the compression
level of the zstd algorithm. | Int: [-131072, 22]
| No | 3 |
| rate-limit-bytes-per-second | The maximum number of bytes allowed to be
transmitted per second. The compressed bytes (such as after compression) are
calculated. If it is less than 0, there is no limit. | Double:
[Double.MIN_VALUE, Double.MAX_VALUE] | No | -1 |
-#### 5.2.2 iotdb-air-gap-sink
+#### iotdb-air-gap-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
| :--------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
@@ -542,7 +550,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| rate-limit-bytes-per-second | The maximum number of bytes allowed to be
transmitted per second. The compressed bytes (such as after compression) are
calculated. If it is less than 0, there is no limit. | Double:
[Double.MIN_VALUE, Double.MAX_VALUE] | No | -1 |
| air-gap.handshake-timeout-ms | The timeout duration for the handshake
requests when the sender and receiver attempt to establish a connection for the
first time, in milliseconds. | Integer
| No | 5000 |
-#### 5.2.3 iotdb-thrift-ssl-sink
+#### iotdb-thrift-ssl-sink
| **Parameter** | **Description**
| Value Range |
Required | Default Value |
| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
@@ -557,4 +565,24 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | When the selected RPC compression algorithm is
zstd, this parameter can be used to additionally configure the compression
level of the zstd algorithm. | Int: [-131072, 22]
| No | 3 |
| rate-limit-bytes-per-second | Maximum bytes allowed per second for
transmission (calculated after compression). Set to a value less than 0 for no
limit. | Double: [Double.MIN_VALUE, Double.MAX_VALUE] | No
| -1 |
| ssl.trust-store-path | Path to the trust store certificate for SSL
connection. | String.Example:
'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | Yes | -
|
-| ssl.trust-store-pwd | Password for the trust store certificate.
| Integer |
Yes | - |
\ No newline at end of file
+| ssl.trust-store-pwd | Password for the trust store certificate.
| Integer |
Yes | - |
+
+#### write-back-sink
+
+| **Parameter** | **Description**
| **value Range**
| **Required** | **Default Value** |
+| ---------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | --------
|--------------|
+| sink | write-back-sink
| String: write-back-sink | Yes
| - |
+
+#### opc-ua-sink
+
+| **Parameter** | **Description**
|Value Range
| Required | Default Value
|
+|:-------------------------------------|:-------------------------------------------------------------------------------------------------------|
:-------------------------------------
|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| sink | opc-ua-sink
| String:
opc-ua-sink | Yes | -
|
+| sink.opcua.model | OPC UA model used
| String:
client-server / pub-sub | No | pub-sub
|
+| sink.opcua.tcp.port | OPC UA's TCP port
| Integer:
[0, 65536] | No | 12686
|
+| sink.opcua.https.port | OPC UA's HTTPS port
| Integer:
[0, 65536] | No | 8443
|
+| sink.opcua.security.dir | Directory for OPC UA's keys and
certificates |
String: Path, supports absolute and relative directories | No |
Opc_security folder`<httpsPort: tcpPort>`in the conf directory of the DataNode
related to iotdb <br> If there is no conf directory for iotdb (such as
launching DataNode in IDEA), it will be the iotdb_opc_Security
folder`<httpsPort: tcpPort>`in the user's home directory |
+| sink.opcua.enable-anonymous-access | Whether OPC UA allows anonymous
access |
Boolean | No | true
|
+| sink.user | User for OPC UA, specified in the
configuration |
String | No | root
|
+| sink.password | Password for OPC UA, specified in the
configuration | String
| No | root
|
+| sink.opcua.placeholder | A placeholder string used to
substitute for null mapping paths when the value of the ID column is null |
String | Optional | "null"
|
\ No newline at end of file
diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
index 20e2a316..abd3f7f6 100644
--- a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
+++ b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
@@ -199,7 +199,7 @@ IoTDB> SHOW PIPEPLUGINS
<tr>
<td>iotdb-thrift-ssl-sink</td>
<td>用于 IoTDB 与 IoTDB(V2.0.0 及以上)之间的数据传输。使用 Thrift RPC 框架传输数据,多线程
sync blocking IO 模型,适用于安全需求较高的场景 </td>
- </tr>
+ </tr>
</tbody>
</table>
@@ -509,4 +509,4 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | 所选取的 rpc 压缩算法为 zstd 时,可使用该参数额外配置 zstd 算法的压缩等级
| Int: [-131072, 22] | 选填 | 3
|
| rate-limit-bytes-per-second | 每秒最大允许传输的 byte 数,计算压缩后的 byte(如压缩),若小于 0 则不限制 |
Double: [Double.MIN_VALUE, Double.MAX_VALUE] | 选填 | -1
|
| ssl.trust-store-path | 连接目标端 DataNode 所需的 trust store 证书路径
| String.Example: '127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669',
'127.0.0.1:6667' | 必填 | - |
-| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer | 必填 | -
|
\ No newline at end of file
+| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer | 必填 | -
|
diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
index fc65c8d9..7a9f52df 100644
--- a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
+++ b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
@@ -188,8 +188,8 @@ IoTDB> SHOW PIPEPLUGINS
<td>默认的 processor 插件,不对传入的数据做任何的处理</td>
</tr>
<tr>
- <td rowspan="4">sink 插件</td>
- <td rowspan="4">支持</td>
+ <td rowspan="6">sink 插件</td>
+ <td rowspan="6">支持</td>
<td>do-nothing-sink</td>
<td>不对发送出的数据做任何的处理</td>
</tr>
@@ -205,6 +205,14 @@ IoTDB> SHOW PIPEPLUGINS
<td>iotdb-thrift-ssl-sink</td>
<td>用于 IoTDB 与 IoTDB(V2.0.0 及以上)之间的数据传输。使用 Thrift RPC 框架传输数据,多线程
sync blocking IO 模型,适用于安全需求较高的场景 </td>
</tr>
+ <tr>
+ <td>write-back-sink</td>
+ <td>用于 IoTDB (V2.0.2 及以上)的数据回写插件,实现物化视图的作用。</td>
+ </tr>
+ <tr>
+ <td>opc-ua-sink</td>
+ <td>用于 IoTDB (V2.0.2 及以上)支持OPC UA协议的数据传输插件,支持Client/Server 和
Pub/Sub 两种通信模式。 </td>
+ </tr>
</tbody>
</table>
@@ -565,4 +573,24 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | 所选取的 rpc 压缩算法为 zstd 时,可使用该参数额外配置 zstd 算法的压缩等级
| Int: [-131072, 22] | 选填 | 3
|
| rate-limit-bytes-per-second | 每秒最大允许传输的 byte 数,计算压缩后的 byte(如压缩),若小于 0 则不限制 |
Double: [Double.MIN_VALUE, Double.MAX_VALUE] | 选填 | -1
|
| ssl.trust-store-path | 连接目标端 DataNode 所需的 trust store 证书路径
| String.Example: '127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669',
'127.0.0.1:6667' | 必填 | - |
-| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer | 必填 | -
|
\ No newline at end of file
+| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer | 必填 | -
|
+
+#### write-back-sink
+
+| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
+| ---------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
-------- |
+| sink | write-back-sink
| String: write-back-sink | 必填
| - |
+
+#### opc-ua-sink
+
+| **参数** | **描述** |
**value 取值范围** | **是否必填** | **默认值**
|
+|------------------------------------|----------------------------------|-----------------------------|
----------
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| sink | OPC UA SINK |
String: opc-ua-sink | 必填 | -
|
+| sink.opcua.model | OPC UA 使用的模式 |
String: client-server / pub-sub | 选填 | pub-sub
|
+| sink.opcua.tcp.port | OPC UA 的 TCP 端口 |
Integer: [0, 65536] | 选填 | 12686
|
+| sink.opcua.https.port | OPC UA 的 HTTPS 端口 |
Integer: [0, 65536] | 选填 | 8443
|
+| sink.opcua.security.dir | OPC UA 的密钥及证书目录 |
String: Path,支持绝对及相对目录 | 选填 | iotdb 相关 DataNode 的 conf 目录下的
opc_security 文件夹 `<httpsPort:tcpPort>`。<br>如无 iotdb 的 conf 目录(例如 IDEA 中启动
DataNode),则为用户主目录下的 iotdb_opc_security 文件夹 `<httpsPort:tcpPort>` |
+| sink.opcua.enable-anonymous-access | OPC UA 是否允许匿名访问 |
Boolean | 选填 | true
|
+| sink.user | 用户,这里指 OPC UA 的允许用户 |
String | 选填 | root
|
+| sink.password | 密码,这里指 OPC UA 的允许密码 |
String | 选填 | root
|
+| sink.opcua.placeholder | 当ID列的值出现null时,用于替代null映射路径的占位字符串 |
String | 选填 | "null"
|
\ No newline at end of file
diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
index 20e2a316..abd3f7f6 100644
--- a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
+++ b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
@@ -199,7 +199,7 @@ IoTDB> SHOW PIPEPLUGINS
<tr>
<td>iotdb-thrift-ssl-sink</td>
<td>用于 IoTDB 与 IoTDB(V2.0.0 及以上)之间的数据传输。使用 Thrift RPC 框架传输数据,多线程
sync blocking IO 模型,适用于安全需求较高的场景 </td>
- </tr>
+ </tr>
</tbody>
</table>
@@ -509,4 +509,4 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | 所选取的 rpc 压缩算法为 zstd 时,可使用该参数额外配置 zstd 算法的压缩等级
| Int: [-131072, 22] | 选填 | 3
|
| rate-limit-bytes-per-second | 每秒最大允许传输的 byte 数,计算压缩后的 byte(如压缩),若小于 0 则不限制 |
Double: [Double.MIN_VALUE, Double.MAX_VALUE] | 选填 | -1
|
| ssl.trust-store-path | 连接目标端 DataNode 所需的 trust store 证书路径
| String.Example: '127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669',
'127.0.0.1:6667' | 必填 | - |
-| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer | 必填 | -
|
\ No newline at end of file
+| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer | 必填 | -
|
diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
index fc65c8d9..7a9f52df 100644
--- a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
+++ b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
@@ -188,8 +188,8 @@ IoTDB> SHOW PIPEPLUGINS
<td>默认的 processor 插件,不对传入的数据做任何的处理</td>
</tr>
<tr>
- <td rowspan="4">sink 插件</td>
- <td rowspan="4">支持</td>
+ <td rowspan="6">sink 插件</td>
+ <td rowspan="6">支持</td>
<td>do-nothing-sink</td>
<td>不对发送出的数据做任何的处理</td>
</tr>
@@ -205,6 +205,14 @@ IoTDB> SHOW PIPEPLUGINS
<td>iotdb-thrift-ssl-sink</td>
<td>用于 IoTDB 与 IoTDB(V2.0.0 及以上)之间的数据传输。使用 Thrift RPC 框架传输数据,多线程
sync blocking IO 模型,适用于安全需求较高的场景 </td>
</tr>
+ <tr>
+ <td>write-back-sink</td>
+ <td>用于 IoTDB (V2.0.2 及以上)的数据回写插件,实现物化视图的作用。</td>
+ </tr>
+ <tr>
+ <td>opc-ua-sink</td>
+ <td>用于 IoTDB (V2.0.2 及以上)支持OPC UA协议的数据传输插件,支持Client/Server 和
Pub/Sub 两种通信模式。 </td>
+ </tr>
</tbody>
</table>
@@ -565,4 +573,24 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor.zstd.level | 所选取的 rpc 压缩算法为 zstd 时,可使用该参数额外配置 zstd 算法的压缩等级
| Int: [-131072, 22] | 选填 | 3
|
| rate-limit-bytes-per-second | 每秒最大允许传输的 byte 数,计算压缩后的 byte(如压缩),若小于 0 则不限制 |
Double: [Double.MIN_VALUE, Double.MAX_VALUE] | 选填 | -1
|
| ssl.trust-store-path | 连接目标端 DataNode 所需的 trust store 证书路径
| String.Example: '127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669',
'127.0.0.1:6667' | 必填 | - |
-| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer | 必填 | -
|
\ No newline at end of file
+| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer | 必填 | -
|
+
+#### write-back-sink
+
+| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
+| ---------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
-------- |
+| sink | write-back-sink
| String: write-back-sink | 必填
| - |
+
+#### opc-ua-sink
+
+| **参数** | **描述** |
**value 取值范围** | **是否必填** | **默认值**
|
+|------------------------------------|----------------------------------|-----------------------------|
----------
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| sink | OPC UA SINK |
String: opc-ua-sink | 必填 | -
|
+| sink.opcua.model | OPC UA 使用的模式 |
String: client-server / pub-sub | 选填 | pub-sub
|
+| sink.opcua.tcp.port | OPC UA 的 TCP 端口 |
Integer: [0, 65536] | 选填 | 12686
|
+| sink.opcua.https.port | OPC UA 的 HTTPS 端口 |
Integer: [0, 65536] | 选填 | 8443
|
+| sink.opcua.security.dir | OPC UA 的密钥及证书目录 |
String: Path,支持绝对及相对目录 | 选填 | iotdb 相关 DataNode 的 conf 目录下的
opc_security 文件夹 `<httpsPort:tcpPort>`。<br>如无 iotdb 的 conf 目录(例如 IDEA 中启动
DataNode),则为用户主目录下的 iotdb_opc_security 文件夹 `<httpsPort:tcpPort>` |
+| sink.opcua.enable-anonymous-access | OPC UA 是否允许匿名访问 |
Boolean | 选填 | true
|
+| sink.user | 用户,这里指 OPC UA 的允许用户 |
String | 选填 | root
|
+| sink.password | 密码,这里指 OPC UA 的允许密码 |
String | 选填 | root
|
+| sink.opcua.placeholder | 当ID列的值出现null时,用于替代null映射路径的占位字符串 |
String | 选填 | "null"
|
\ No newline at end of file