Add ALTER PIPE docs to data sync manuals (#1140)
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 5ec3ca8..c430287 100644
--- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md
@@ -214,7 +214,32 @@
```
-### 2.6 Synchronization Plugins
+### 2.6 Modify a Task
+
+The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink.
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+Description:
+
+* Executing this operation does not change the running state of the PIPE. It is equivalent to keeping the processing progress of the original PipeId and creating a new PIPE at the original progress position.
+* The modify/replace parameters for source/processor/sink are all optional. If no modification parameter is specified, it is equivalent to deleting the current PIPE and recreating it with the original configuration and progress.
+* For a plugin specified with modify, the plugin's other parameters are retained, and only the given parameters are replaced or added.
+* For a plugin specified with replace, all parameters of the plugin are replaced directly.
+* When the [IF EXISTS] keyword is used, execution succeeds even if no Pipe with the same name exists, but no operation is actually performed.
+
+Example:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 Synchronization Plugins
To make the architecture more flexible and adaptable to different synchronization scenarios, IoTDB supports plugin assembly in the synchronization task framework. The system provides some common pre-installed plugins, and you can also customize `processor` and `sink` plugins and load them into the IoTDB system.
@@ -564,4 +589,4 @@
| load-tsfile-strategy | When synchronizing file data, whether the receiver waits for the local load tsfile operation to complete before responding to the sender:<br>sync: Wait for the local load tsfile operation to complete before returning the response.<br>async: Do not wait for the local load tsfile operation to complete; return the response immediately. | String: sync / async | No | sync |
| 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 | - |
-| 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 when the sender and receiver have incompatible data types (to minimize errors). | String: hybrid / tsfile / tablet | No | hybrid |
\ No newline at end of file
+| 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 when the sender and receiver have incompatible data types (to minimize errors). | String: hybrid / tsfile / tablet | No | hybrid |
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 98bf472..a8702f3 100644
--- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
@@ -213,7 +213,32 @@
```
-### 2.6 Synchronization Plugins
+### 2.6 Modify a Task
+
+The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink.
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+Description:
+
+* Executing this operation does not change the running state of the PIPE. It is equivalent to keeping the processing progress of the original PipeId and creating a new PIPE at the original progress position.
+* The modify/replace parameters for source/processor/sink are all optional. If no modification parameter is specified, it is equivalent to deleting the current PIPE and recreating it with the original configuration and progress.
+* For a plugin specified with modify, the plugin's other parameters are retained, and only the given parameters are replaced or added.
+* For a plugin specified with replace, all parameters of the plugin are replaced directly.
+* When the [IF EXISTS] keyword is used, execution succeeds even if no Pipe with the same name exists, but no operation is actually performed.
+
+Example:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 Synchronization Plugins
To make the architecture more flexible and adaptable to different synchronization scenarios, IoTDB supports plugin assembly in the synchronization task framework. The system provides some common pre-installed plugins, and you can also customize `processor` and `sink` plugins and load them into the IoTDB system.
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 1b4981b..cbaf5c2 100644
--- a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md
@@ -234,7 +234,32 @@
+--------------------+-----------------------+-------+---------------------------------------------------------------------------+-------------+--------------------------+----------------+-------------------+-------------------------+
```
-### 2.6 Synchronization Plugins
+### 2.6 Modify Task
+
+The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink.
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+Description:
+
+* Executing this operation does not change the running state of the PIPE. It is equivalent to keeping the processing progress of the original PipeId and creating a new PIPE at the original progress position.
+* The modify/replace parameters for source/processor/sink are all optional. If no modification parameter is specified, it is equivalent to deleting the current PIPE and recreating it with the original configuration and progress.
+* For a plugin specified with modify, the plugin's other parameters are retained, and only the given parameters are replaced or added.
+* For a plugin specified with replace, all parameters of the plugin are replaced directly.
+* When the [IF EXISTS] keyword is used, execution succeeds even if no Pipe with the same name exists, but no operation is actually performed.
+
+Example:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 Synchronization Plugins
To make the overall architecture more flexible to match different synchronization scenario requirements, we support plugin assembly within the synchronization task framework. The system comes with some pre-installed common plugins that you can use directly. At the same time, you can also customize processor plugins and Sink plugins, and load them into the IoTDB system for use. You can view the plugins in the system (including custom and built-in plugins) with the following statement:
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 a970156..62fb61d 100644
--- a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md
@@ -236,7 +236,32 @@
```
-### 2.6 Synchronization Plugins
+### 2.6 Modify Task
+
+The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink.
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+Description:
+
+* Executing this operation does not change the running state of the PIPE. It is equivalent to keeping the processing progress of the original PipeId and creating a new PIPE at the original progress position.
+* The modify/replace parameters for source/processor/sink are all optional. If no modification parameter is specified, it is equivalent to deleting the current PIPE and recreating it with the original configuration and progress.
+* For a plugin specified with modify, the plugin's other parameters are retained, and only the given parameters are replaced or added.
+* For a plugin specified with replace, all parameters of the plugin are replaced directly.
+* When the [IF EXISTS] keyword is used, execution succeeds even if no Pipe with the same name exists, but no operation is actually performed.
+
+Example:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 Synchronization Plugins
To make the overall architecture more flexible to match different synchronization scenario requirements, we support plugin assembly within the synchronization task framework. The system comes with some pre-installed common plugins that you can use directly. At the same time, you can also customize processor plugins and Sink plugins, and load them into the IoTDB system for use. You can view the plugins in the system (including custom and built-in plugins) with the following statement:
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 5ec3ca8..c430287 100644
--- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
@@ -214,7 +214,32 @@
```
-### 2.6 Synchronization Plugins
+### 2.6 Modify a Task
+
+The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink.
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+Description:
+
+* Executing this operation does not change the running state of the PIPE. It is equivalent to keeping the processing progress of the original PipeId and creating a new PIPE at the original progress position.
+* The modify/replace parameters for source/processor/sink are all optional. If no modification parameter is specified, it is equivalent to deleting the current PIPE and recreating it with the original configuration and progress.
+* For a plugin specified with modify, the plugin's other parameters are retained, and only the given parameters are replaced or added.
+* For a plugin specified with replace, all parameters of the plugin are replaced directly.
+* When the [IF EXISTS] keyword is used, execution succeeds even if no Pipe with the same name exists, but no operation is actually performed.
+
+Example:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 Synchronization Plugins
To make the architecture more flexible and adaptable to different synchronization scenarios, IoTDB supports plugin assembly in the synchronization task framework. The system provides some common pre-installed plugins, and you can also customize `processor` and `sink` plugins and load them into the IoTDB system.
@@ -564,4 +589,4 @@
| load-tsfile-strategy | When synchronizing file data, whether the receiver waits for the local load tsfile operation to complete before responding to the sender:<br>sync: Wait for the local load tsfile operation to complete before returning the response.<br>async: Do not wait for the local load tsfile operation to complete; return the response immediately. | String: sync / async | No | sync |
| 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 | - |
-| 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 when the sender and receiver have incompatible data types (to minimize errors). | String: hybrid / tsfile / tablet | No | hybrid |
\ No newline at end of file
+| 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 when the sender and receiver have incompatible data types (to minimize errors). | String: hybrid / tsfile / tablet | No | hybrid |
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 98bf472..a8702f3 100644
--- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
@@ -213,7 +213,32 @@
```
-### 2.6 Synchronization Plugins
+### 2.6 Modify a Task
+
+The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink.
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+Description:
+
+* Executing this operation does not change the running state of the PIPE. It is equivalent to keeping the processing progress of the original PipeId and creating a new PIPE at the original progress position.
+* The modify/replace parameters for source/processor/sink are all optional. If no modification parameter is specified, it is equivalent to deleting the current PIPE and recreating it with the original configuration and progress.
+* For a plugin specified with modify, the plugin's other parameters are retained, and only the given parameters are replaced or added.
+* For a plugin specified with replace, all parameters of the plugin are replaced directly.
+* When the [IF EXISTS] keyword is used, execution succeeds even if no Pipe with the same name exists, but no operation is actually performed.
+
+Example:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 Synchronization Plugins
To make the architecture more flexible and adaptable to different synchronization scenarios, IoTDB supports plugin assembly in the synchronization task framework. The system provides some common pre-installed plugins, and you can also customize `processor` and `sink` plugins and load them into the IoTDB system.
diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
index 1b4981b..cbaf5c2 100644
--- a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
+++ b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md
@@ -234,7 +234,32 @@
+--------------------+-----------------------+-------+---------------------------------------------------------------------------+-------------+--------------------------+----------------+-------------------+-------------------------+
```
-### 2.6 Synchronization Plugins
+### 2.6 Modify Task
+
+The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink.
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+Description:
+
+* Executing this operation does not change the running state of the PIPE. It is equivalent to keeping the processing progress of the original PipeId and creating a new PIPE at the original progress position.
+* The modify/replace parameters for source/processor/sink are all optional. If no modification parameter is specified, it is equivalent to deleting the current PIPE and recreating it with the original configuration and progress.
+* For a plugin specified with modify, the plugin's other parameters are retained, and only the given parameters are replaced or added.
+* For a plugin specified with replace, all parameters of the plugin are replaced directly.
+* When the [IF EXISTS] keyword is used, execution succeeds even if no Pipe with the same name exists, but no operation is actually performed.
+
+Example:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 Synchronization Plugins
To make the overall architecture more flexible to match different synchronization scenario requirements, we support plugin assembly within the synchronization task framework. The system comes with some pre-installed common plugins that you can use directly. At the same time, you can also customize processor plugins and Sink plugins, and load them into the IoTDB system for use. You can view the plugins in the system (including custom and built-in plugins) with the following statement:
diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md b/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md
index a970156..62fb61d 100644
--- a/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md
@@ -236,7 +236,32 @@
```
-### 2.6 Synchronization Plugins
+### 2.6 Modify Task
+
+The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink.
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+Description:
+
+* Executing this operation does not change the running state of the PIPE. It is equivalent to keeping the processing progress of the original PipeId and creating a new PIPE at the original progress position.
+* The modify/replace parameters for source/processor/sink are all optional. If no modification parameter is specified, it is equivalent to deleting the current PIPE and recreating it with the original configuration and progress.
+* For a plugin specified with modify, the plugin's other parameters are retained, and only the given parameters are replaced or added.
+* For a plugin specified with replace, all parameters of the plugin are replaced directly.
+* When the [IF EXISTS] keyword is used, execution succeeds even if no Pipe with the same name exists, but no operation is actually performed.
+
+Example:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 Synchronization Plugins
To make the overall architecture more flexible to match different synchronization scenario requirements, we support plugin assembly within the synchronization task framework. The system comes with some pre-installed common plugins that you can use directly. At the same time, you can also customize processor plugins and Sink plugins, and load them into the IoTDB system for use. You can view the plugins in the system (including custom and built-in plugins) with the following statement:
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 4c89790..6a098bf 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
@@ -212,7 +212,32 @@
```
-### 2.6 同步插件
+### 2.6 修改任务
+
+`ALTER PIPE` 语句用于动态更新已存在的 PIPE,支持修改或替换 source、processor 及 sink 的配置。
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+说明:
+
+* 执行操作不会改变 PIPE 的运行状态,等价于保留原 PipeId 的处理进度,在原进度位置创建新 PIPE。
+* source/processor/sink 的 modify/replace 参数均为非必填;若未指定任何修改参数,等价于删除当前 PIPE 后,按原配置和进度重新创建。
+* 对于指定 modify 的插件,保留该插件其他参数,仅替换或新增给定的参数。
+* 对于指定 replace 的插件,直接替换该插件所有参数。
+* 当使用 [IF EXISTS] 关键字时,即使不存在同名的 Pipe 也会返回执行成功,但是实际未执行任何操作。
+
+示例:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 同步插件
为了使得整体架构更加灵活以匹配不同的同步场景需求,我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用,同时您也可以自定义 processor 插件 和 Sink 插件,并加载至 IoTDB 系统进行使用。查看系统中的插件(含自定义与内置插件)可以用以下语句:
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 e010e6f..8e443a9 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
@@ -211,7 +211,32 @@
+--------------------+-----------------------+-------+---------------------------------------------------------------------------+-------------+--------------------------+----------------+-------------------+-------------------------+
```
-### 2.6 同步插件
+### 2.6 修改任务
+
+`ALTER PIPE` 语句用于动态更新已存在的 PIPE,支持修改或替换 source、processor 及 sink 的配置。
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+说明:
+
+* 执行操作不会改变 PIPE 的运行状态,等价于保留原 PipeId 的处理进度,在原进度位置创建新 PIPE。
+* source/processor/sink 的 modify/replace 参数均为非必填;若未指定任何修改参数,等价于删除当前 PIPE 后,按原配置和进度重新创建。
+* 对于指定 modify 的插件,保留该插件其他参数,仅替换或新增给定的参数。
+* 对于指定 replace 的插件,直接替换该插件所有参数。
+* 当使用 [IF EXISTS] 关键字时,即使不存在同名的 Pipe 也会返回执行成功,但是实际未执行任何操作。
+
+示例:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 同步插件
为了使得整体架构更加灵活以匹配不同的同步场景需求,我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用,同时您也可以自定义 processor 插件 和 Sink 插件,并加载至 IoTDB 系统进行使用。查看系统中的插件(含自定义与内置插件)可以用以下语句:
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 7337060..4262215 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
@@ -237,7 +237,32 @@
```
-### 2.6 同步插件
+### 2.6 修改任务
+
+`ALTER PIPE` 语句用于动态更新已存在的 PIPE,支持修改或替换 source、processor 及 sink 的配置。
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+说明:
+
+* 执行操作不会改变 PIPE 的运行状态,等价于保留原 PipeId 的处理进度,在原进度位置创建新 PIPE。
+* source/processor/sink 的 modify/replace 参数均为非必填;若未指定任何修改参数,等价于删除当前 PIPE 后,按原配置和进度重新创建。
+* 对于指定 modify 的插件,保留该插件其他参数,仅替换或新增给定的参数。
+* 对于指定 replace 的插件,直接替换该插件所有参数。
+* 当使用 [IF EXISTS] 关键字时,即使不存在同名的 Pipe 也会返回执行成功,但是实际未执行任何操作。
+
+示例:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 同步插件
为了使得整体架构更加灵活以匹配不同的同步场景需求,我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用,同时您也可以自定义 processor 插件 和 Sink 插件,并加载至 IoTDB 系统进行使用。查看系统中的插件(含自定义与内置插件)可以用以下语句:
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 d956473..8930143 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
@@ -238,7 +238,32 @@
```
-### 2.6 同步插件
+### 2.6 修改任务
+
+`ALTER PIPE` 语句用于动态更新已存在的 PIPE,支持修改或替换 source、processor 及 sink 的配置。
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+说明:
+
+* 执行操作不会改变 PIPE 的运行状态,等价于保留原 PipeId 的处理进度,在原进度位置创建新 PIPE。
+* source/processor/sink 的 modify/replace 参数均为非必填;若未指定任何修改参数,等价于删除当前 PIPE 后,按原配置和进度重新创建。
+* 对于指定 modify 的插件,保留该插件其他参数,仅替换或新增给定的参数。
+* 对于指定 replace 的插件,直接替换该插件所有参数。
+* 当使用 [IF EXISTS] 关键字时,即使不存在同名的 Pipe 也会返回执行成功,但是实际未执行任何操作。
+
+示例:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 同步插件
为了使得整体架构更加灵活以匹配不同的同步场景需求,我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用,同时您也可以自定义 processor 插件 和 Sink 插件,并加载至 IoTDB 系统进行使用。查看系统中的插件(含自定义与内置插件)可以用以下语句:
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 4c89790..6a098bf 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
@@ -212,7 +212,32 @@
```
-### 2.6 同步插件
+### 2.6 修改任务
+
+`ALTER PIPE` 语句用于动态更新已存在的 PIPE,支持修改或替换 source、processor 及 sink 的配置。
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+说明:
+
+* 执行操作不会改变 PIPE 的运行状态,等价于保留原 PipeId 的处理进度,在原进度位置创建新 PIPE。
+* source/processor/sink 的 modify/replace 参数均为非必填;若未指定任何修改参数,等价于删除当前 PIPE 后,按原配置和进度重新创建。
+* 对于指定 modify 的插件,保留该插件其他参数,仅替换或新增给定的参数。
+* 对于指定 replace 的插件,直接替换该插件所有参数。
+* 当使用 [IF EXISTS] 关键字时,即使不存在同名的 Pipe 也会返回执行成功,但是实际未执行任何操作。
+
+示例:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 同步插件
为了使得整体架构更加灵活以匹配不同的同步场景需求,我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用,同时您也可以自定义 processor 插件 和 Sink 插件,并加载至 IoTDB 系统进行使用。查看系统中的插件(含自定义与内置插件)可以用以下语句:
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 e010e6f..8e443a9 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
@@ -211,7 +211,32 @@
+--------------------+-----------------------+-------+---------------------------------------------------------------------------+-------------+--------------------------+----------------+-------------------+-------------------------+
```
-### 2.6 同步插件
+### 2.6 修改任务
+
+`ALTER PIPE` 语句用于动态更新已存在的 PIPE,支持修改或替换 source、processor 及 sink 的配置。
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+说明:
+
+* 执行操作不会改变 PIPE 的运行状态,等价于保留原 PipeId 的处理进度,在原进度位置创建新 PIPE。
+* source/processor/sink 的 modify/replace 参数均为非必填;若未指定任何修改参数,等价于删除当前 PIPE 后,按原配置和进度重新创建。
+* 对于指定 modify 的插件,保留该插件其他参数,仅替换或新增给定的参数。
+* 对于指定 replace 的插件,直接替换该插件所有参数。
+* 当使用 [IF EXISTS] 关键字时,即使不存在同名的 Pipe 也会返回执行成功,但是实际未执行任何操作。
+
+示例:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 同步插件
为了使得整体架构更加灵活以匹配不同的同步场景需求,我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用,同时您也可以自定义 processor 插件 和 Sink 插件,并加载至 IoTDB 系统进行使用。查看系统中的插件(含自定义与内置插件)可以用以下语句:
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 7337060..4262215 100644
--- a/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md
+++ b/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md
@@ -237,7 +237,32 @@
```
-### 2.6 同步插件
+### 2.6 修改任务
+
+`ALTER PIPE` 语句用于动态更新已存在的 PIPE,支持修改或替换 source、processor 及 sink 的配置。
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+说明:
+
+* 执行操作不会改变 PIPE 的运行状态,等价于保留原 PipeId 的处理进度,在原进度位置创建新 PIPE。
+* source/processor/sink 的 modify/replace 参数均为非必填;若未指定任何修改参数,等价于删除当前 PIPE 后,按原配置和进度重新创建。
+* 对于指定 modify 的插件,保留该插件其他参数,仅替换或新增给定的参数。
+* 对于指定 replace 的插件,直接替换该插件所有参数。
+* 当使用 [IF EXISTS] 关键字时,即使不存在同名的 Pipe 也会返回执行成功,但是实际未执行任何操作。
+
+示例:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 同步插件
为了使得整体架构更加灵活以匹配不同的同步场景需求,我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用,同时您也可以自定义 processor 插件 和 Sink 插件,并加载至 IoTDB 系统进行使用。查看系统中的插件(含自定义与内置插件)可以用以下语句:
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 d956473..8930143 100644
--- a/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md
+++ b/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md
@@ -238,7 +238,32 @@
```
-### 2.6 同步插件
+### 2.6 修改任务
+
+`ALTER PIPE` 语句用于动态更新已存在的 PIPE,支持修改或替换 source、processor 及 sink 的配置。
+
+```SQL
+ALTER PIPE [IF EXISTS] <PipeId>
+ MODIFY/REPLACE SOURCE(...)
+ MODIFY/REPLACE PROCESSOR(...)
+ MODIFY/REPLACE SINK(...)
+```
+
+说明:
+
+* 执行操作不会改变 PIPE 的运行状态,等价于保留原 PipeId 的处理进度,在原进度位置创建新 PIPE。
+* source/processor/sink 的 modify/replace 参数均为非必填;若未指定任何修改参数,等价于删除当前 PIPE 后,按原配置和进度重新创建。
+* 对于指定 modify 的插件,保留该插件其他参数,仅替换或新增给定的参数。
+* 对于指定 replace 的插件,直接替换该插件所有参数。
+* 当使用 [IF EXISTS] 关键字时,即使不存在同名的 Pipe 也会返回执行成功,但是实际未执行任何操作。
+
+示例:
+
+```SQL
+ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668');
+```
+
+### 2.7 同步插件
为了使得整体架构更加灵活以匹配不同的同步场景需求,我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用,同时您也可以自定义 processor 插件 和 Sink 插件,并加载至 IoTDB 系统进行使用。查看系统中的插件(含自定义与内置插件)可以用以下语句: