update the doc of data sync #116
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Haonan <[email protected]>
|
|
||
| ## 快速开始 | ||
| 使用 `CREATE PIPE` 语句来创建一条数据同步任务，下列属性中`PipeId`和`connector`为必填项，`extractor`和`processor`为选填项，输入SQL时注意 `EXTRACTOR `与 `CONNECTOR` 插件顺序不能替换。 |
|
|
||
| 使用 DROP PIPE 语句使任务停止处理数据（当任务状态为 RUNNING 时），然后删除整个任务同步任务： | ||
| 删除指定任务： |
|
|
||
| ### 任务运行状态迁移 |
There was a problem hiding this comment.
这部分要根据语法调整来更新，现在已经不对用户暴露处理插件了，那就不用介绍了。预置插件内容也没有更新
| | 插件名称 | 类型 | 介绍 | 适用版本 | | ||
| | ---------------------------- | ---- | ------------------------------------------------------------ | --------- | | ||
| | iotdb-extractor | extractor 插件 | 默认的extractor插件，用于抽取 IoTDB 历史或实时数据 | 1.2.x | | ||
| | do-nothing-processor | processor 插件 | 默认的processor插件，不对传入的数据做任何的处理 | 1.2.x | |
There was a problem hiding this comment.
processor插件也可以不用介绍了，语法里都没有process
|
|
||
|  | ||
| 每个插件的属性参考[参数说明](#connector-参数)。 |
| ``` | ||
| > ✅ | ||
| > | ||
| > - `'extractor.realtime.mode'='file'`表示实时数据的抽取模式为 file 模式，该模式下，任务仅使用数据文件进行数据处理、发送。 |
There was a problem hiding this comment.
这部分和前面需要补充的介绍合并一下。放在后面不容易在刚开始就关注到，最好写在sql前
| ```Go | ||
| create pipe AB | ||
| with extractor ( | ||
| 'extractor.forwarding-pipe-requests', |
|
|
||
| > 📌 请确保接收端已经创建了发送端的所有时间序列，或是开启了自动创建元数据，否则将会导致 pipe 运行失败。 | ||
| 创建一个名为 A2B 的pipe，实现内网服务器上的 A，经由单向网闸，传输数据到外网服务器上的B，如下图所示： |
There was a problem hiding this comment.
数据穿透网闸需要使用xxx的connector插件（目前支持部分型号网闸，具体型号请联系天谋科技工作人员确认），blabla
|
|
||
| ```Properties |
There was a problem hiding this comment.
这部分是不是只需要留配置项了，title也可以改了
|
|
||
| ### 源端：数据写入与 Pipe 处理、发送数据异步解耦 | ||
| ### connector 参数 |
There was a problem hiding this comment.
connector也按照我们暴露给用户的插件删减一下
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.