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 76a6be41 add sink format tsfile in table data sync (#667)
76a6be41 is described below
commit 76a6be4139c7b6a88c569d1a99f740eac3c2e1d8
Author: leto-b <[email protected]>
AuthorDate: Fri Mar 28 11:50:09 2025 +0800
add sink format tsfile in table data sync (#667)
---
.../Master/Table/User-Manual/Data-Sync_apache.md | 4 +-
.../Master/Table/User-Manual/Data-Sync_timecho.md | 54 ++++++++++----------
.../latest-Table/User-Manual/Data-Sync_apache.md | 4 +-
.../latest-Table/User-Manual/Data-Sync_timecho.md | 54 ++++++++++----------
.../Master/Table/User-Manual/Data-Sync_apache.md | 55 +++++++++++----------
.../Master/Table/User-Manual/Data-Sync_timecho.md | 57 ++++++++++++----------
.../latest-Table/User-Manual/Data-Sync_apache.md | 54 ++++++++++----------
.../latest-Table/User-Manual/Data-Sync_timecho.md | 57 ++++++++++++----------
8 files changed, 179 insertions(+), 160 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 1d2f5096..7c2a3f65 100644
--- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
@@ -543,6 +543,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request. | String: snappy / gzip / lz4 / zstd / lzma2 | No
| "" |
| 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 |
+| format | The payload formats for data transmission
include the following options:<br> - hybrid: The format depends on what is
passed from the processor (either tsfile or tablet), and the sink performs no
conversion.<br> - tsfile: Data is forcibly converted to tsfile format before
transmission. This is suitable for scenarios like data file backup.<br> -
tablet: Data is forcibly converted to tsfile format before transmission. This
is useful for data synchronization [...]
#### iotdb-thrift-ssl-sink
@@ -560,4 +561,5 @@ 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 | - |
+| format | The payload formats for data transmission
include the following options:<br> - hybrid: The format depends on what is
passed from the processor (either tsfile or tablet), and the sink performs no
conversion.<br> - tsfile: Data is forcibly converted to tsfile format before
transmission. This is suitable for scenarios like data file backup.<br> -
tablet: Data is forcibly converted to tsfile format before transmission. This
is useful for data synchronization [...]
\ No newline at end of file
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 4a7a6ff1..cb83f253 100644
--- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
@@ -566,18 +566,19 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-sink
-| **Parameter** | **Description**
| Value Range |
Required | Default Value |
-| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
-| sink | iotdb-thrift-sink or iotdb-thrift-async-sink
| String: iotdb-thrift-sink or iotdb-thrift-async-sink |
Yes | - |
+| **Parameter** | **Description**
| Value Range
| Required | Default Value |
+| :-------------------------- |
:-----------------------------------------------------------
|:---------------------------------------------------------------------------------|
:------- | :------------ |
+| sink | iotdb-thrift-sink or iotdb-thrift-async-sink
| String: iotdb-thrift-sink or iotdb-thrift-async-sink
| Yes | - |
| node-urls | URLs of the DataNode service ports on the
target IoTDB. (please note that the synchronization 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' | Yes
| - |
-| user/usename | Usename for connecting to the target IoTDB.
Must have appropriate permissions. | String
| No | root |
-| password | Password for the username.
| String |
No | root |
-| batch.enable | Enables batch mode for log transmission to
improve throughput and reduce IOPS. | Boolean: true, false
| No | true |
-| batch.max-delay-seconds | Maximum delay (in seconds) for batch
transmission. | Integer
| No | 1 |
-| batch.size-bytes | Maximum batch size (in bytes) for batch
transmission. | Long
| No | 16*1024*1024 |
-| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request. | String: snappy / gzip / lz4 / zstd / lzma2 | No
| "" |
-| 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 |
+| user/usename | Usename for connecting to the target IoTDB.
Must have appropriate permissions. | String
| No | root |
+| password | Password for the username.
| String
| No | root |
+| batch.enable | Enables batch mode for log transmission to
improve throughput and reduce IOPS. | Boolean: true, false
| No | true |
+| batch.max-delay-seconds | Maximum delay (in seconds) for batch
transmission. | Integer
| No | 1 |
+| batch.size-bytes | Maximum batch size (in bytes) for batch
transmission. | Long
| No | 16*1024*1024 |
+| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request. | String: snappy / gzip / lz4 / zstd / lzma2
| No | "" |
+| 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 |
+| format | The payload formats for data transmission
include the following options:<br> - hybrid: The format depends on what is
passed from the processor (either tsfile or tablet), and the sink performs no
conversion.<br> - tsfile: Data is forcibly converted to tsfile format before
transmission. This is suitable for scenarios like data file backup.<br> -
tablet: Data is forcibly converted to tsfile format before transmission. This
is useful for data synchronization [...]
#### iotdb-air-gap-sink
@@ -594,20 +595,21 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-ssl-sink
-| **Parameter** | **Description**
| Value Range |
Required | Default Value |
-| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
-| sink | iotdb-thrift-ssl-sink
| String: iotdb-thrift-ssl-sink |
Yes | - |
-| node-urls | URLs of the DataNode service ports on the
target IoTDB. (please note that the synchronization 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' | Yes
| - |
-| user/usename | Usename for connecting to the target IoTDB.
Must have appropriate permissions. | String
| No | root |
-| password | Password for the username.
| String |
No | root |
-| batch.enable | Enables batch mode for log transmission to
improve throughput and reduce IOPS. | Boolean: true, false
| No | true |
-| batch.max-delay-seconds | Maximum delay (in seconds) for batch
transmission. | Integer
| No | 1 |
-| batch.size-bytes | Maximum batch size (in bytes) for batch
transmission. | Long
| No | 16*1024*1024 |
-| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request. | String: snappy / gzip / lz4 / zstd / lzma2 | No
| "" |
-| 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 | - |
+| **Parameter** | **Description**
[...]
+| :--------------------------
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
+| sink | iotdb-thrift-ssl-sink
[...]
+| node-urls | URLs of the DataNode service ports on the
target IoTDB. (please note that the synchronization task does not support
forwarding to its own service).
[...]
+| user/usename | Usename for connecting to the target IoTDB.
Must have appropriate permissions.
[...]
+| password | Password for the username.
[...]
+| batch.enable | Enables batch mode for log transmission to
improve throughput and reduce IOPS.
[...]
+| batch.max-delay-seconds | Maximum delay (in seconds) for batch
transmission.
[...]
+| batch.size-bytes | Maximum batch size (in bytes) for batch
transmission.
[...]
+| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request.
[...]
+| 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.
[...]
+| 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.
[...]
+| ssl.trust-store-path | Path to the trust store certificate for SSL
connection.
[...]
+| ssl.trust-store-pwd | Password for the trust store certificate.
[...]
+| format | The payload formats for data transmission
include the following options:<br> - hybrid: The format depends on what is
passed from the processor (either tsfile or tablet), and the sink performs no
conversion.<br> - tsfile: Data is forcibly converted to tsfile format before
transmission. This is suitable for scenarios like data file backup.<br> -
tablet: Data is forcibly converted to tsfile format before transmission. This
is useful for data synchronization [...]
#### write-back-sink
@@ -627,4 +629,4 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| 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
+| 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"
|
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 1d2f5096..7c2a3f65 100644
--- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
@@ -543,6 +543,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request. | String: snappy / gzip / lz4 / zstd / lzma2 | No
| "" |
| 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 |
+| format | The payload formats for data transmission
include the following options:<br> - hybrid: The format depends on what is
passed from the processor (either tsfile or tablet), and the sink performs no
conversion.<br> - tsfile: Data is forcibly converted to tsfile format before
transmission. This is suitable for scenarios like data file backup.<br> -
tablet: Data is forcibly converted to tsfile format before transmission. This
is useful for data synchronization [...]
#### iotdb-thrift-ssl-sink
@@ -560,4 +561,5 @@ 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 | - |
+| format | The payload formats for data transmission
include the following options:<br> - hybrid: The format depends on what is
passed from the processor (either tsfile or tablet), and the sink performs no
conversion.<br> - tsfile: Data is forcibly converted to tsfile format before
transmission. This is suitable for scenarios like data file backup.<br> -
tablet: Data is forcibly converted to tsfile format before transmission. This
is useful for data synchronization [...]
\ No newline at end of file
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 4a7a6ff1..cb83f253 100644
--- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
@@ -566,18 +566,19 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-sink
-| **Parameter** | **Description**
| Value Range |
Required | Default Value |
-| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
-| sink | iotdb-thrift-sink or iotdb-thrift-async-sink
| String: iotdb-thrift-sink or iotdb-thrift-async-sink |
Yes | - |
+| **Parameter** | **Description**
| Value Range
| Required | Default Value |
+| :-------------------------- |
:-----------------------------------------------------------
|:---------------------------------------------------------------------------------|
:------- | :------------ |
+| sink | iotdb-thrift-sink or iotdb-thrift-async-sink
| String: iotdb-thrift-sink or iotdb-thrift-async-sink
| Yes | - |
| node-urls | URLs of the DataNode service ports on the
target IoTDB. (please note that the synchronization 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' | Yes
| - |
-| user/usename | Usename for connecting to the target IoTDB.
Must have appropriate permissions. | String
| No | root |
-| password | Password for the username.
| String |
No | root |
-| batch.enable | Enables batch mode for log transmission to
improve throughput and reduce IOPS. | Boolean: true, false
| No | true |
-| batch.max-delay-seconds | Maximum delay (in seconds) for batch
transmission. | Integer
| No | 1 |
-| batch.size-bytes | Maximum batch size (in bytes) for batch
transmission. | Long
| No | 16*1024*1024 |
-| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request. | String: snappy / gzip / lz4 / zstd / lzma2 | No
| "" |
-| 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 |
+| user/usename | Usename for connecting to the target IoTDB.
Must have appropriate permissions. | String
| No | root |
+| password | Password for the username.
| String
| No | root |
+| batch.enable | Enables batch mode for log transmission to
improve throughput and reduce IOPS. | Boolean: true, false
| No | true |
+| batch.max-delay-seconds | Maximum delay (in seconds) for batch
transmission. | Integer
| No | 1 |
+| batch.size-bytes | Maximum batch size (in bytes) for batch
transmission. | Long
| No | 16*1024*1024 |
+| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request. | String: snappy / gzip / lz4 / zstd / lzma2
| No | "" |
+| 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 |
+| format | The payload formats for data transmission
include the following options:<br> - hybrid: The format depends on what is
passed from the processor (either tsfile or tablet), and the sink performs no
conversion.<br> - tsfile: Data is forcibly converted to tsfile format before
transmission. This is suitable for scenarios like data file backup.<br> -
tablet: Data is forcibly converted to tsfile format before transmission. This
is useful for data synchronization [...]
#### iotdb-air-gap-sink
@@ -594,20 +595,21 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-ssl-sink
-| **Parameter** | **Description**
| Value Range |
Required | Default Value |
-| :-------------------------- |
:----------------------------------------------------------- |
:----------------------------------------------------------- | :------- |
:------------ |
-| sink | iotdb-thrift-ssl-sink
| String: iotdb-thrift-ssl-sink |
Yes | - |
-| node-urls | URLs of the DataNode service ports on the
target IoTDB. (please note that the synchronization 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' | Yes
| - |
-| user/usename | Usename for connecting to the target IoTDB.
Must have appropriate permissions. | String
| No | root |
-| password | Password for the username.
| String |
No | root |
-| batch.enable | Enables batch mode for log transmission to
improve throughput and reduce IOPS. | Boolean: true, false
| No | true |
-| batch.max-delay-seconds | Maximum delay (in seconds) for batch
transmission. | Integer
| No | 1 |
-| batch.size-bytes | Maximum batch size (in bytes) for batch
transmission. | Long
| No | 16*1024*1024 |
-| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request. | String: snappy / gzip / lz4 / zstd / lzma2 | No
| "" |
-| 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 | - |
+| **Parameter** | **Description**
[...]
+| :--------------------------
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
+| sink | iotdb-thrift-ssl-sink
[...]
+| node-urls | URLs of the DataNode service ports on the
target IoTDB. (please note that the synchronization task does not support
forwarding to its own service).
[...]
+| user/usename | Usename for connecting to the target IoTDB.
Must have appropriate permissions.
[...]
+| password | Password for the username.
[...]
+| batch.enable | Enables batch mode for log transmission to
improve throughput and reduce IOPS.
[...]
+| batch.max-delay-seconds | Maximum delay (in seconds) for batch
transmission.
[...]
+| batch.size-bytes | Maximum batch size (in bytes) for batch
transmission.
[...]
+| compressor | The selected RPC compression algorithm.
Multiple algorithms can be configured and will be adopted in sequence for each
request.
[...]
+| 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.
[...]
+| 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.
[...]
+| ssl.trust-store-path | Path to the trust store certificate for SSL
connection.
[...]
+| ssl.trust-store-pwd | Password for the trust store certificate.
[...]
+| format | The payload formats for data transmission
include the following options:<br> - hybrid: The format depends on what is
passed from the processor (either tsfile or tablet), and the sink performs no
conversion.<br> - tsfile: Data is forcibly converted to tsfile format before
transmission. This is suitable for scenarios like data file backup.<br> -
tablet: Data is forcibly converted to tsfile format before transmission. This
is useful for data synchronization [...]
#### write-back-sink
@@ -627,4 +629,4 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| 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
+| 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"
|
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 deb843ee..30a70ce0 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
@@ -522,33 +522,36 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-sink
-| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
-| --------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
------------ |
-| sink | iotdb-thrift-sink 或 iotdb-thrift-async-sink
| String: iotdb-thrift-sink 或 iotdb-thrift-async-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' | 必填 | -
|
-| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS |
Boolean: true, false | 选填 | true
|
-| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s) |
Integer | 选填 | 1
|
-| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte) | Long
| 选填 | 16*1024*1024 |
-| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用 | String:
snappy / gzip / lz4 / zstd / lzma2 | 选填 | "" |
-| 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
|
+| **参数** | **描述**
| **value 取值范围**
| **是否必填** |
**默认取值** |
+|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|----------|--------------|
+| sink | iotdb-thrift-sink 或 iotdb-thrift-async-sink
| String:
iotdb-thrift-sink 或 iotdb-thrift-async-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' | 必填
| - |
+| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限
| String
| 选填 | root
|
+| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限
| String
| 选填 | root
|
+| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true,
false | 选填 | true
|
+| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1
|
+| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 |
16*1024*1024 |
+| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用
| String: snappy
/ gzip / lz4 / zstd / lzma2 | 选填 | ""
|
+| 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 |
+| format | 数据传输的payload格式, 可选项包括:<br> - hybrid: 取决于
processor 传递过来的格式(tsfile或tablet),sink不做任何转换。<br> -
tsfile:强制转换成tsfile发送,可用于数据文件备份等场景。<br> -
tablet:强制转换成tsfile发送,可用于发送端/接收端数据类型不完全兼容时的数据同步(以减少报错)。 | String: hybrid /
tsfile / tablet | 选填 | hybrid |
#### iotdb-thrift-ssl-sink
-| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
-| --------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
------------ |
-| sink | iotdb-thrift-ssl-sink
| String: iotdb-thrift-ssl-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' | 必填 | -
|
-| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS |
Boolean: true, false | 选填 | true
|
-| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s) |
Integer | 选填 | 1
|
-| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte) | Long
| 选填 | 16*1024*1024 |
-| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用 | String:
snappy / gzip / lz4 / zstd / lzma2 | 选填 | "" |
-| 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 | 必填 | -
|
+| **参数** | **描述**
| **value 取值范围**
| **是否必填** |
**默认取值** |
+| ---------------------------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
-------- | ------------ |
+| sink | iotdb-thrift-ssl-sink
| String:
iotdb-thrift-ssl-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'
| 必填 | - |
+| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限
| String
| 选填 |
root |
+| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限
| String
| 选填 |
root |
+| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true,
false | 选填 |
true |
+| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1
|
+| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 |
16*1024*1024 |
+| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用
| String: snappy
/ gzip / lz4 / zstd / lzma2 | 选填 | ""
|
+| 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
| 必填 | -
|
+| format | 数据传输的payload格式, 可选项包括:<br> - hybrid: 取决于
processor 传递过来的格式(tsfile或tablet),sink不做任何转换。<br> -
tsfile:强制转换成tsfile发送,可用于数据文件备份等场景。<br> -
tablet:强制转换成tsfile发送,可用于发送端/接收端数据类型不完全兼容时的数据同步(以减少报错)。 | String: hybrid /
tsfile / tablet | 选填 | hybrid |
+
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 58e05842..659aba8f 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
@@ -573,18 +573,19 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-sink
-| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
-| --------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
------------ |
-| sink | iotdb-thrift-sink 或 iotdb-thrift-async-sink
| String: iotdb-thrift-sink 或 iotdb-thrift-async-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' | 必填 | -
|
-| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS |
Boolean: true, false | 选填 | true
|
-| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s) |
Integer | 选填 | 1
|
-| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte) | Long
| 选填 | 16*1024*1024 |
-| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用 | String:
snappy / gzip / lz4 / zstd / lzma2 | 选填 | "" |
-| 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
|
+| **参数** | **描述**
| **value 取值范围**
| **是否必填** | **默认取值**
|
+| ---------------------------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|
-------- | ------------ |
+| sink | iotdb-thrift-sink 或 iotdb-thrift-async-sink
| String:
iotdb-thrift-sink 或 iotdb-thrift-async-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' | 必填
| - |
+| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限
| String
| 选填 | root
|
+| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限
| String
| 选填 | root
|
+| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true,
false | 选填 | true
|
+| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1
|
+| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 |
16*1024*1024 |
+| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用
| String: snappy
/ gzip / lz4 / zstd / lzma2 | 选填 | ""
|
+| 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
|
+| format | 数据传输的payload格式, 可选项包括:<br> - hybrid: 取决于
processor 传递过来的格式(tsfile或tablet),sink不做任何转换。<br> -
tsfile:强制转换成tsfile发送,可用于数据文件备份等场景。<br> -
tablet:强制转换成tsfile发送,可用于发送端/接收端数据类型不完全兼容时的数据同步(以减少报错)。 | String: hybrid /
tsfile / tablet | 选填 | hybrid |
#### iotdb-air-gap-sink
@@ -602,20 +603,21 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-ssl-sink
-| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
-| --------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
------------ |
-| sink | iotdb-thrift-ssl-sink
| String: iotdb-thrift-ssl-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' | 必填 | -
|
-| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS |
Boolean: true, false | 选填 | true
|
-| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s) |
Integer | 选填 | 1
|
-| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte) | Long
| 选填 | 16*1024*1024 |
-| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用 | String:
snappy / gzip / lz4 / zstd / lzma2 | 选填 | "" |
-| 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 | 必填 | -
|
+| **参数** | **描述**
| **value 取值范围**
| **是否必填** |
**默认取值** |
+| ---------------------------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
-------- | ------------ |
+| sink | iotdb-thrift-ssl-sink
| String:
iotdb-thrift-ssl-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'
| 必填 | - |
+| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限
| String
| 选填 |
root |
+| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限
| String
| 选填 |
root |
+| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true,
false | 选填 |
true |
+| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1
|
+| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 |
16*1024*1024 |
+| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用
| String: snappy
/ gzip / lz4 / zstd / lzma2 | 选填 | ""
|
+| 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
| 必填 | -
|
+| format | 数据传输的payload格式, 可选项包括:<br> - hybrid: 取决于
processor 传递过来的格式(tsfile或tablet),sink不做任何转换。<br> -
tsfile:强制转换成tsfile发送,可用于数据文件备份等场景。<br> -
tablet:强制转换成tsfile发送,可用于发送端/接收端数据类型不完全兼容时的数据同步(以减少报错)。 | String: hybrid /
tsfile / tablet | 选填 | hybrid |
#### write-back-sink
@@ -635,4 +637,5 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| 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
+| sink.opcua.placeholder | 当ID列的值出现null时,用于替代null映射路径的占位字符串 |
String | 选填 | "null"
|
+
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 deb843ee..a9232038 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
@@ -522,33 +522,35 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-sink
-| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
-| --------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
------------ |
-| sink | iotdb-thrift-sink 或 iotdb-thrift-async-sink
| String: iotdb-thrift-sink 或 iotdb-thrift-async-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' | 必填 | -
|
-| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS |
Boolean: true, false | 选填 | true
|
-| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s) |
Integer | 选填 | 1
|
-| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte) | Long
| 选填 | 16*1024*1024 |
-| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用 | String:
snappy / gzip / lz4 / zstd / lzma2 | 选填 | "" |
-| 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
|
+| **参数** | **描述**
| **value 取值范围**
| **是否必填** |
**默认取值** |
+|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|----------|--------------|
+| sink | iotdb-thrift-sink 或 iotdb-thrift-async-sink
| String:
iotdb-thrift-sink 或 iotdb-thrift-async-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' | 必填
| - |
+| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限
| String
| 选填 | root
|
+| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限
| String
| 选填 | root
|
+| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true,
false | 选填 | true
|
+| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1
|
+| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 |
16*1024*1024 |
+| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用
| String: snappy
/ gzip / lz4 / zstd / lzma2 | 选填 | ""
|
+| 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 |
+| format | 数据传输的payload格式, 可选项包括:<br> - hybrid: 取决于
processor 传递过来的格式(tsfile或tablet),sink不做任何转换。<br> -
tsfile:强制转换成tsfile发送,可用于数据文件备份等场景。<br> -
tablet:强制转换成tsfile发送,可用于发送端/接收端数据类型不完全兼容时的数据同步(以减少报错)。 | String: hybrid /
tsfile / tablet | 选填 | hybrid |
#### iotdb-thrift-ssl-sink
-| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
-| --------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
------------ |
-| sink | iotdb-thrift-ssl-sink
| String: iotdb-thrift-ssl-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' | 必填 | -
|
-| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS |
Boolean: true, false | 选填 | true
|
-| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s) |
Integer | 选填 | 1
|
-| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte) | Long
| 选填 | 16*1024*1024 |
-| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用 | String:
snappy / gzip / lz4 / zstd / lzma2 | 选填 | "" |
-| 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 | 必填 | -
|
+| **参数** | **描述**
| **value 取值范围**
| **是否必填** |
**默认取值** |
+| ---------------------------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
-------- | ------------ |
+| sink | iotdb-thrift-ssl-sink
| String:
iotdb-thrift-ssl-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'
| 必填 | - |
+| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限
| String
| 选填 |
root |
+| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限
| String
| 选填 |
root |
+| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true,
false | 选填 |
true |
+| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1
|
+| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 |
16*1024*1024 |
+| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用
| String: snappy
/ gzip / lz4 / zstd / lzma2 | 选填 | ""
|
+| 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
| 必填 | -
|
+| format | 数据传输的payload格式, 可选项包括:<br> - hybrid: 取决于
processor 传递过来的格式(tsfile或tablet),sink不做任何转换。<br> -
tsfile:强制转换成tsfile发送,可用于数据文件备份等场景。<br> -
tablet:强制转换成tsfile发送,可用于发送端/接收端数据类型不完全兼容时的数据同步(以减少报错)。 | String: hybrid /
tsfile / tablet | 选填 | hybrid |
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 58e05842..659aba8f 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
@@ -573,18 +573,19 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-sink
-| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
-| --------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
------------ |
-| sink | iotdb-thrift-sink 或 iotdb-thrift-async-sink
| String: iotdb-thrift-sink 或 iotdb-thrift-async-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' | 必填 | -
|
-| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS |
Boolean: true, false | 选填 | true
|
-| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s) |
Integer | 选填 | 1
|
-| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte) | Long
| 选填 | 16*1024*1024 |
-| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用 | String:
snappy / gzip / lz4 / zstd / lzma2 | 选填 | "" |
-| 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
|
+| **参数** | **描述**
| **value 取值范围**
| **是否必填** | **默认取值**
|
+| ---------------------------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|
-------- | ------------ |
+| sink | iotdb-thrift-sink 或 iotdb-thrift-async-sink
| String:
iotdb-thrift-sink 或 iotdb-thrift-async-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' | 必填
| - |
+| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限
| String
| 选填 | root
|
+| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限
| String
| 选填 | root
|
+| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true,
false | 选填 | true
|
+| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1
|
+| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 |
16*1024*1024 |
+| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用
| String: snappy
/ gzip / lz4 / zstd / lzma2 | 选填 | ""
|
+| 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
|
+| format | 数据传输的payload格式, 可选项包括:<br> - hybrid: 取决于
processor 传递过来的格式(tsfile或tablet),sink不做任何转换。<br> -
tsfile:强制转换成tsfile发送,可用于数据文件备份等场景。<br> -
tablet:强制转换成tsfile发送,可用于发送端/接收端数据类型不完全兼容时的数据同步(以减少报错)。 | String: hybrid /
tsfile / tablet | 选填 | hybrid |
#### iotdb-air-gap-sink
@@ -602,20 +603,21 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
#### iotdb-thrift-ssl-sink
-| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
-| --------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
------------ |
-| sink | iotdb-thrift-ssl-sink
| String: iotdb-thrift-ssl-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' | 必填 | -
|
-| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限 | String
| 选填 | root |
-| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS |
Boolean: true, false | 选填 | true
|
-| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s) |
Integer | 选填 | 1
|
-| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte) | Long
| 选填 | 16*1024*1024 |
-| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用 | String:
snappy / gzip / lz4 / zstd / lzma2 | 选填 | "" |
-| 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 | 必填 | -
|
+| **参数** | **描述**
| **value 取值范围**
| **是否必填** |
**默认取值** |
+| ---------------------------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
-------- | ------------ |
+| sink | iotdb-thrift-ssl-sink
| String:
iotdb-thrift-ssl-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'
| 必填 | - |
+| user/usename | 连接接收端使用的用户名,同步要求该用户具备相应的操作权限
| String
| 选填 |
root |
+| password | 连接接收端使用的用户名对应的密码,同步要求该用户具备相应的操作权限
| String
| 选填 |
root |
+| batch.enable | 是否开启日志攒批发送模式,用于提高传输吞吐,降低 IOPS
| Boolean: true,
false | 选填 |
true |
+| batch.max-delay-seconds | 在开启日志攒批发送模式时生效,表示一批数据在发送前的最长等待时间(单位:s)
| Integer
| 选填 | 1
|
+| batch.size-bytes | 在开启日志攒批发送模式时生效,表示一批数据最大的攒批大小(单位:byte)
| Long
| 选填 |
16*1024*1024 |
+| compressor | 所选取的 rpc 压缩算法,可配置多个,对每个请求顺序采用
| String: snappy
/ gzip / lz4 / zstd / lzma2 | 选填 | ""
|
+| 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
| 必填 | -
|
+| format | 数据传输的payload格式, 可选项包括:<br> - hybrid: 取决于
processor 传递过来的格式(tsfile或tablet),sink不做任何转换。<br> -
tsfile:强制转换成tsfile发送,可用于数据文件备份等场景。<br> -
tablet:强制转换成tsfile发送,可用于发送端/接收端数据类型不完全兼容时的数据同步(以减少报错)。 | String: hybrid /
tsfile / tablet | 选填 | hybrid |
#### write-back-sink
@@ -635,4 +637,5 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| 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
+| sink.opcua.placeholder | 当ID列的值出现null时,用于替代null映射路径的占位字符串 |
String | 选填 | "null"
|
+