You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ha...@apache.org on 2022/11/18 02:59:58 UTC
[iotdb] branch master updated: [IOTDB-4953] Fix some sync-tool document description errors (#8038)
This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 3d5eeae81e [IOTDB-4953] Fix some sync-tool document description errors (#8038)
3d5eeae81e is described below
commit 3d5eeae81e5109040dcb8873955a8275e3efaf76
Author: Chen YZ <43...@users.noreply.github.com>
AuthorDate: Fri Nov 18 10:59:52 2022 +0800
[IOTDB-4953] Fix some sync-tool document description errors (#8038)
---
.../Edge-Cloud-Collaboration/Sync-Tool.md | 38 ++++++++++------------
.../Edge-Cloud-Collaboration/Sync-Tool.md | 35 ++++++++++----------
2 files changed, 35 insertions(+), 38 deletions(-)
diff --git a/docs/UserGuide/Edge-Cloud-Collaboration/Sync-Tool.md b/docs/UserGuide/Edge-Cloud-Collaboration/Sync-Tool.md
index 2c0882f57b..230717a746 100644
--- a/docs/UserGuide/Edge-Cloud-Collaboration/Sync-Tool.md
+++ b/docs/UserGuide/Edge-Cloud-Collaboration/Sync-Tool.md
@@ -49,7 +49,7 @@ Two machines A and B, which are installed with iotdb, we want to continuously sy
- When one or more senders send data to a receiver, there should be no intersection between the respective device path sets of these senders and receivers, otherwise unexpected errors may occur.
- e.g. When sender A includes path `root.sg.d.s`, sender B also includes the path `root.sg.d.s`, sender A deletes database `root.sg` will also delete all data of B stored in the path `root.sg.d.s` at receiver.
- The two "ends" do not support synchronization with each other.
-- The Sync Tool only synchronizes insertions, delete data, delete timeseires. If no database is created on the receiver, a database of the same level as the sender will be automatically created. Do not support TTL settings, trigger and other operations.
+- The Sync Tool only synchronizes insertions. If no database is created on the receiver, a database of the same level as the sender will be automatically created. Currently, deletion operation is not guaranteed to be synchronized and do not support TTL settings, trigger and other operations.
- If TTL is set on the sender side, all unexpired data in the IoTDB and all future data writes and deletions will be synchronized to the receiver side when Pipe is started.
- When operating a synchronization task, ensure that all DataNode nodes in `SHOW DATANODES` that are in the Running state are connected, otherwise the execution will fail.
@@ -105,7 +105,7 @@ IoTDB> DROP PIPE my_pipe
## 5.Parameter Configuration
-All parameters are in `$IOTDB_ HOME$/conf/iotdb-engine`, after all modifications are completed, execute `load configuration` and it will take effect immediately.
+All parameters are in `$IOTDB_ HOME$/conf/iotdb-common.properties`, after all modifications are completed, execute `load configuration` and it will take effect immediately.
### 5.1 Sender
@@ -146,7 +146,7 @@ IoTDB>
* Create a PipeSink with IoTDB type, where IP and port are optional parameters.
```
-IoTDB> CREATE PIPESINK <PipeSinkName> AS IoTDB [(ip='127.0.0.1',port=6670);]
+IoTDB> CREATE PIPESINK <PipeSinkName> AS IoTDB [(ip='127.0.0.1',port=6667);]
```
### DROP PIPESINK
@@ -168,7 +168,7 @@ IoTDB>
+-----------+-----+------------------------+
| name| type| attributes|
+-----------+-----+------------------------+
-|my_pipesink|IoTDB|ip='127.0.0.1',port=6670|
+|my_pipesink|IoTDB|ip='127.0.0.1',port=6667|
+-----------+-----+------------------------+
```
@@ -177,12 +177,10 @@ IoTDB>
- Create a pipe.
- At present, the SELECT statement only supports `**` (i.e. data in all timeseries), the FROM statement only supports `root`, and the WHERE statement only supports the start time of the specified time. The start time can be specified in the form of yyyy-mm-dd HH:MM:SS or a timestamp.
-
- - If the `SyncDelOp` parameter is true, the deletions of sender will not be synchronized to receiver. Default is false.
-
+
```
-IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>='yyyy-mm-dd HH:MM:SS' )] [WITH SyncDelOp=true]
+IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>='yyyy-mm-dd HH:MM:SS' )]
```
### STOP PIPE
@@ -241,13 +239,13 @@ IoTDB> DROP PIPE <PipeName>
```
IoTDB> SHOW PIPES
IoTDB>
-+-----------------------+--------+--------+-------------+---------+-----------------------------------+-------+
-| create time| name | role| remote| status| attributes|message|
-+-----------------------+--------+--------+-------------+---------+-----------------------------------+-------+
-|2022-03-30T20:58:30.689|my_pipe1| sender| my_pipesink| STOP|syncDelOp=true,dataStartTimestamp=0| |
-+-----------------------+--------+--------+-------------+---------+-----------------------------------+-------+
-|2022-03-31T12:55:28.129|my_pipe2|receiver|192.168.11.11| RUNNING| storageGroup='root.vehicle'| |
-+-----------------------+--------+--------+-------------+---------+-----------------------------------+-------+
++-----------------------+--------+--------+-------------+---------+------------------------------------+-------+
+| create time| name | role| remote| status| attributes|message|
++-----------------------+--------+--------+-------------+---------+------------------------------------+-------+
+|2022-03-30T20:58:30.689|my_pipe1| sender| my_pipesink| STOP|SyncDelOp=false,DataStartTimestamp=0| |
++-----------------------+--------+--------+-------------+---------+------------------------------------+-------+
+|2022-03-31T12:55:28.129|my_pipe2|receiver|192.168.11.11| RUNNING| Database='root.vehicle'| |
++-----------------------+--------+--------+-------------+---------+------------------------------------+-------+
```
- Show the pipe status with PipeName. When the PipeName is empty，it is the same with `Show PIPES`.
@@ -267,7 +265,7 @@ IoTDB> SHOW PIPE [PipeName]
### Receiver
-- `vi conf/iotdb-datanode.properties` to config the parameters，set the IP white list to 192.168.0.1/1 to receive and only receive data from sender.
+- `vi conf/iotdb-common.properties` to config the parameters，set the IP white list to 192.168.0.1/1 to receive and only receive data from sender.
```
####################
@@ -283,16 +281,16 @@ ip_white_list=192.168.0.1/1
### Sender
-- Create PipeSink with IoTDB type, input ip address 192.168.0.1, port 6670.
+- Create PipeSink with IoTDB type, input ip address 192.168.0.1, port 6667.
```
-IoTDB> CREATE PIPESINK my_iotdb AS IoTDB (IP='192.168.0.2'，PORT=6670)
+IoTDB> CREATE PIPESINK my_iotdb AS IoTDB (IP='192.168.0.2'，PORT=6667)
```
-- Create Pipe connect to my_iotdb, input the start time 2022-03-30 00:00:00 in WHERE statments, set the `SyncDelOp` to false. The following two SQL statements are equivalent
+- Create Pipe connect to my_iotdb, input the start time 2022-03-30 00:00:00 in WHERE statments. The following two SQL statements are equivalent
```
-IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>='2022-03-30 00:00:00') WITH SyncDelOp=false
+IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>='2022-03-30 00:00:00')
IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>= 1648569600000)
```
diff --git a/docs/zh/UserGuide/Edge-Cloud-Collaboration/Sync-Tool.md b/docs/zh/UserGuide/Edge-Cloud-Collaboration/Sync-Tool.md
index 8a316e8feb..ed77a3f0eb 100644
--- a/docs/zh/UserGuide/Edge-Cloud-Collaboration/Sync-Tool.md
+++ b/docs/zh/UserGuide/Edge-Cloud-Collaboration/Sync-Tool.md
@@ -47,7 +47,7 @@ TsFile 同步工具实现了数据从 "流入-> IoTDB ->流出" 的闭环。假
- 当有一个或多个发送端指向一个接收端时，这些发送端和接收端各自的设备路径集合之间应当没有交集，否则可能产生不可预料错误
- 例如：当发送端A包括路径`root.sg.d.s`，发送端B也包括路径`root.sg.d.s`，当发送端A删除`root.sg` database 时将也会在接收端删除所有B在接收端的`root.sg.d.s`中存放的数据。
- 两个“端”之间目前不支持相互同步。
-- 同步工具仅同步数据写入、数据删除、时间序列删除，若接收端未创建 database，自动创建与发送端同级 database。TTL 的设置、Trigger、CQ 等其他操作均不同步
+- 同步工具仅同步数据写入，若接收端未创建 database，自动创建与发送端同级 database。当前版本删除操作不保证被同步，不支持 TTL 的设置、Trigger、CQ 等其他操作的同步。
- 若在发送端设置了 TTL，则启动 Pipe 时候 IoTDB 中所有未过期的数据以及未来所有的数据写入和删除都会被同步至接收端
- 对同步任务进行操作时，需保证 `SHOW DATANODES` 中所有处于 Running 状态的 DataNode 节点均可连通，否则将执行失败。
@@ -100,7 +100,7 @@ IoTDB> DROP PIPE my_pipe
## 5.配置参数
-所有参数修改均在`$IOTDB_HOME$/conf/iotdb-datanode.properties`中，所有修改完成之后执行`load configuration`之后即可立刻生效。
+所有参数修改均在`$IOTDB_HOME$/conf/iotdb-common.properties`中，所有修改完成之后执行`load configuration`之后即可立刻生效。
### 5.1发送端相关
@@ -139,7 +139,7 @@ IoTDB>
- 创建接收端为 IoTDB 类型的 PipeSink，其中IP和port是可选参数。当接收端为集群时，填写任意一个 DataNode 的 `rpc_address` 与 `rpc_port`。
```
-IoTDB> CREATE PIPESINK <PipeSinkName> AS IoTDB [(ip='127.0.0.1',port=6670);]
+IoTDB> CREATE PIPESINK <PipeSinkName> AS IoTDB [(ip='127.0.0.1',port=6667);]
```
### DROP PIPESINK
@@ -161,7 +161,7 @@ IoTDB>
+-----------+-----+------------------------+
| name| type| attributes|
+-----------+-----+------------------------+
-|my_pipesink|IoTDB|ip='127.0.0.1',port=6670|
+|my_pipesink|IoTDB|ip='127.0.0.1',port=6667|
+-----------+-----+------------------------+
```
@@ -169,10 +169,9 @@ IoTDB>
- 创建同步任务
- 其中 select 语句目前仅支持`**`（即所有序列中的数据），from 语句目前仅支持`root`，where语句仅支持指定 time 的起始时间。起始时间的指定形式可以是 yyyy-mm-dd HH:MM:SS或时间戳。
- - `SyncDelOp`参数为 true 时会同步删除数据操作，否则不同步删除数据操作，默认为 false。
```Plain%20Text
-IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>=yyyy-mm-dd HH:MM:SS)] [WITH SyncDelOp=false]
+IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>=yyyy-mm-dd HH:MM:SS)]
```
### STOP PIPE
@@ -230,13 +229,13 @@ IoTDB> DROP PIPE <PipeName>
```Plain%20Text
IoTDB> SHOW PIPES
IoTDB>
-+-----------------------+--------+--------+-------------+---------+-----------------------------------+-------+
-| create time| name | role| remote| status| attributes|message|
-+-----------------------+--------+--------+-------------+---------+-----------------------------------+-------+
-|2022-03-30T20:58:30.689|my_pipe1| sender| my_pipesink| STOP|syncDelOp=true,dataStartTimestamp=0| |
-+-----------------------+--------+--------+-------------+---------+-----------------------------------+-------+
-|2022-03-31T12:55:28.129|my_pipe2|receiver|192.168.11.11| RUNNING| storageGroup='root.vehicle'| |
-+-----------------------+--------+--------+-------------+---------+-----------------------------------+-------+
++-----------------------+--------+--------+-------------+---------+------------------------------------+-------+
+| create time| name | role| remote| status| attributes|message|
++-----------------------+--------+--------+-------------+---------+------------------------------------+-------+
+|2022-03-30T20:58:30.689|my_pipe1| sender| my_pipesink| STOP|SyncDelOp=false,DataStartTimestamp=0| |
++-----------------------+--------+--------+-------------+---------+------------------------------------+-------+
+|2022-03-31T12:55:28.129|my_pipe2|receiver|192.168.11.11| RUNNING| Database='root.vehicle'| |
++-----------------------+--------+--------+-------------+---------+------------------------------------+-------+
```
- 显示指定同步任务状态，当未指定PipeName时，与`SHOW PIPES`等效
@@ -256,7 +255,7 @@ IoTDB> SHOW PIPE [PipeName]
### 接收端操作
-`vi conf/iotdb-datanode.properties` 配置云端参数，将白名单设置为仅接收来自 IP 为 192.168.0.1 的边端的数据
+`vi conf/iotdb-common.properties` 配置云端参数，将白名单设置为仅接收来自 IP 为 192.168.0.1 的边端的数据
```
####################
@@ -272,16 +271,16 @@ ip_white_list=192.168.0.1/32
### 发送端操作
-创建云端 PipeSink，指定类型为 IoTDB，指定云端 IP 地址为 192.168.0.1，指定云端的 PipeServer 服务端口为6670
+创建云端 PipeSink，指定类型为 IoTDB，指定云端 IP 地址为 192.168.0.1，指定云端的 PipeServer 服务端口为6667
```
-IoTDB> CREATE PIPESINK my_iotdb AS IoTDB (ip='192.168.0.1',port=6670)
+IoTDB> CREATE PIPESINK my_iotdb AS IoTDB (ip='192.168.0.1',port=6667)
```
-创建Pipe，指定连接到my_iotdb的PipeSink，在WHREE子句中输入开始时间点2022年3月30日0时，将SyncDelOp置为false。以下两条执行语句等价。
+创建Pipe，指定连接到my_iotdb的PipeSink，在WHREE子句中输入开始时间点2022年3月30日0时。以下两条执行语句等价。
```
-IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>=2022-03-30 00:00:00) WITH SyncDelOp=false
+IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>=2022-03-30 00:00:00)
IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>= 1648569600000)
```