This is an automated email from the ASF dual-hosted git repository.
haonan 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 07ff1bc6 Starting from version V2.0.8-beta, the parameter path
supports specif… (#994)
07ff1bc6 is described below
commit 07ff1bc6ce497992d004fd1f327fc7a52e267813
Author: leto-b <[email protected]>
AuthorDate: Tue Mar 31 17:03:46 2026 +0800
Starting from version V2.0.8-beta, the parameter path supports specif…
(#994)
* Starting from version V2.0.8-beta, the parameter path supports specifying
multiple exact paths in a single pipe, e.g.,
'path'='root.test.d0.s1,root.test.d0.s2,root.test.d0.s3'.
* remove beta from timecho
---
.../Master/Tree/User-Manual/Data-Sync_apache.md | 22 +++++++++++-----------
.../Master/Tree/User-Manual/Data-Sync_timecho.md | 2 +-
.../latest/User-Manual/Data-Sync_apache.md | 12 ++++++------
.../latest/User-Manual/Data-Sync_timecho.md | 2 +-
.../Master/Tree/User-Manual/Data-Sync_apache.md | 4 ++--
.../Master/Tree/User-Manual/Data-Sync_timecho.md | 4 ++--
.../latest/User-Manual/Data-Sync_apache.md | 4 ++--
.../latest/User-Manual/Data-Sync_timecho.md | 4 ++--
8 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
index 513d46c2..7416a56a 100644
--- a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
@@ -515,18 +515,18 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
### 5.1 source parameter
-| key | value
[...]
-| :------------------------------
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| source | iotdb-source
[...]
-| inclusion | Used to specify the range of data to be
synchronized in the data synchronization task, including data, schema, and auth
[...]
-| inclusion.exclusion | Used to exclude specific operations from the
range specified by inclusion, reducing the amount of data synchronized
[...]
+| key | value
| value range
| required or not | default value |
+| :------------------------------ |
:-----------------------------------------------------------
|:-----------------------------------------------------------------------|
:------- | :------------- |
+| source | iotdb-source
| String: iotdb-source
| Required | - |
+| inclusion | Used to specify the range of data to be
synchronized in the data synchronization task, including data, schema, and auth
| String:all, data(insert,delete), schema(database,timeseries,ttl), auth |
Optional | data.insert |
+| inclusion.exclusion | Used to exclude specific operations from the
range specified by inclusion, reducing the amount of data synchronized |
String:all, data(insert,delete), schema(database,timeseries,ttl), auth |
Optional | - |
| mode.streaming | Specifies the capture source for time-series data
writes. Applicable when mode.streamingis false, determining the source for
capturing data.insertspecified in inclusion. Offers two strategies:- true:
Dynamic capture selection. The system adaptively chooses between capturing
individual write requests or only TsFile sealing requests based on downstream
processing speed. Prioritizes capturing write requests for lower latency when
processing is fast; captures [...]
-| mode.strict | Determines the strictness when filtering data
using time/ path/ database-name/ table-nameparameters:- true: Strict
filtering. The system strictly filters captured data according to the given
conditions, ensuring only matching data is selected.- false: Non-strict
filtering. The system may include some extra data during filtering. Suitable
for performance-sensitive scenarios to reduce CPU and I/O consumption.
[...]
-| mode.snapshot | Determines the capture mode for time-series data,
affecting the dataspecified in inclusion. Offers two modes:- true: Static
data capture. Upon pipe startup, a one-time data snapshot is captured. The
pipe will automatically terminate (DROP PIPE SQL is executed automatically)
after the snapshot data is fully consumed.- false: Dynamic data capture.
In addition to capturing a snapshot upon startup, the pipe continuously
captures subsequent data change [...]
-| path | Can be specified when the user connects with
sql_dialectset to tree. For upgraded user pipes, the default sql_dialectis
tree. This parameter determines the capture scope for time-series data,
affecting the dataspecified in inclusion, as well as some sequence-related
metadata. Data is selected into the streaming pipe if its tree mode path
matches the specified path.
[...]
-| start-time | The start event time for synchronizing all data,
including start-time
[...]
-| end-time | The end event time for synchronizing all data,
including end-time
[...]
-| forwarding-pipe-requests | Whether to forward data written by other Pipes
(usually data synchronization)
[...]
+| mode.strict | Determines the strictness when filtering data
using time/ path/ database-name/ table-nameparameters:- true: Strict
filtering. The system strictly filters captured data according to the given
conditions, ensuring only matching data is selected.- false: Non-strict
filtering. The system may include some extra data during filtering. Suitable
for performance-sensitive scenarios to reduce CPU and I/O consumption. |
Boolean: true / false [...]
+| mode.snapshot | Determines the capture mode for time-series data,
affecting the dataspecified in inclusion. Offers two modes:- true: Static
data capture. Upon pipe startup, a one-time data snapshot is captured. The
pipe will automatically terminate (DROP PIPE SQL is executed automatically)
after the snapshot data is fully consumed.- false: Dynamic data capture.
In addition to capturing a snapshot upon startup, the pipe continuously
captures subsequent data change [...]
+| path | Can be specified when the user connects with
sql_dialectset to tree. For upgraded user pipes, the default sql_dialectis
tree. This parameter determines the capture scope for time-series data,
affecting the dataspecified in inclusion, as well as some sequence-related
metadata. Data is selected into the streaming pipe if its tree model path
matches the specified path. <br> Starting from version V2.0.8-beta, this
parameter supports specifying multiple exact pat [...]
+| start-time | The start event time for synchronizing all data,
including start-time | Long: [Long.MIN_VALUE, Long.MAX_VALUE]
| Optional | Long.MIN_VALUE |
+| end-time | The end event time for synchronizing all data,
including end-time | Long: [Long.MIN_VALUE, Long.MAX_VALUE]
| Optional | Long.MAX_VALUE |
+| forwarding-pipe-requests | Whether to forward data written by other Pipes
(usually data synchronization) | Boolean: true /false
| Optional | true |
| mods | Same as mods.enable, whether to send the MODS
file for TSFile.
[...]
> 💎 **Note:** The difference between the values of true and false for the
> data extraction mode `mode.streaming`
diff --git a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
index acd3a32f..cc980607 100644
--- a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
@@ -610,7 +610,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| mode.streaming | Specifies the capture source for time-series data
writes. Applicable when mode.streamingis false, determining the source for
capturing data.insertspecified in inclusion. Offers two strategies:- true:
Dynamic capture selection. The system adaptively chooses between capturing
individual write requests or only TsFile sealing requests based on downstream
processing speed. Prioritizes capturing write requests for lower latency when
processing is fast; captures [...]
| mode.strict | Determines the strictness when filtering data
using time/ path/ database-name/ table-nameparameters:- true: Strict
filtering. The system strictly filters captured data according to the given
conditions, ensuring only matching data is selected.- false: Non-strict
filtering. The system may include some extra data during filtering. Suitable
for performance-sensitive scenarios to reduce CPU and I/O consumption.
[...]
| mode.snapshot | Determines the capture mode for time-series data,
affecting the dataspecified in inclusion. Offers two modes:- true: Static
data capture. Upon pipe startup, a one-time data snapshot is captured. The
pipe will automatically terminate (DROP PIPE SQL is executed automatically)
after the snapshot data is fully consumed.- false: Dynamic data capture.
In addition to capturing a snapshot upon startup, the pipe continuously
captures subsequent data change [...]
-| path | Can be specified when the user connects with
sql_dialectset to tree. For upgraded user pipes, the default sql_dialectis
tree. This parameter determines the capture scope for time-series data,
affecting the dataspecified in inclusion, as well as some sequence-related
metadata. Data is selected into the streaming pipe if its tree mode path
matches the specified path.
[...]
+| path | Can be specified when the user connects with
sql_dialectset to tree. For upgraded user pipes, the default sql_dialectis
tree. This parameter determines the capture scope for time-series data,
affecting the dataspecified in inclusion, as well as some sequence-related
metadata. Data is selected into the streaming pipe if its tree model path
matches the specified path. <br> Starting from version V2.0.8.2, this
parameter supports specifying multiple exact paths [...]
| start-time | The start event time for synchronizing all data,
including start-time
[...]
| end-time | The end event time for synchronizing all data,
including end-time
[...]
| forwarding-pipe-requests | Whether to forward data written by other Pipes
(usually data synchronization)
[...]
diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
index 513d46c2..863eb9a5 100644
--- a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
@@ -521,12 +521,12 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| inclusion | Used to specify the range of data to be
synchronized in the data synchronization task, including data, schema, and auth
[...]
| inclusion.exclusion | Used to exclude specific operations from the
range specified by inclusion, reducing the amount of data synchronized
[...]
| mode.streaming | Specifies the capture source for time-series data
writes. Applicable when mode.streamingis false, determining the source for
capturing data.insertspecified in inclusion. Offers two strategies:- true:
Dynamic capture selection. The system adaptively chooses between capturing
individual write requests or only TsFile sealing requests based on downstream
processing speed. Prioritizes capturing write requests for lower latency when
processing is fast; captures [...]
-| mode.strict | Determines the strictness when filtering data
using time/ path/ database-name/ table-nameparameters:- true: Strict
filtering. The system strictly filters captured data according to the given
conditions, ensuring only matching data is selected.- false: Non-strict
filtering. The system may include some extra data during filtering. Suitable
for performance-sensitive scenarios to reduce CPU and I/O consumption.
[...]
-| mode.snapshot | Determines the capture mode for time-series data,
affecting the dataspecified in inclusion. Offers two modes:- true: Static
data capture. Upon pipe startup, a one-time data snapshot is captured. The
pipe will automatically terminate (DROP PIPE SQL is executed automatically)
after the snapshot data is fully consumed.- false: Dynamic data capture.
In addition to capturing a snapshot upon startup, the pipe continuously
captures subsequent data change [...]
-| path | Can be specified when the user connects with
sql_dialectset to tree. For upgraded user pipes, the default sql_dialectis
tree. This parameter determines the capture scope for time-series data,
affecting the dataspecified in inclusion, as well as some sequence-related
metadata. Data is selected into the streaming pipe if its tree mode path
matches the specified path.
[...]
-| start-time | The start event time for synchronizing all data,
including start-time
[...]
-| end-time | The end event time for synchronizing all data,
including end-time
[...]
-| forwarding-pipe-requests | Whether to forward data written by other Pipes
(usually data synchronization)
[...]
+| mode.strict | Determines the strictness when filtering data
using time/ path/ database-name/ table-nameparameters:- true: Strict
filtering. The system strictly filters captured data according to the given
conditions, ensuring only matching data is selected.- false: Non-strict
filtering. The system may include some extra data during filtering. Suitable
for performance-sensitive scenarios to reduce CPU and I/O consumption. |
Boolean: true / false [...]
+| mode.snapshot | Determines the capture mode for time-series data,
affecting the dataspecified in inclusion. Offers two modes:- true: Static
data capture. Upon pipe startup, a one-time data snapshot is captured. The
pipe will automatically terminate (DROP PIPE SQL is executed automatically)
after the snapshot data is fully consumed.- false: Dynamic data capture.
In addition to capturing a snapshot upon startup, the pipe continuously
captures subsequent data change [...]
+| path | Can be specified when the user connects with
sql_dialectset to tree. For upgraded user pipes, the default sql_dialectis
tree. This parameter determines the capture scope for time-series data,
affecting the dataspecified in inclusion, as well as some sequence-related
metadata. Data is selected into the streaming pipe if its tree model path
matches the specified path. <br> Starting from version V2.0.8-beta, this
parameter supports specifying multiple exact pat [...]
+| start-time | The start event time for synchronizing all data,
including start-time | Long: [Long.MIN_VALUE, Long.MAX_VALUE]
| Optional | Long.MIN_VALUE |
+| end-time | The end event time for synchronizing all data,
including end-time | Long: [Long.MIN_VALUE, Long.MAX_VALUE]
| Optional | Long.MAX_VALUE |
+| forwarding-pipe-requests | Whether to forward data written by other Pipes
(usually data synchronization) | Boolean: true /false
| Optional | true |
| mods | Same as mods.enable, whether to send the MODS
file for TSFile.
[...]
> 💎 **Note:** The difference between the values of true and false for the
> data extraction mode `mode.streaming`
diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md
b/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md
index acd3a32f..dbcee4bb 100644
--- a/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md
@@ -610,7 +610,7 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| mode.streaming | Specifies the capture source for time-series data
writes. Applicable when mode.streamingis false, determining the source for
capturing data.insertspecified in inclusion. Offers two strategies:- true:
Dynamic capture selection. The system adaptively chooses between capturing
individual write requests or only TsFile sealing requests based on downstream
processing speed. Prioritizes capturing write requests for lower latency when
processing is fast; captures [...]
| mode.strict | Determines the strictness when filtering data
using time/ path/ database-name/ table-nameparameters:- true: Strict
filtering. The system strictly filters captured data according to the given
conditions, ensuring only matching data is selected.- false: Non-strict
filtering. The system may include some extra data during filtering. Suitable
for performance-sensitive scenarios to reduce CPU and I/O consumption.
[...]
| mode.snapshot | Determines the capture mode for time-series data,
affecting the dataspecified in inclusion. Offers two modes:- true: Static
data capture. Upon pipe startup, a one-time data snapshot is captured. The
pipe will automatically terminate (DROP PIPE SQL is executed automatically)
after the snapshot data is fully consumed.- false: Dynamic data capture.
In addition to capturing a snapshot upon startup, the pipe continuously
captures subsequent data change [...]
-| path | Can be specified when the user connects with
sql_dialectset to tree. For upgraded user pipes, the default sql_dialectis
tree. This parameter determines the capture scope for time-series data,
affecting the dataspecified in inclusion, as well as some sequence-related
metadata. Data is selected into the streaming pipe if its tree mode path
matches the specified path.
[...]
+| path | Can be specified when the user connects with
sql_dialectset to tree. For upgraded user pipes, the default sql_dialectis
tree. This parameter determines the capture scope for time-series data,
affecting the dataspecified in inclusion, as well as some sequence-related
metadata. Data is selected into the streaming pipe if its tree model path
matches the specified path. <br> Starting from version V2.0.8, this parameter
supports specifying multiple exact paths in [...]
| start-time | The start event time for synchronizing all data,
including start-time
[...]
| end-time | The end event time for synchronizing all data,
including end-time
[...]
| forwarding-pipe-requests | Whether to forward data written by other Pipes
(usually data synchronization)
[...]
diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
index ef18a711..ffacb90d 100644
--- a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
+++ b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
@@ -519,11 +519,11 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| mode.streaming | 此参数指定时序数据写入的捕获来源。适用于 `mode.streaming`为 `false`
模式下的场景,决定`inclusion`中`data.insert`数据的捕获来源。提供两种捕获策略:true:
动态选择捕获的类型。系统将根据下游处理速度,自适应地选择是捕获每个写入请求还是仅捕获 TsFile
文件的封口请求。当下游处理速度快时,优先捕获写入请求以减少延迟;当处理速度慢时,仅捕获文件封口请求以避免处理堆积。这种模式适用于大多数场景,能够实现处理延迟和吞吐量的最优平衡。false:固定按批捕获方式。仅捕获
TsFile 文件的封口请求,适用于资源受限的应用场景,以降低系统负载。注意,pipe 启动时捕获的快照数据只会以文件的方式供下游处理。 |
Boolean: true / false | 否
| true |
| mode.strict | 在使用 time / path / database-name / table-name
参数过滤数据时,是否需要严格按照条件筛选:`true`:
严格筛选。系统将完全按照给定条件过滤筛选被捕获的数据,确保只有符合条件的数据被选中。`false`:非严格筛选。系统在筛选被捕获的数据时可能会包含一些额外的数据,适用于性能敏感的场景,可降低
CPU 和 IO 消耗。
| Boolean: true / false | 否
| true |
| mode.snapshot |
此参数决定时序数据的捕获方式,影响`inclusion`中的`data`数据。提供两种模式:`true`:静态数据捕获。启动 pipe
时,会进行一次性的数据快照捕获。当快照数据被完全消费后,**pipe 将自动终止(DROP PIPE SQL
会自动执行)**。`false`:动态数据捕获。除了在 pipe 启动时捕获快照数据外,还会持续捕获后续的数据变更。pipe 将持续运行以处理动态数据流。
| Boolean: true / false
| 否 | false
|
-| path |
当用户连接指定的sql_dialect为tree时可以指定。对于升级上来的用户pipe,默认sql_dialect为tree。此参数决定时序数据的捕获范围,影响
inclusion中的data数据,以及部分序列相关的元数据。当数据的树模型路径能够被path匹配时,数据会被筛选出来进入流处理pipe。
[...]
+| path |
当用户连接指定的sql_dialect为tree时可以指定。对于升级上来的用户pipe,默认sql_dialect为tree。此参数决定时序数据的捕获范围,影响
inclusion中的data数据,以及部分序列相关的元数据。当数据的树模型路径能够被path匹配时,数据会被筛选出来进入流处理pipe。<br> 自
V2.0.8-beta 版本起,该参数支持在一个pipe中填写多个精确路径的path , 如
`'path'='root.test.d0,s1,root.test.d0.s2,root.test.d0.s3'`
| String:IoTDB标准的树路径模式,可以带通配符
| 选填 | root.** |
| start-time | 同步所有数据的开始 event time,包含 start-time
| Long: [Long.MIN_VALUE,
Long.MAX_VALUE] | 选填 | Long.MIN_VALUE |
| end-time | 同步所有数据的结束 event time,包含 end-time
| Long: [Long.MIN_VALUE,
Long.MAX_VALUE] | 选填 | Long.MAX_VALUE |
| forwarding-pipe-requests | 是否转发由其他 Pipe (通常是数据同步)写入的数据
| Boolean: true, false
| 选填 | true |
-| mods | 同 mods.enable,是否发送 tsfile 的 mods 文件
| Boolean: true / false
| 选填 | false |
+| mods | 同 mods.enable,是否发送 tsfile 的 mods 文件
| Boolean: true / false
| 选填 | false |
> 💎 **说明:数据抽取模式 mode.streaming 取值 true 和 false 的差异**
> - **true(推荐)**:该取值下,任务将对数据进行实时处理、发送,其特点是高时效、低吞吐
diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
index 8333d18f..7bbd4695 100644
--- a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
+++ b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
@@ -606,11 +606,11 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| mode.streaming | 此参数指定时序数据写入的捕获来源。适用于 `mode.streaming`为 `false`
模式下的场景,决定`inclusion`中`data.insert`数据的捕获来源。提供两种捕获策略:true:
动态选择捕获的类型。系统将根据下游处理速度,自适应地选择是捕获每个写入请求还是仅捕获 TsFile
文件的封口请求。当下游处理速度快时,优先捕获写入请求以减少延迟;当处理速度慢时,仅捕获文件封口请求以避免处理堆积。这种模式适用于大多数场景,能够实现处理延迟和吞吐量的最优平衡。false:固定按批捕获方式。仅捕获
TsFile 文件的封口请求,适用于资源受限的应用场景,以降低系统负载。注意,pipe 启动时捕获的快照数据只会以文件的方式供下游处理。 |
Boolean: true / false | 否
| true |
| mode.strict | 在使用 time / path / database-name / table-name
参数过滤数据时,是否需要严格按照条件筛选:`true`:
严格筛选。系统将完全按照给定条件过滤筛选被捕获的数据,确保只有符合条件的数据被选中。`false`:非严格筛选。系统在筛选被捕获的数据时可能会包含一些额外的数据,适用于性能敏感的场景,可降低
CPU 和 IO 消耗。
| Boolean: true / false | 否
| true |
| mode.snapshot |
此参数决定时序数据的捕获方式,影响`inclusion`中的`data`数据。提供两种模式:`true`:静态数据捕获。启动 pipe
时,会进行一次性的数据快照捕获。当快照数据被完全消费后,**pipe 将自动终止(DROP PIPE SQL
会自动执行)**。`false`:动态数据捕获。除了在 pipe 启动时捕获快照数据外,还会持续捕获后续的数据变更。pipe 将持续运行以处理动态数据流。
| Boolean: true / false
| 否 | false
|
-| path |
当用户连接指定的sql_dialect为tree时可以指定。对于升级上来的用户pipe,默认sql_dialect为tree。此参数决定时序数据的捕获范围,影响
inclusion中的data数据,以及部分序列相关的元数据。当数据的树模型路径能够被path匹配时,数据会被筛选出来进入流处理pipe。
| String:IoTDB标准的树路径模式,可以带通配符
| 选填 | root.** |
+| path |
当用户连接指定的sql_dialect为tree时可以指定。对于升级上来的用户pipe,默认sql_dialect为tree。此参数决定时序数据的捕获范围,影响
inclusion中的data数据,以及部分序列相关的元数据。当数据的树模型路径能够被path匹配时,数据会被筛选出来进入流处理pipe。<br> 自
V2.0.8 版本起,该参数支持在一个pipe中填写多个精确路径的path , 如
`'path'='root.test.d0,s1,root.test.d0.s2,root.test.d0.s3'`
| String:IoTDB标准的树路径模式,可以带通配符
| 选填 | root.** |
| start-time | 同步所有数据的开始 event time,包含 start-time
| Long: [Long.MIN_VALUE,
Long.MAX_VALUE] | 选填 | Long.MIN_VALUE |
| end-time | 同步所有数据的结束 event time,包含 end-time
| Long: [Long.MIN_VALUE,
Long.MAX_VALUE] | 选填 | Long.MAX_VALUE |
| forwarding-pipe-requests | 是否转发由其他 Pipe (通常是数据同步)写入的数据
| Boolean: true, false
| 选填 | true |
-| mods | 同 mods.enable,是否发送 tsfile 的 mods 文件
| Boolean: true / false
| 选填 | false |
+| mods | 同 mods.enable,是否发送 tsfile 的 mods 文件
| Boolean: true / false
| 选填 | false |
> 💎 **说明:数据抽取模式 mode.streaming 取值 true 和 false 的差异**
> - **true(推荐)**:该取值下,任务将对数据进行实时处理、发送,其特点是高时效、低吞吐
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 ef18a711..ffacb90d 100644
--- a/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md
+++ b/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md
@@ -519,11 +519,11 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| mode.streaming | 此参数指定时序数据写入的捕获来源。适用于 `mode.streaming`为 `false`
模式下的场景,决定`inclusion`中`data.insert`数据的捕获来源。提供两种捕获策略:true:
动态选择捕获的类型。系统将根据下游处理速度,自适应地选择是捕获每个写入请求还是仅捕获 TsFile
文件的封口请求。当下游处理速度快时,优先捕获写入请求以减少延迟;当处理速度慢时,仅捕获文件封口请求以避免处理堆积。这种模式适用于大多数场景,能够实现处理延迟和吞吐量的最优平衡。false:固定按批捕获方式。仅捕获
TsFile 文件的封口请求,适用于资源受限的应用场景,以降低系统负载。注意,pipe 启动时捕获的快照数据只会以文件的方式供下游处理。 |
Boolean: true / false | 否
| true |
| mode.strict | 在使用 time / path / database-name / table-name
参数过滤数据时,是否需要严格按照条件筛选:`true`:
严格筛选。系统将完全按照给定条件过滤筛选被捕获的数据,确保只有符合条件的数据被选中。`false`:非严格筛选。系统在筛选被捕获的数据时可能会包含一些额外的数据,适用于性能敏感的场景,可降低
CPU 和 IO 消耗。
| Boolean: true / false | 否
| true |
| mode.snapshot |
此参数决定时序数据的捕获方式,影响`inclusion`中的`data`数据。提供两种模式:`true`:静态数据捕获。启动 pipe
时,会进行一次性的数据快照捕获。当快照数据被完全消费后,**pipe 将自动终止(DROP PIPE SQL
会自动执行)**。`false`:动态数据捕获。除了在 pipe 启动时捕获快照数据外,还会持续捕获后续的数据变更。pipe 将持续运行以处理动态数据流。
| Boolean: true / false
| 否 | false
|
-| path |
当用户连接指定的sql_dialect为tree时可以指定。对于升级上来的用户pipe,默认sql_dialect为tree。此参数决定时序数据的捕获范围,影响
inclusion中的data数据,以及部分序列相关的元数据。当数据的树模型路径能够被path匹配时,数据会被筛选出来进入流处理pipe。
[...]
+| path |
当用户连接指定的sql_dialect为tree时可以指定。对于升级上来的用户pipe,默认sql_dialect为tree。此参数决定时序数据的捕获范围,影响
inclusion中的data数据,以及部分序列相关的元数据。当数据的树模型路径能够被path匹配时,数据会被筛选出来进入流处理pipe。<br> 自
V2.0.8-beta 版本起,该参数支持在一个pipe中填写多个精确路径的path , 如
`'path'='root.test.d0,s1,root.test.d0.s2,root.test.d0.s3'`
| String:IoTDB标准的树路径模式,可以带通配符
| 选填 | root.** |
| start-time | 同步所有数据的开始 event time,包含 start-time
| Long: [Long.MIN_VALUE,
Long.MAX_VALUE] | 选填 | Long.MIN_VALUE |
| end-time | 同步所有数据的结束 event time,包含 end-time
| Long: [Long.MIN_VALUE,
Long.MAX_VALUE] | 选填 | Long.MAX_VALUE |
| forwarding-pipe-requests | 是否转发由其他 Pipe (通常是数据同步)写入的数据
| Boolean: true, false
| 选填 | true |
-| mods | 同 mods.enable,是否发送 tsfile 的 mods 文件
| Boolean: true / false
| 选填 | false |
+| mods | 同 mods.enable,是否发送 tsfile 的 mods 文件
| Boolean: true / false
| 选填 | false |
> 💎 **说明:数据抽取模式 mode.streaming 取值 true 和 false 的差异**
> - **true(推荐)**:该取值下,任务将对数据进行实时处理、发送,其特点是高时效、低吞吐
diff --git a/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md
b/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md
index 8333d18f..7bbd4695 100644
--- a/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md
+++ b/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md
@@ -606,11 +606,11 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| mode.streaming | 此参数指定时序数据写入的捕获来源。适用于 `mode.streaming`为 `false`
模式下的场景,决定`inclusion`中`data.insert`数据的捕获来源。提供两种捕获策略:true:
动态选择捕获的类型。系统将根据下游处理速度,自适应地选择是捕获每个写入请求还是仅捕获 TsFile
文件的封口请求。当下游处理速度快时,优先捕获写入请求以减少延迟;当处理速度慢时,仅捕获文件封口请求以避免处理堆积。这种模式适用于大多数场景,能够实现处理延迟和吞吐量的最优平衡。false:固定按批捕获方式。仅捕获
TsFile 文件的封口请求,适用于资源受限的应用场景,以降低系统负载。注意,pipe 启动时捕获的快照数据只会以文件的方式供下游处理。 |
Boolean: true / false | 否
| true |
| mode.strict | 在使用 time / path / database-name / table-name
参数过滤数据时,是否需要严格按照条件筛选:`true`:
严格筛选。系统将完全按照给定条件过滤筛选被捕获的数据,确保只有符合条件的数据被选中。`false`:非严格筛选。系统在筛选被捕获的数据时可能会包含一些额外的数据,适用于性能敏感的场景,可降低
CPU 和 IO 消耗。
| Boolean: true / false | 否
| true |
| mode.snapshot |
此参数决定时序数据的捕获方式,影响`inclusion`中的`data`数据。提供两种模式:`true`:静态数据捕获。启动 pipe
时,会进行一次性的数据快照捕获。当快照数据被完全消费后,**pipe 将自动终止(DROP PIPE SQL
会自动执行)**。`false`:动态数据捕获。除了在 pipe 启动时捕获快照数据外,还会持续捕获后续的数据变更。pipe 将持续运行以处理动态数据流。
| Boolean: true / false
| 否 | false
|
-| path |
当用户连接指定的sql_dialect为tree时可以指定。对于升级上来的用户pipe,默认sql_dialect为tree。此参数决定时序数据的捕获范围,影响
inclusion中的data数据,以及部分序列相关的元数据。当数据的树模型路径能够被path匹配时,数据会被筛选出来进入流处理pipe。
| String:IoTDB标准的树路径模式,可以带通配符
| 选填 | root.** |
+| path |
当用户连接指定的sql_dialect为tree时可以指定。对于升级上来的用户pipe,默认sql_dialect为tree。此参数决定时序数据的捕获范围,影响
inclusion中的data数据,以及部分序列相关的元数据。当数据的树模型路径能够被path匹配时,数据会被筛选出来进入流处理pipe。<br> 自
V2.0.8 版本起,该参数支持在一个pipe中填写多个精确路径的path , 如
`'path'='root.test.d0,s1,root.test.d0.s2,root.test.d0.s3'`
| String:IoTDB标准的树路径模式,可以带通配符
| 选填 | root.** |
| start-time | 同步所有数据的开始 event time,包含 start-time
| Long: [Long.MIN_VALUE,
Long.MAX_VALUE] | 选填 | Long.MIN_VALUE |
| end-time | 同步所有数据的结束 event time,包含 end-time
| Long: [Long.MIN_VALUE,
Long.MAX_VALUE] | 选填 | Long.MAX_VALUE |
| forwarding-pipe-requests | 是否转发由其他 Pipe (通常是数据同步)写入的数据
| Boolean: true, false
| 选填 | true |
-| mods | 同 mods.enable,是否发送 tsfile 的 mods 文件
| Boolean: true / false
| 选填 | false |
+| mods | 同 mods.enable,是否发送 tsfile 的 mods 文件
| Boolean: true / false
| 选填 | false |
> 💎 **说明:数据抽取模式 mode.streaming 取值 true 和 false 的差异**
> - **true(推荐)**:该取值下,任务将对数据进行实时处理、发送,其特点是高时效、低吞吐