Skip to content

add opc-ua-sink in table model data sync #674

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

Closed
leto-b wants to merge 1 commit into from
Closed

add opc-ua-sink in table model data sync #674

Show file tree
Hide file tree
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
39 changes: 29 additions & 10 deletions src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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="5">sink Plugin</td>
<td rowspan="5">Supported</td>
<td>do-nothing-sink</td>
<td>Does not process outgoing data.</td>
</tr>
Expand All @@ -206,6 +206,11 @@ 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>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>

Expand Down Expand Up @@ -418,7 +423,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:

Expand Down Expand Up @@ -491,9 +496,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** |
| :----------------------- | :----------------------------------------------------------- | :----------------------------------------------------------- | :----------- | :---------------------------------------------------------- |
Expand All @@ -512,9 +517,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 |
| :-------------------------- | :----------------------------------------------------------- | :----------------------------------------------------------- | :------- | :------------ |
Expand All @@ -529,7 +534,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 |
| :--------------------------- | :----------------------------------------------------------- | :----------------------------------------------------------- | :------- | :------------ |
Expand All @@ -542,7 +547,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 |
| :-------------------------- | :----------------------------------------------------------- | :----------------------------------------------------------- | :------- | :------------ |
Expand All @@ -557,4 +562,18 @@ 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 | - |
| ssl.trust-store-pwd | Password for the trust store certificate. | Integer | 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" |
Loading