diff --git a/src/UserGuide/Master/User-Manual/Data-Sync_timecho.md b/src/UserGuide/Master/User-Manual/Data-Sync_timecho.md index 83a5aacbe..62c9c81e9 100644 --- a/src/UserGuide/Master/User-Manual/Data-Sync_timecho.md +++ b/src/UserGuide/Master/User-Manual/Data-Sync_timecho.md @@ -124,6 +124,7 @@ WITH SINK ( After creation, the task will not be processed immediately and needs to be started. Use the `START PIPE` statement to start the task and begin processing data: + ```SQL START PIPE ``` @@ -132,6 +133,7 @@ START PIPE Stop processing data: + ```SQL STOP PIPE ``` @@ -140,6 +142,7 @@ STOP PIPE Deletes the specified task: + ```SQL DROP PIPE ``` @@ -150,12 +153,14 @@ Deleting a task does not require stopping the synchronization task first. View all tasks: + ```SQL SHOW PIPES ``` To view a specified task: + ```SQL SHOW PIPE ``` @@ -186,6 +191,7 @@ The meanings of each column are as follows: 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: + ```SQL SHOW PIPEPLUGINS ``` @@ -268,6 +274,7 @@ This example is used to demonstrate the synchronisation of all data from one IoT In this example, we can create a synchronization task named A2B to synchronize the full data from A IoTDB to B IoTDB. The iotdb-thrift-sink plugin (built-in plugin) for the sink is required. The URL of the data service port of the DataNode node on the target IoTDB needs to be configured through node-urls, as shown in the following example statement: + ```SQL create pipe A2B with sink ( @@ -311,6 +318,7 @@ The detailed statement is as follows: On A IoTDB, execute the following statement: + ```SQL create pipe AB with source ( @@ -325,6 +333,7 @@ with sink ( On B IoTDB, execute the following statement: + ```SQL create pipe BA with source ( @@ -376,6 +385,7 @@ with sink ( On D IoTDB, execute the following statement to synchronize data from D to A: + ```SQL create pipe DA with source ( @@ -410,6 +420,7 @@ with sink ( On B IoTDB, execute the following statement to synchronize data from B to C: + ```SQL create pipe BC with source ( @@ -429,6 +440,7 @@ This example is used to demonstrate the scenario where data from one IoTDB is sy ![](https://alioss.timecho.com/upload/pipe5.jpg) + In this example, the iotdb-air-gap-sink plugin in the sink task needs to be used (currently supports some gateway models, for specific models, please contact Timecho staff for confirmation). After configuring the gateway, execute the following statement on A IoTDB. Fill in the node-urls with the URL of the data service port of the DataNode node on the target IoTDB configured by the gateway, as detailed below: ```SQL diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md b/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md index 739f63092..a9c668bf3 100644 --- a/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md +++ b/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md @@ -104,6 +104,7 @@ Use the `CREATE PIPE` statement to create a data synchronization task. The `Pipe The SQL example is as follows: + ```SQL CREATE PIPE -- PipeId is the name that uniquely identifies the task. -- Data extraction plugin, optional plugin @@ -132,6 +133,7 @@ START PIPE Stop processing data: + ```SQL STOP PIPE ``` @@ -140,6 +142,7 @@ STOP PIPE Deletes the specified task: + ```SQL DROP PIPE ``` @@ -150,12 +153,14 @@ Deleting a task does not require stopping the synchronization task first. View all tasks: + ```SQL SHOW PIPES ``` To view a specified task: + ```SQL SHOW PIPE ``` @@ -185,6 +190,7 @@ The meanings of each column are as follows: 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: + ```SQL SHOW PIPEPLUGINS ``` @@ -265,6 +271,7 @@ This example is used to demonstrate the synchronisation of all data from one IoT In this example, we can create a synchronization task named A2B to synchronize the full data from A IoTDB to B IoTDB. The iotdb-thrift-sink plugin (built-in plugin) for the sink is required. The URL of the data service port of the DataNode node on the target IoTDB needs to be configured through node-urls, as shown in the following example statement: + ```SQL create pipe A2B with sink ( @@ -308,6 +315,7 @@ The detailed statement is as follows: On A IoTDB, execute the following statement: + ```SQL create pipe AB with source ( @@ -322,6 +330,7 @@ with sink ( On B IoTDB, execute the following statement: + ```SQL create pipe BA with source ( @@ -396,6 +405,7 @@ In this example, to synchronize the data from cluster A to C, the `forwarding-pi On A IoTDB, execute the following statement to synchronize data from A to B: + ```SQL create pipe AB with sink ( @@ -407,6 +417,7 @@ with sink ( On B IoTDB, execute the following statement to synchronize data from B to C: + ```SQL create pipe BC with source ( @@ -426,6 +437,7 @@ This example is used to demonstrate the scenario where data from one IoTDB is sy ![](https://alioss.timecho.com/upload/pipe5.jpg) + In this example, the iotdb-air-gap-sink plugin in the sink task needs to be used (currently supports some gateway models, for specific models, please contact Timecho staff for confirmation). After configuring the gateway, execute the following statement on A IoTDB. Fill in the node-urls with the URL of the data service port of the DataNode node on the target IoTDB configured by the gateway, as detailed below: ```SQL diff --git a/src/zh/UserGuide/Master/User-Manual/Data-Sync_timecho.md b/src/zh/UserGuide/Master/User-Manual/Data-Sync_timecho.md index 5d8fa9a91..f8b7ab5f8 100644 --- a/src/zh/UserGuide/Master/User-Manual/Data-Sync_timecho.md +++ b/src/zh/UserGuide/Master/User-Manual/Data-Sync_timecho.md @@ -123,6 +123,7 @@ WITH SINK ( 创建之后，任务不会立即被处理，需要启动任务。使用`START PIPE`语句来启动任务，从而开始处理数据： + ```SQL START PIPE ``` @@ -131,6 +132,7 @@ START PIPE 停止处理数据： + ```SQL STOP PIPE ``` @@ -139,6 +141,7 @@ STOP PIPE 删除指定任务： + ```SQL DROP PIPE ``` @@ -149,12 +152,14 @@ DROP PIPE 查看全部任务： + ```SQL SHOW PIPES ``` 查看指定任务： + ```SQL SHOW PIPE ``` @@ -185,12 +190,14 @@ SHOW PIPE 为了使得整体架构更加灵活以匹配不同的同步场景需求，我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用，同时您也可以自定义 processor 插件 和 Sink 插件，并加载至 IoTDB 系统进行使用。查看系统中的插件（含自定义与内置插件）可以用以下语句： + ```SQL SHOW PIPEPLUGINS ``` 返回结果如下： + ```SQL IoTDB> SHOW PIPEPLUGINS +------------------------------+----------+--------------------------------------------------------------------------------------------------+----------------------------------------------------+ @@ -267,6 +274,7 @@ IoTDB> SHOW PIPEPLUGINS 在这个例子中，我们可以创建一个名为 A2B 的同步任务，用来同步 A IoTDB 到 B IoTDB 间的全量数据，这里需要用到用到 sink 的 iotdb-thrift-sink 插件（内置插件），需通过 node-urls 配置目标端 IoTDB 中 DataNode 节点的数据服务端口的 url，如下面的示例语句： + ```SQL create pipe A2B with sink ( @@ -311,6 +319,7 @@ with SINK ( 在 A IoTDB 上执行下列语句： + ```SQL create pipe AB with source ( @@ -325,6 +334,7 @@ with sink ( 在 B IoTDB 上执行下列语句： + ```SQL create pipe BA with source ( @@ -396,6 +406,7 @@ with sink ( 在 A IoTDB 上执行下列语句，将 A 中数据同步至 B： + ```SQL create pipe AB with sink ( @@ -406,6 +417,7 @@ with sink ( 在 B IoTDB 上执行下列语句，将 B 中数据同步至 C： + ```SQL create pipe BC with source ( 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 ebba2dc10..47bbddc1f 100644 --- a/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md +++ b/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md @@ -103,7 +103,7 @@ SQL 示例如下： -```SQL +```sql CREATE PIPE -- PipeId 是能够唯一标定任务任务的名字 -- 数据抽取插件，可选插件 WITH SOURCE ( @@ -123,6 +123,7 @@ WITH SINK ( 创建之后，任务不会立即被处理，需要启动任务。使用`START PIPE`语句来启动任务，从而开始处理数据： + ```SQL START PIPE ``` @@ -131,6 +132,7 @@ START PIPE 停止处理数据： + ```SQL STOP PIPE ``` @@ -149,12 +151,14 @@ DROP PIPE 查看全部任务： + ```SQL SHOW PIPES ``` 查看指定任务： + ```SQL SHOW PIPE ``` @@ -184,6 +188,7 @@ pipe 的 show pipes 结果示例： 为了使得整体架构更加灵活以匹配不同的同步场景需求，我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用，同时您也可以自定义 processor 插件 和 Sink 插件，并加载至 IoTDB 系统进行使用。查看系统中的插件（含自定义与内置插件）可以用以下语句： + ```SQL SHOW PIPEPLUGINS ``` @@ -265,6 +270,7 @@ IoTDB> SHOW PIPEPLUGINS 在这个例子中，我们可以创建一个名为 A2B 的同步任务，用来同步 A IoTDB 到 B IoTDB 间的全量数据，这里需要用到用到 sink 的 iotdb-thrift-sink 插件（内置插件），需通过 node-urls 配置目标端 IoTDB 中 DataNode 节点的数据服务端口的 url，如下面的示例语句： + ```SQL create pipe A2B with sink (