This is an automated email from the ASF dual-hosted git repository.
caogaofei 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 5f48d78 fix debug
5f48d78 is described below
commit 5f48d7835250cbe03c4e663ee30240e6c39ecd59
Author: majialin <[email protected]>
AuthorDate: Thu Aug 22 19:31:43 2024 +0800
fix debug
---
.../Master/User-Manual/Data-Sync_apache.md | 115 +-------------------
.../latest/User-Manual/Data-Sync_apache.md | 115 +-------------------
.../Master/User-Manual/Data-Sync_apache.md | 121 +--------------------
.../latest/User-Manual/Data-Sync_apache.md | 121 +--------------------
4 files changed, 6 insertions(+), 466 deletions(-)
diff --git a/src/UserGuide/Master/User-Manual/Data-Sync_apache.md
b/src/UserGuide/Master/User-Manual/Data-Sync_apache.md
index 0206d87..d6cd295 100644
--- a/src/UserGuide/Master/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/Master/User-Manual/Data-Sync_apache.md
@@ -118,7 +118,7 @@ In order to make the overall architecture more flexible to
match different synch
| Modules | Plugins | Pre-configured Plugins |
Customised Plugins |
|------------------|---------------|---------------------------------------|--------------------|
| Extract (Source) | Source Plugin | iotdb-source |
Not Supported |
-| Send (Sink) | Sink plugin | iotdb-thrift-sink, iotdb-air-gap-sink |
Support |
+| Send (Sink) | Sink plugin | iotdb-thrift-sink| Support |
#### Preconfigured Plugins
@@ -128,8 +128,6 @@ The preset plugins are listed below:
|-----------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| iotdb-source | source plugin | Default source plugin for extracting
IoTDB historical or real-time data
| 1.2.x
|
| iotdb-thrift-sink | sink plugin | Used for data transfer between IoTDB
(v1.2.0 and above) and IoTDB (v1.2.0 and above). Uses the Thrift RPC framework
to transfer data, multi-threaded async non-blocking IO model, high transfer
performance, especially for scenarios where the target is distributed | 1.2.x
|
-| iotdb-air-gap-sink | sink plugin | Used for data synchronization from
IoTDB (v1.2.2+) to IoTDB (v1.2.2+) across unidirectional data gates. Supported
gate models include Nanrui Syskeeper 2000, etc.
| 1.2.2+
|
-| iotdb-thrift-ssl-sink | sink plugin | Used for data synchronization from
IoTDB (v1.3.1+) to IoTDB (v1.2.0+). Uses the Thrift RPC framework to transfer
data, single-thread blocking IO model.
| 1.3.1+
|
Detailed parameters for each plugin can be found in the [Parameter
Description](#sink-parameters) section of this document.
@@ -150,10 +148,8 @@ IoTDB> show pipeplugins
+------------------------------+--------------------------------------------------------------------------------------------+---------+
| DO-NOTHING-PROCESSOR| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.processor.DoNothingProcessor|
|
| DO-NOTHING-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.DoNothingSink| |
-| IOTDB-AIR-GAP-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.IoTDBAirGapSink| |
| IOTDB-SOURCE| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.source.IoTDBSOURCE| |
| IOTDB-THRIFT-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.IoTDBThriftSink| |
-|IOTDB-THRIFT-SSL-SINK(V1.3.1+)|
Builtin|org.apache.iotdb.commons.pipe.plugin.builtin.sink.iotdb.thrift.IoTDBThriftSslSink|
|
+------------------------------+----------+---------------------------------------------------------------------------------+---------+
```
@@ -202,43 +198,6 @@ with SINK (
```
-### Bidirectional data transfer
-
-This example is used to demonstrate a scenario where two IoTDBs are
dual-active with each other, with the data link shown below:
-
-
-
-In this example, in order to avoid an infinite loop of data, the parameter
`'source.forwarding-pipe-requests` needs to be set to ``false`` on both A and B
to indicate that the data transferred from the other pipe will not be
forwarded. Also set `'source.history.enable'` to `false` to indicate that
historical data is not transferred, i.e., data prior to the creation of the
task is not synchronised.
-
-The detailed statement is as follows:
-
-Execute the following statements on A IoTDB:
-
-```Go
-create pipe AB
-with source (
- 'source.forwarding-pipe-requests' = 'false',
-with sink (
- 'sink'='iotdb-thrift-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6668'
-)
-```
-
-Execute the following statements on B IoTDB:
-
-```Go
-create pipe BA
-with source (
- 'source.forwarding-pipe-requests' = 'false',
-with sink (
- 'sink'='iotdb-thrift-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6667'
-)
-```
-
-
### Cascading Data Transfer
@@ -272,41 +231,6 @@ with sink (
)
```
-### Transmission of data through an air gap
-
-This example is used to demonstrate a scenario where data from one IoTDB is
synchronised to another IoTDB via a unidirectional gate, with the data link
shown below:
-
-
-
-In this example, you need to use the iotdb-air-gap-sink plugin in the sink
task (currently supports some models of network gates, please contact the staff
of Timecho Technology to confirm the specific model), and after configuring the
network gate, execute the following statements on IoTDB A, where ip and port
fill in the information of the network gate, and the detailed statements are as
follows:
-
-```Go
-create pipe A2B
-with sink (
- 'sink'='iotdb-air-gap-sink',
- 'sink.ip'='10.53.53.53',
- 'sink.port'='9780'
-)
-```
-
-### Transfer data using SSL protocol
-
-This example demonstrates the scenario of configuring IoTDB one-way data
synchronization using the SSL protocol, with the data link shown in the
following figure:
-
-
-
-In this scenario, it is necessary to use IoTDB's iotdb-thrift-ssl-sink plugin.
We can create a synchronization task called A2B and configure the password and
address of our own certificate. The detailed statement is as follows:
-```Sql
-create pipe A2B
-with sink (
- 'sink'='iotdb-thrift-ssl-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6669',
- 'ssl.trust-store-path'='pki/trusted'
- 'ssl.trust-store-pwd'='root'
-)
-```
-
## Reference: Notes
The IoTDB configuration file (iotdb-system.properties) can be modified in
order to adjust the parameters for data synchronisation, such as the
synchronisation data storage directory. The complete configuration is as
follows:
@@ -342,12 +266,6 @@ V1.3.0+:
# The maximum number of clients that can be used in the async connector.
# pipe_async_connector_max_client_number=16
-# Whether to enable receiving pipe data through air gap.
-# The receiver can only return 0 or 1 in tcp mode to indicate whether the data
is received successfully.
-# pipe_air_gap_receiver_enabled=false
-
-# The port for the server to receive pipe data through air gap.
-# pipe_air_gap_receiver_port=9780
```
V1.3.1+:
@@ -372,12 +290,6 @@ V1.3.1+:
# The connection timeout (in milliseconds) for the thrift client.
# pipe_sink_timeout_ms=900000
-# Whether to enable receiving pipe data through air gap.
-# The receiver can only return 0 or 1 in tcp mode to indicate whether the data
is received successfully.
-# pipe_air_gap_receiver_enabled=false
-
-# The port for the server to receive pipe data through air gap.
-# pipe_air_gap_receiver_port=9780
```
## Reference: parameter description
@@ -412,7 +324,6 @@ with sink (
| start-time(V1.3.1+) | Synchronise the start event time of all
data, including start-time | Long: [Long.MIN_VALUE, Long.MAX_VALUE] |
optional | Long.MIN_VALUE |
| end-time(V1.3.1+) | end event time for synchronised all data,
contains end-time | Long: [Long.MIN_VALUE, Long.MAX_VALUE] |
optional | Long.MAX_VALUE |
| source.realtime.mode | Extraction mode for real-time data
| String: hybrid, stream, batch |
optional | hybrid |
-| source.forwarding-pipe-requests | Whether to forward data written by another
Pipe (usually Data Sync) | Boolean: true, false |
optional | true |
> 💎 **Note: Difference between historical and real-time data**
>
@@ -440,27 +351,3 @@ with sink (
| sink.batch.enable | Whether to enable the log saving wholesale
delivery mode, which is used to improve transmission throughput and reduce IOPS
| Boolean: true, false
| Optional | true
|
| sink.batch.max-delay-seconds | Effective when the log save and send mode is
turned on, indicates the longest time a batch of data waits before being sent
(unit: s) | Integer
| Optional | 1
|
| sink.batch.size-bytes | Effective when log saving and delivery mode
is enabled, indicates the maximum saving size of a batch of data (unit: byte)
| Long
| Optional |
|
-
-#### iotdb-air-gap-sink
-
-| key | value
| value range
| required or not | default value
|
-|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------|----------------------------------|
-| sink | iotdb-air-gap-sink
| String: iotdb-air-gap-sink
| required |
|
-| sink.ip | Data service IP of a DataNode in the
target IoTDB
| String
| Optional | Fill in either
sink.node-urls |
-| sink.port | Data service port of a DataNode in the
target IoTDB
| Integer
| Optional | Fill in either sink.node-urls
|
-| sink.node-urls | URL of the data service port of any
multiple DataNodes on the target
| String.Example:
'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | Optional
| Fill in either sink.ip:sink.port |
-| sink.air-gap.handshake-timeout-ms | The timeout length of the handshake
request when the sender and the receiver try to establish a connection for the
first time, unit: milliseconds | Integer
| Optional | 5000
|
-
-#### iotdb-thrift-ssl-sink(V1.3.1+)
-
-| key | value
| value range
| required or not | default value
|
-|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|-----------------|----------------------------------|
-| sink | iotdb-thrift-sink or iotdb-thrift-async-sink
| String: iotdb-thrift-sink or
iotdb-thrift-sync-sink | required |
|
-| sink.ip | Data service IP of a DataNode in the target
IoTDB (note that the synchronisation task does not support forwarding to its
own service) | String
| Optional | Fill in
either sink.node-urls |
-| sink.port | Data service port of a DataNode in the target
IoTDB (note that the synchronisation task does not support forwarding to its
own service) | Integer
| Optional | Fill in either
sink.node-urls |
-| sink.node-urls | The url of the data service port of any
number of DataNodes on the target IoTDB (note that the synchronisation task
does not support forwarding to its own service) | String. Example:
'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | Optional
| Fill in either sink.ip:sink.port |
-| sink.batch.enable | Whether to enable the log saving wholesale
delivery mode, which is used to improve transmission throughput and reduce IOPS
| Boolean: true, false
| Optional | true
|
-| sink.batch.max-delay-seconds | Effective when the log save and send mode is
turned on, indicates the longest time a batch of data waits before being sent
(unit: s) | Integer
| Optional | 1
|
-| sink.batch.size-bytes | Effective when log saving and delivery mode
is enabled, indicates the maximum saving size of a batch of data (unit: byte)
| Long
| Optional |
|
-| ssl.trust-store-path | The certificate trust store path to connect
to the target DataNodes
| String.Example:
'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | Optional
| Fill in either sink.ip:sink.port |
-| ssl.trust-store-pwd | The certificate trust store password to
connect to the target DataNodes
| Integer
| Optional | 5000
|
\ No newline at end of file
diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
index 0206d87..d6cd295 100644
--- a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
@@ -118,7 +118,7 @@ In order to make the overall architecture more flexible to
match different synch
| Modules | Plugins | Pre-configured Plugins |
Customised Plugins |
|------------------|---------------|---------------------------------------|--------------------|
| Extract (Source) | Source Plugin | iotdb-source |
Not Supported |
-| Send (Sink) | Sink plugin | iotdb-thrift-sink, iotdb-air-gap-sink |
Support |
+| Send (Sink) | Sink plugin | iotdb-thrift-sink| Support |
#### Preconfigured Plugins
@@ -128,8 +128,6 @@ The preset plugins are listed below:
|-----------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| iotdb-source | source plugin | Default source plugin for extracting
IoTDB historical or real-time data
| 1.2.x
|
| iotdb-thrift-sink | sink plugin | Used for data transfer between IoTDB
(v1.2.0 and above) and IoTDB (v1.2.0 and above). Uses the Thrift RPC framework
to transfer data, multi-threaded async non-blocking IO model, high transfer
performance, especially for scenarios where the target is distributed | 1.2.x
|
-| iotdb-air-gap-sink | sink plugin | Used for data synchronization from
IoTDB (v1.2.2+) to IoTDB (v1.2.2+) across unidirectional data gates. Supported
gate models include Nanrui Syskeeper 2000, etc.
| 1.2.2+
|
-| iotdb-thrift-ssl-sink | sink plugin | Used for data synchronization from
IoTDB (v1.3.1+) to IoTDB (v1.2.0+). Uses the Thrift RPC framework to transfer
data, single-thread blocking IO model.
| 1.3.1+
|
Detailed parameters for each plugin can be found in the [Parameter
Description](#sink-parameters) section of this document.
@@ -150,10 +148,8 @@ IoTDB> show pipeplugins
+------------------------------+--------------------------------------------------------------------------------------------+---------+
| DO-NOTHING-PROCESSOR| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.processor.DoNothingProcessor|
|
| DO-NOTHING-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.DoNothingSink| |
-| IOTDB-AIR-GAP-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.IoTDBAirGapSink| |
| IOTDB-SOURCE| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.source.IoTDBSOURCE| |
| IOTDB-THRIFT-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.IoTDBThriftSink| |
-|IOTDB-THRIFT-SSL-SINK(V1.3.1+)|
Builtin|org.apache.iotdb.commons.pipe.plugin.builtin.sink.iotdb.thrift.IoTDBThriftSslSink|
|
+------------------------------+----------+---------------------------------------------------------------------------------+---------+
```
@@ -202,43 +198,6 @@ with SINK (
```
-### Bidirectional data transfer
-
-This example is used to demonstrate a scenario where two IoTDBs are
dual-active with each other, with the data link shown below:
-
-
-
-In this example, in order to avoid an infinite loop of data, the parameter
`'source.forwarding-pipe-requests` needs to be set to ``false`` on both A and B
to indicate that the data transferred from the other pipe will not be
forwarded. Also set `'source.history.enable'` to `false` to indicate that
historical data is not transferred, i.e., data prior to the creation of the
task is not synchronised.
-
-The detailed statement is as follows:
-
-Execute the following statements on A IoTDB:
-
-```Go
-create pipe AB
-with source (
- 'source.forwarding-pipe-requests' = 'false',
-with sink (
- 'sink'='iotdb-thrift-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6668'
-)
-```
-
-Execute the following statements on B IoTDB:
-
-```Go
-create pipe BA
-with source (
- 'source.forwarding-pipe-requests' = 'false',
-with sink (
- 'sink'='iotdb-thrift-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6667'
-)
-```
-
-
### Cascading Data Transfer
@@ -272,41 +231,6 @@ with sink (
)
```
-### Transmission of data through an air gap
-
-This example is used to demonstrate a scenario where data from one IoTDB is
synchronised to another IoTDB via a unidirectional gate, with the data link
shown below:
-
-
-
-In this example, you need to use the iotdb-air-gap-sink plugin in the sink
task (currently supports some models of network gates, please contact the staff
of Timecho Technology to confirm the specific model), and after configuring the
network gate, execute the following statements on IoTDB A, where ip and port
fill in the information of the network gate, and the detailed statements are as
follows:
-
-```Go
-create pipe A2B
-with sink (
- 'sink'='iotdb-air-gap-sink',
- 'sink.ip'='10.53.53.53',
- 'sink.port'='9780'
-)
-```
-
-### Transfer data using SSL protocol
-
-This example demonstrates the scenario of configuring IoTDB one-way data
synchronization using the SSL protocol, with the data link shown in the
following figure:
-
-
-
-In this scenario, it is necessary to use IoTDB's iotdb-thrift-ssl-sink plugin.
We can create a synchronization task called A2B and configure the password and
address of our own certificate. The detailed statement is as follows:
-```Sql
-create pipe A2B
-with sink (
- 'sink'='iotdb-thrift-ssl-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6669',
- 'ssl.trust-store-path'='pki/trusted'
- 'ssl.trust-store-pwd'='root'
-)
-```
-
## Reference: Notes
The IoTDB configuration file (iotdb-system.properties) can be modified in
order to adjust the parameters for data synchronisation, such as the
synchronisation data storage directory. The complete configuration is as
follows:
@@ -342,12 +266,6 @@ V1.3.0+:
# The maximum number of clients that can be used in the async connector.
# pipe_async_connector_max_client_number=16
-# Whether to enable receiving pipe data through air gap.
-# The receiver can only return 0 or 1 in tcp mode to indicate whether the data
is received successfully.
-# pipe_air_gap_receiver_enabled=false
-
-# The port for the server to receive pipe data through air gap.
-# pipe_air_gap_receiver_port=9780
```
V1.3.1+:
@@ -372,12 +290,6 @@ V1.3.1+:
# The connection timeout (in milliseconds) for the thrift client.
# pipe_sink_timeout_ms=900000
-# Whether to enable receiving pipe data through air gap.
-# The receiver can only return 0 or 1 in tcp mode to indicate whether the data
is received successfully.
-# pipe_air_gap_receiver_enabled=false
-
-# The port for the server to receive pipe data through air gap.
-# pipe_air_gap_receiver_port=9780
```
## Reference: parameter description
@@ -412,7 +324,6 @@ with sink (
| start-time(V1.3.1+) | Synchronise the start event time of all
data, including start-time | Long: [Long.MIN_VALUE, Long.MAX_VALUE] |
optional | Long.MIN_VALUE |
| end-time(V1.3.1+) | end event time for synchronised all data,
contains end-time | Long: [Long.MIN_VALUE, Long.MAX_VALUE] |
optional | Long.MAX_VALUE |
| source.realtime.mode | Extraction mode for real-time data
| String: hybrid, stream, batch |
optional | hybrid |
-| source.forwarding-pipe-requests | Whether to forward data written by another
Pipe (usually Data Sync) | Boolean: true, false |
optional | true |
> 💎 **Note: Difference between historical and real-time data**
>
@@ -440,27 +351,3 @@ with sink (
| sink.batch.enable | Whether to enable the log saving wholesale
delivery mode, which is used to improve transmission throughput and reduce IOPS
| Boolean: true, false
| Optional | true
|
| sink.batch.max-delay-seconds | Effective when the log save and send mode is
turned on, indicates the longest time a batch of data waits before being sent
(unit: s) | Integer
| Optional | 1
|
| sink.batch.size-bytes | Effective when log saving and delivery mode
is enabled, indicates the maximum saving size of a batch of data (unit: byte)
| Long
| Optional |
|
-
-#### iotdb-air-gap-sink
-
-| key | value
| value range
| required or not | default value
|
-|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------|----------------------------------|
-| sink | iotdb-air-gap-sink
| String: iotdb-air-gap-sink
| required |
|
-| sink.ip | Data service IP of a DataNode in the
target IoTDB
| String
| Optional | Fill in either
sink.node-urls |
-| sink.port | Data service port of a DataNode in the
target IoTDB
| Integer
| Optional | Fill in either sink.node-urls
|
-| sink.node-urls | URL of the data service port of any
multiple DataNodes on the target
| String.Example:
'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | Optional
| Fill in either sink.ip:sink.port |
-| sink.air-gap.handshake-timeout-ms | The timeout length of the handshake
request when the sender and the receiver try to establish a connection for the
first time, unit: milliseconds | Integer
| Optional | 5000
|
-
-#### iotdb-thrift-ssl-sink(V1.3.1+)
-
-| key | value
| value range
| required or not | default value
|
-|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|-----------------|----------------------------------|
-| sink | iotdb-thrift-sink or iotdb-thrift-async-sink
| String: iotdb-thrift-sink or
iotdb-thrift-sync-sink | required |
|
-| sink.ip | Data service IP of a DataNode in the target
IoTDB (note that the synchronisation task does not support forwarding to its
own service) | String
| Optional | Fill in
either sink.node-urls |
-| sink.port | Data service port of a DataNode in the target
IoTDB (note that the synchronisation task does not support forwarding to its
own service) | Integer
| Optional | Fill in either
sink.node-urls |
-| sink.node-urls | The url of the data service port of any
number of DataNodes on the target IoTDB (note that the synchronisation task
does not support forwarding to its own service) | String. Example:
'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | Optional
| Fill in either sink.ip:sink.port |
-| sink.batch.enable | Whether to enable the log saving wholesale
delivery mode, which is used to improve transmission throughput and reduce IOPS
| Boolean: true, false
| Optional | true
|
-| sink.batch.max-delay-seconds | Effective when the log save and send mode is
turned on, indicates the longest time a batch of data waits before being sent
(unit: s) | Integer
| Optional | 1
|
-| sink.batch.size-bytes | Effective when log saving and delivery mode
is enabled, indicates the maximum saving size of a batch of data (unit: byte)
| Long
| Optional |
|
-| ssl.trust-store-path | The certificate trust store path to connect
to the target DataNodes
| String.Example:
'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | Optional
| Fill in either sink.ip:sink.port |
-| ssl.trust-store-pwd | The certificate trust store password to
connect to the target DataNodes
| Integer
| Optional | 5000
|
\ No newline at end of file
diff --git a/src/zh/UserGuide/Master/User-Manual/Data-Sync_apache.md
b/src/zh/UserGuide/Master/User-Manual/Data-Sync_apache.md
index 50dfdd0..9f982e7 100644
--- a/src/zh/UserGuide/Master/User-Manual/Data-Sync_apache.md
+++ b/src/zh/UserGuide/Master/User-Manual/Data-Sync_apache.md
@@ -118,7 +118,7 @@ SHOW PIPE <PipeId>
| 模块 | 插件 | 预置插件 | 自定义插件
|
|----------------|--------------|--------------------------------------|-------|
| 抽取(Source) | Source 插件 | iotdb-source | 不支持
|
-| 发送(Sink) | Sink 插件 | iotdb-thrift-sink、iotdb-air-gap-sink | 支持
|
+| 发送(Sink) | Sink 插件 | iotdb-thrift-sink| 支持 |
#### 预置插件
@@ -128,8 +128,6 @@ SHOW PIPE <PipeId>
|-----------------------|--------------|-----------------------------------------------------------------------------------------------------------------------|-----------|
| iotdb-source | source 插件 | 默认的 source 插件,用于抽取 IoTDB 历史或实时数据
| 1.2.x |
| iotdb-thrift-sink | sink 插件 | 用于 IoTDB(v1.2.0及以上)与
IoTDB(v1.2.0及以上)之间的数据传输。使用 Thrift RPC 框架传输数据,多线程 async non-blocking IO
模型,传输性能高,尤其适用于目标端为分布式时的场景 | 1.2.x |
-| iotdb-air-gap-sink | sink 插件 | 用于 IoTDB(v1.2.2+)向
IoTDB(v1.2.2+)跨单向数据网闸的数据同步。支持的网闸型号包括南瑞 Syskeeper 2000 等
| 1.2.2 及以上 |
-| iotdb-thrift-ssl-sink | sink plugin | 用于 IoTDB(v1.3.1及以上)与
IoTDB(v1.2.0及以上)之间的数据传输。使用 Thrift RPC 框架传输数据,单线程 sync blocking IO
模型,适用于安全需求较高的场景 | 1.3.1 及以上 |
每个插件的详细参数可参考本文[参数说明](#sink-参数)章节。
@@ -150,10 +148,8 @@ IoTDB> show pipeplugins
+------------------------------+--------------------------------------------------------------------------------------------+---------+
| DO-NOTHING-PROCESSOR| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.processor.DoNothingProcessor|
|
| DO-NOTHING-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.DoNothingSink| |
-| IOTDB-AIR-GAP-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.IoTDBAirGapSink| |
| IOTDB-SOURCE| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.source.IoTDBSOURCE| |
| IOTDB-THRIFT-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.IoTDBThriftSink| |
-|IOTDB-THRIFT-SSL-SINK(V1.3.1+)|
Builtin|org.apache.iotdb.commons.pipe.plugin.builtin.sink.iotdb.thrift.IoTDBThriftSslSink|
|
+------------------------------+----------+---------------------------------------------------------------------------------+---------+
```
@@ -202,46 +198,6 @@ with SINK (
)
```
-
-### 双向数据传输
-
-本例子用来演示两个 IoTDB 之间互为双活的场景,数据链路如下图所示:
-
-
-
-在这个例子中,为了避免数据无限循环,需要将 A 和 B 上的参数`source.forwarding-pipe-requests` 均设置为
`false`,表示不转发从另一pipe传输而来的数据。
-
-详细语句如下:
-
-在 A IoTDB 上执行下列语句:
-
-```Go
-create pipe AB
-with source (
- 'source.forwarding-pipe-requests' = 'false'
-)
-with sink (
- 'sink'='iotdb-thrift-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6668'
-)
-```
-
-在 B IoTDB 上执行下列语句:
-
-```Go
-create pipe BA
-with source (
- 'source.forwarding-pipe-requests' = 'false'
-)
-with sink (
- 'sink'='iotdb-thrift-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6667'
-)
-```
-
-
### 级联数据传输
@@ -276,41 +232,6 @@ with sink (
)
```
-### 跨网闸数据传输
-
-本例子用来演示将一个 IoTDB 的数据,经过单向网闸,同步至另一个 IoTDB 的场景,数据链路如下图所示:
-
-
-
-在这个例子中,需要使用 sink 任务中的 iotdb-air-gap-sink
插件(目前支持部分型号网闸,具体型号请联系天谋科技工作人员确认),配置网闸后,在 A IoTDB 上执行下列语句,其中 ip 和 port 填写网闸配置的虚拟
ip 和相关 port,详细语句如下:
-
-```Sql
-create pipe A2B
-with sink (
- 'sink'='iotdb-air-gap-sink',
- 'sink.ip'='10.53.53.53',
- 'sink.port'='9780'
-)
-```
-
-### SSL协议数据传输
-
-本例子演示了使用 SSL 协议配置 IoTDB 单向数据同步的场景,数据链路如下图所示:
-
-
-
-在该场景下,需要使用 IoTDB 的 iotdb-thrift-ssl-sink 插件。我们可以创建一个名为 A2B
的同步任务,并配置自身证书的密码和地址,详细语句如下:
-```Sql
-create pipe A2B
-with sink (
- 'sink'='iotdb-thrift-ssl-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6669',
- 'ssl.trust-store-path'='pki/trusted'
- 'ssl.trust-store-pwd'='root'
-)
-```
-
## 参考:注意事项
可通过修改 IoTDB 配置文件(iotdb-system.properties)以调整数据同步的参数,如同步数据存储目录等。完整配置如下:
@@ -346,12 +267,6 @@ V1.3.0+:
# The maximum number of clients that can be used in the async connector.
# pipe_async_connector_max_client_number=16
-# Whether to enable receiving pipe data through air gap.
-# The receiver can only return 0 or 1 in tcp mode to indicate whether the data
is received successfully.
-# pipe_air_gap_receiver_enabled=false
-
-# The port for the server to receive pipe data through air gap.
-# pipe_air_gap_receiver_port=9780
```
V1.3.1+:
@@ -378,13 +293,6 @@ V1.3.1+:
# The maximum number of clients that can be used in the sink.
# pipe_sink_max_client_number=16
-
-# Whether to enable receiving pipe data through air gap.
-# The receiver can only return 0 or 1 in tcp mode to indicate whether the data
is received successfully.
-# pipe_air_gap_receiver_enabled=false
-
-# The port for the server to receive pipe data through air gap.
-# pipe_air_gap_receiver_port=9780
```
## 参考:参数说明
@@ -418,7 +326,6 @@ with sink (
| start-time(V1.3.1+) | 同步所有数据的开始 event time,包含 start-time | Long:
[Long.MIN_VALUE, Long.MAX_VALUE] | 选填 | Long.MIN_VALUE |
| end-time(V1.3.1+) | 同步所有数据的结束 event time,包含 end-time | Long:
[Long.MIN_VALUE, Long.MAX_VALUE] | 选填 | Long.MAX_VALUE |
| source.realtime.mode | 实时数据的抽取模式 |
String: hybrid, stream, batch | 选填 | hybrid |
-| source.forwarding-pipe-requests | 是否转发由其他 Pipe (通常是数据同步)写入的数据 |
Boolean: true, false | 选填 | true |
> 💎 **说明:历史数据与实时数据的差异**
>
@@ -446,28 +353,4 @@ with sink (
| sink.node-urls | 目标端 IoTDB 任意多个 DataNode 节点的数据服务端口的
url(请注意同步任务不支持向自身服务进行转发) |
String。例:'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | 选填
| 与 sink.ip:sink.port 任选其一填写 |
| sink.batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true, false
| 选填 | true |
| sink.batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1 |
-| sink.batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 | |
-
-#### iotdb-air-gap-sink
-
-| key | value |
value 取值范围 |
是否必填 | 默认取值 |
-|-----------------------------------|----------------------------------------|---------------------------------------------------------------------------|------|----------------------------|
-| sink | iotdb-air-gap-sink |
String: iotdb-air-gap-sink | 必填
| |
-| sink.ip | 目标端 IoTDB 其中一个 DataNode 节点的数据服务 ip |
String | 选填
| 与 sink.node-urls 任选其一填写 |
-| sink.port | 目标端 IoTDB 其中一个 DataNode 节点的数据服务 port |
Integer | 选填
| 与 sink.node-urls 任选其一填写 |
-| sink.node-urls | 目标端 IoTDB 任意多个 DataNode 节点的数据服务端口的 url |
String。例:'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | 选填
| 与 sink.ip:sink.port 任选其一填写 |
-| sink.air-gap.handshake-timeout-ms | 发送端与接收端在首次尝试建立连接时握手请求的超时时长,单位:毫秒 |
Integer | 选填
| 5000 |
-
-#### iotdb-thrift-ssl-sink(V1.3.1+)
-
-| key | value
| value range
| required or not | default value |
-|------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------|----------------------------------|
-| sink | iotdb-thrift-ssl-sink
| String: iotdb-thrift-ssl-sink
| 必填 | |
-| sink.ip | 目标端 IoTDB 其中一个 DataNode 节点的数据服务
ip(请注意同步任务不支持向自身服务进行转发) | String
| 选填 | 与 sink.node-urls 任选其一填写
|
-| sink.port | 目标端 IoTDB 其中一个 DataNode 节点的数据服务
port(请注意同步任务不支持向自身服务进行转发) | Integer
| 选填 | 与 sink.node-urls 任选其一填写
|
-| sink.node-urls | 目标端 IoTDB 任意多个 DataNode 节点的数据服务端口的
url(请注意同步任务不支持向自身服务进行转发) |
String。例:'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667'
| 选填 | 与 sink.ip:sink.port 任选其一填写 |
-| sink.batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true, false
| 选填 | true |
-| sink.batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1 |
-| sink.batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 | |
-| 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' | Optional | Fill in either sink.ip:sink.port |
-| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer
| Optional | 5000 |
\ No newline at end of file
+| sink.batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 | |
\ No newline at end of file
diff --git a/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md
b/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md
index 50dfdd0..9f982e7 100644
--- a/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md
+++ b/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md
@@ -118,7 +118,7 @@ SHOW PIPE <PipeId>
| 模块 | 插件 | 预置插件 | 自定义插件
|
|----------------|--------------|--------------------------------------|-------|
| 抽取(Source) | Source 插件 | iotdb-source | 不支持
|
-| 发送(Sink) | Sink 插件 | iotdb-thrift-sink、iotdb-air-gap-sink | 支持
|
+| 发送(Sink) | Sink 插件 | iotdb-thrift-sink| 支持 |
#### 预置插件
@@ -128,8 +128,6 @@ SHOW PIPE <PipeId>
|-----------------------|--------------|-----------------------------------------------------------------------------------------------------------------------|-----------|
| iotdb-source | source 插件 | 默认的 source 插件,用于抽取 IoTDB 历史或实时数据
| 1.2.x |
| iotdb-thrift-sink | sink 插件 | 用于 IoTDB(v1.2.0及以上)与
IoTDB(v1.2.0及以上)之间的数据传输。使用 Thrift RPC 框架传输数据,多线程 async non-blocking IO
模型,传输性能高,尤其适用于目标端为分布式时的场景 | 1.2.x |
-| iotdb-air-gap-sink | sink 插件 | 用于 IoTDB(v1.2.2+)向
IoTDB(v1.2.2+)跨单向数据网闸的数据同步。支持的网闸型号包括南瑞 Syskeeper 2000 等
| 1.2.2 及以上 |
-| iotdb-thrift-ssl-sink | sink plugin | 用于 IoTDB(v1.3.1及以上)与
IoTDB(v1.2.0及以上)之间的数据传输。使用 Thrift RPC 框架传输数据,单线程 sync blocking IO
模型,适用于安全需求较高的场景 | 1.3.1 及以上 |
每个插件的详细参数可参考本文[参数说明](#sink-参数)章节。
@@ -150,10 +148,8 @@ IoTDB> show pipeplugins
+------------------------------+--------------------------------------------------------------------------------------------+---------+
| DO-NOTHING-PROCESSOR| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.processor.DoNothingProcessor|
|
| DO-NOTHING-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.DoNothingSink| |
-| IOTDB-AIR-GAP-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.IoTDBAirGapSink| |
| IOTDB-SOURCE| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.source.IoTDBSOURCE| |
| IOTDB-THRIFT-SINK| Builtin|
org.apache.iotdb.commons.pipe.plugin.builtin.sink.IoTDBThriftSink| |
-|IOTDB-THRIFT-SSL-SINK(V1.3.1+)|
Builtin|org.apache.iotdb.commons.pipe.plugin.builtin.sink.iotdb.thrift.IoTDBThriftSslSink|
|
+------------------------------+----------+---------------------------------------------------------------------------------+---------+
```
@@ -202,46 +198,6 @@ with SINK (
)
```
-
-### 双向数据传输
-
-本例子用来演示两个 IoTDB 之间互为双活的场景,数据链路如下图所示:
-
-
-
-在这个例子中,为了避免数据无限循环,需要将 A 和 B 上的参数`source.forwarding-pipe-requests` 均设置为
`false`,表示不转发从另一pipe传输而来的数据。
-
-详细语句如下:
-
-在 A IoTDB 上执行下列语句:
-
-```Go
-create pipe AB
-with source (
- 'source.forwarding-pipe-requests' = 'false'
-)
-with sink (
- 'sink'='iotdb-thrift-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6668'
-)
-```
-
-在 B IoTDB 上执行下列语句:
-
-```Go
-create pipe BA
-with source (
- 'source.forwarding-pipe-requests' = 'false'
-)
-with sink (
- 'sink'='iotdb-thrift-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6667'
-)
-```
-
-
### 级联数据传输
@@ -276,41 +232,6 @@ with sink (
)
```
-### 跨网闸数据传输
-
-本例子用来演示将一个 IoTDB 的数据,经过单向网闸,同步至另一个 IoTDB 的场景,数据链路如下图所示:
-
-
-
-在这个例子中,需要使用 sink 任务中的 iotdb-air-gap-sink
插件(目前支持部分型号网闸,具体型号请联系天谋科技工作人员确认),配置网闸后,在 A IoTDB 上执行下列语句,其中 ip 和 port 填写网闸配置的虚拟
ip 和相关 port,详细语句如下:
-
-```Sql
-create pipe A2B
-with sink (
- 'sink'='iotdb-air-gap-sink',
- 'sink.ip'='10.53.53.53',
- 'sink.port'='9780'
-)
-```
-
-### SSL协议数据传输
-
-本例子演示了使用 SSL 协议配置 IoTDB 单向数据同步的场景,数据链路如下图所示:
-
-
-
-在该场景下,需要使用 IoTDB 的 iotdb-thrift-ssl-sink 插件。我们可以创建一个名为 A2B
的同步任务,并配置自身证书的密码和地址,详细语句如下:
-```Sql
-create pipe A2B
-with sink (
- 'sink'='iotdb-thrift-ssl-sink',
- 'sink.ip'='127.0.0.1',
- 'sink.port'='6669',
- 'ssl.trust-store-path'='pki/trusted'
- 'ssl.trust-store-pwd'='root'
-)
-```
-
## 参考:注意事项
可通过修改 IoTDB 配置文件(iotdb-system.properties)以调整数据同步的参数,如同步数据存储目录等。完整配置如下:
@@ -346,12 +267,6 @@ V1.3.0+:
# The maximum number of clients that can be used in the async connector.
# pipe_async_connector_max_client_number=16
-# Whether to enable receiving pipe data through air gap.
-# The receiver can only return 0 or 1 in tcp mode to indicate whether the data
is received successfully.
-# pipe_air_gap_receiver_enabled=false
-
-# The port for the server to receive pipe data through air gap.
-# pipe_air_gap_receiver_port=9780
```
V1.3.1+:
@@ -378,13 +293,6 @@ V1.3.1+:
# The maximum number of clients that can be used in the sink.
# pipe_sink_max_client_number=16
-
-# Whether to enable receiving pipe data through air gap.
-# The receiver can only return 0 or 1 in tcp mode to indicate whether the data
is received successfully.
-# pipe_air_gap_receiver_enabled=false
-
-# The port for the server to receive pipe data through air gap.
-# pipe_air_gap_receiver_port=9780
```
## 参考:参数说明
@@ -418,7 +326,6 @@ with sink (
| start-time(V1.3.1+) | 同步所有数据的开始 event time,包含 start-time | Long:
[Long.MIN_VALUE, Long.MAX_VALUE] | 选填 | Long.MIN_VALUE |
| end-time(V1.3.1+) | 同步所有数据的结束 event time,包含 end-time | Long:
[Long.MIN_VALUE, Long.MAX_VALUE] | 选填 | Long.MAX_VALUE |
| source.realtime.mode | 实时数据的抽取模式 |
String: hybrid, stream, batch | 选填 | hybrid |
-| source.forwarding-pipe-requests | 是否转发由其他 Pipe (通常是数据同步)写入的数据 |
Boolean: true, false | 选填 | true |
> 💎 **说明:历史数据与实时数据的差异**
>
@@ -446,28 +353,4 @@ with sink (
| sink.node-urls | 目标端 IoTDB 任意多个 DataNode 节点的数据服务端口的
url(请注意同步任务不支持向自身服务进行转发) |
String。例:'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | 选填
| 与 sink.ip:sink.port 任选其一填写 |
| sink.batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true, false
| 选填 | true |
| sink.batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1 |
-| sink.batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 | |
-
-#### iotdb-air-gap-sink
-
-| key | value |
value 取值范围 |
是否必填 | 默认取值 |
-|-----------------------------------|----------------------------------------|---------------------------------------------------------------------------|------|----------------------------|
-| sink | iotdb-air-gap-sink |
String: iotdb-air-gap-sink | 必填
| |
-| sink.ip | 目标端 IoTDB 其中一个 DataNode 节点的数据服务 ip |
String | 选填
| 与 sink.node-urls 任选其一填写 |
-| sink.port | 目标端 IoTDB 其中一个 DataNode 节点的数据服务 port |
Integer | 选填
| 与 sink.node-urls 任选其一填写 |
-| sink.node-urls | 目标端 IoTDB 任意多个 DataNode 节点的数据服务端口的 url |
String。例:'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667' | 选填
| 与 sink.ip:sink.port 任选其一填写 |
-| sink.air-gap.handshake-timeout-ms | 发送端与接收端在首次尝试建立连接时握手请求的超时时长,单位:毫秒 |
Integer | 选填
| 5000 |
-
-#### iotdb-thrift-ssl-sink(V1.3.1+)
-
-| key | value
| value range
| required or not | default value |
-|------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------|----------------------------------|
-| sink | iotdb-thrift-ssl-sink
| String: iotdb-thrift-ssl-sink
| 必填 | |
-| sink.ip | 目标端 IoTDB 其中一个 DataNode 节点的数据服务
ip(请注意同步任务不支持向自身服务进行转发) | String
| 选填 | 与 sink.node-urls 任选其一填写
|
-| sink.port | 目标端 IoTDB 其中一个 DataNode 节点的数据服务
port(请注意同步任务不支持向自身服务进行转发) | Integer
| 选填 | 与 sink.node-urls 任选其一填写
|
-| sink.node-urls | 目标端 IoTDB 任意多个 DataNode 节点的数据服务端口的
url(请注意同步任务不支持向自身服务进行转发) |
String。例:'127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667'
| 选填 | 与 sink.ip:sink.port 任选其一填写 |
-| sink.batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true, false
| 选填 | true |
-| sink.batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1 |
-| sink.batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 | |
-| 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' | Optional | Fill in either sink.ip:sink.port |
-| ssl.trust-store-pwd | 连接目标端 DataNode 所需的 trust store 证书密码
| Integer
| Optional | 5000 |
\ No newline at end of file
+| sink.batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 | |
\ No newline at end of file