Skip to content

add sink param batch.max-delay-ms to tree model 13x #930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CritasWang merged 1 commit into from
Dec 26, 2025
+36 −20
Merged

add sink param batch.max-delay-ms to tree model 13x #930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/UserGuide/V1.3.x/User-Manual/Data-Sync_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
> - **batch**: In this mode, tasks process and send data in batches (according to the underlying data files). It is characterized by low timeliness and high throughput.


## sink parameter
### sink parameter

> In versions 1.3.3 and above, when only the sink is included, the additional "with sink" prefix is no longer required.

Expand All @@ -518,6 +518,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| node-urls | The URL of the data service port of any DataNode nodes on the target IoTDB (please note that synchronization tasks do 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' | Required | - |
| batch.enable | Whether to enable batched log transmission mode to improve transmission throughput and reduce IOPS | Boolean: true, false | Optional | true |
| batch.max-delay-seconds | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: s) | Integer | Optional | 1 |
| batch.max-delay-ms | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: ms) (Available since v1.3.6) | Integer | Optional | 1 |
| batch.size-bytes | Effective when batched log transmission mode is enabled, it represents the maximum batch size for a batch of data (unit: byte) | Long | Optional | 16*1024*1024 |

#### iotdb-thrift-ssl-sink
Expand All @@ -528,6 +529,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| node-urls | The URL of the data service port of any DataNode nodes on the target IoTDB (please note that synchronization tasks do 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' | Required | - |
| batch.enable | Whether to enable batched log transmission mode to improve transmission throughput and reduce IOPS | Boolean: true, false | Optional | true |
| batch.max-delay-seconds | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: s) | Integer | Optional | 1 |
| batch.max-delay-ms | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: ms) (Available since v1.3.6) | Integer | Optional | 1 |
| batch.size-bytes | Effective when batched log transmission mode is enabled, it represents the maximum batch size for a batch of data (unit: byte) | Long | Optional | 16*1024*1024 |
| ssl.trust-store-path | The trust store certificate path required to connect to the target DataNode | String: certificate directory name, when configured as a relative directory, it is relative to the IoTDB root directory. Example: '127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667'| Required | - |
| ssl.trust-store-pwd | The trust store certificate password required to connect to the target DataNode | Integer | Required | - |
4 changes: 3 additions & 1 deletion src/UserGuide/V1.3.x/User-Manual/Data-Sync_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -590,7 +590,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
> - **batch**: In this mode, tasks process and send data in batches (according to the underlying data files). It is characterized by low timeliness and high throughput.


## sink parameter
### sink parameter

> In versions 1.3.3 and above, when only the sink is included, the additional "with sink" prefix is no longer required.

Expand All @@ -603,6 +603,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| node-urls | The URL of the data service port of any DataNode nodes on the target IoTDB (please note that synchronization tasks do 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' | Required | - |
| batch.enable | Whether to enable batched log transmission mode to improve transmission throughput and reduce IOPS | Boolean: true, false | Optional | true |
| batch.max-delay-seconds | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: s) | Integer | Optional | 1 |
| batch.max-delay-ms | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: ms) (Available since v1.3.6) | Integer | Optional | 1 |
| batch.size-bytes | Effective when batched log transmission mode is enabled, it represents the maximum batch size for a batch of data (unit: byte) | Long | Optional | 16*1024*1024 |

#### iotdb-air-gap-sink
Expand All @@ -621,6 +622,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| node-urls | The URL of the data service port of any DataNode nodes on the target IoTDB (please note that synchronization tasks do 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' | Required | - |
| batch.enable | Whether to enable batched log transmission mode to improve transmission throughput and reduce IOPS | Boolean: true, false | Optional | true |
| batch.max-delay-seconds | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: s) | Integer | Optional | 1 |
| batch.max-delay-ms | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: ms) (Available since v1.3.6) | Integer | Optional | 1 |
| batch.size-bytes | Effective when batched log transmission mode is enabled, it represents the maximum batch size for a batch of data (unit: byte) | Long | Optional | 16*1024*1024 |
| ssl.trust-store-path | The trust store certificate path required to connect to the target DataNode | String: certificate directory name, when configured as a relative directory, it is relative to the IoTDB root directory. Example: '127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667'| Required | - |
| ssl.trust-store-pwd | The trust store certificate password required to connect to the target DataNode | Integer | Required | - |
18 changes: 10 additions & 8 deletions src/UserGuide/dev-1.3/User-Manual/Data-Sync_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,20 +505,21 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
> - **batch**: In this mode, tasks process and send data in batches (according to the underlying data files). It is characterized by low timeliness and high throughput.


## sink parameter
### sink parameter

> In versions 1.3.3 and above, when only the sink is included, the additional "with sink" prefix is no longer required.

#### iotdb-thrift-sink


| 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-async-sink | Required | |
| node-urls | The URL of the data service port of any DataNode nodes on the target IoTDB (please note that synchronization tasks do 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' | Required | - |
| batch.enable | Whether to enable batched log transmission mode to improve transmission throughput and reduce IOPS | Boolean: true, false | Optional | true |
| batch.max-delay-seconds | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: s) | Integer | Optional | 1 |
| batch.size-bytes | Effective when batched log transmission mode is enabled, it represents the maximum batch size for a batch of data (unit: byte) | Long | Optional | 16*1024*1024 |
| 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-async-sink | Required | |
| node-urls | The URL of the data service port of any DataNode nodes on the target IoTDB (please note that synchronization tasks do 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' | Required | - |
| batch.enable | Whether to enable batched log transmission mode to improve transmission throughput and reduce IOPS | Boolean: true, false | Optional | true |
| batch.max-delay-seconds | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: s) | Integer | Optional | 1 |
| batch.max-delay-ms | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: ms) (Available since v1.3.6) | Integer | Optional | 1 |
| batch.size-bytes | Effective when batched log transmission mode is enabled, it represents the maximum batch size for a batch of data (unit: byte) | Long | Optional | 16*1024*1024 |

#### iotdb-thrift-ssl-sink

Expand All @@ -528,6 +529,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| node-urls | The URL of the data service port of any DataNode nodes on the target IoTDB (please note that synchronization tasks do 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' | Required | - |
| batch.enable | Whether to enable batched log transmission mode to improve transmission throughput and reduce IOPS | Boolean: true, false | Optional | true |
| batch.max-delay-seconds | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: s) | Integer | Optional | 1 |
| batch.max-delay-ms | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: ms) (Available since v1.3.6) | Integer | Optional | 1 |
| batch.size-bytes | Effective when batched log transmission mode is enabled, it represents the maximum batch size for a batch of data (unit: byte) | Long | Optional | 16*1024*1024 |
| ssl.trust-store-path | The trust store certificate path required to connect to the target DataNode | String: certificate directory name, when configured as a relative directory, it is relative to the IoTDB root directory. Example: '127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667'| Required | - |
| ssl.trust-store-pwd | The trust store certificate password required to connect to the target DataNode | Integer | Required | - |
4 changes: 3 additions & 1 deletion src/UserGuide/dev-1.3/User-Manual/Data-Sync_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -590,7 +590,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
> - **batch**: In this mode, tasks process and send data in batches (according to the underlying data files). It is characterized by low timeliness and high throughput.


## sink parameter
### sink parameter

> In versions 1.3.3 and above, when only the sink is included, the additional "with sink" prefix is no longer required.

Expand All @@ -603,6 +603,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| node-urls | The URL of the data service port of any DataNode nodes on the target IoTDB (please note that synchronization tasks do 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' | Required | - |
| batch.enable | Whether to enable batched log transmission mode to improve transmission throughput and reduce IOPS | Boolean: true, false | Optional | true |
| batch.max-delay-seconds | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: s) | Integer | Optional | 1 |
| batch.max-delay-ms | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: ms) (Available since v1.3.6) | Integer | Optional | 1 |
| batch.size-bytes | Effective when batched log transmission mode is enabled, it represents the maximum batch size for a batch of data (unit: byte) | Long | Optional | 16*1024*1024 |

#### iotdb-air-gap-sink
Expand All @@ -621,6 +622,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| node-urls | The URL of the data service port of any DataNode nodes on the target IoTDB (please note that synchronization tasks do 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' | Required | - |
| batch.enable | Whether to enable batched log transmission mode to improve transmission throughput and reduce IOPS | Boolean: true, false | Optional | true |
| batch.max-delay-seconds | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: s) | Integer | Optional | 1 |
| batch.max-delay-ms | Effective when batched log transmission mode is enabled, it represents the maximum waiting time for a batch of data before sending (unit: ms) (Available since v1.3.6) | Integer | Optional | 1 |
| batch.size-bytes | Effective when batched log transmission mode is enabled, it represents the maximum batch size for a batch of data (unit: byte) | Long | Optional | 16*1024*1024 |
| ssl.trust-store-path | The trust store certificate path required to connect to the target DataNode | String: certificate directory name, when configured as a relative directory, it is relative to the IoTDB root directory. Example: '127.0.0.1:6667,127.0.0.1:6668,127.0.0.1:6669', '127.0.0.1:6667'| Required | - |
| ssl.trust-store-pwd | The trust store certificate password required to connect to the target DataNode | Integer | Required | - |
Loading