You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by qi...@apache.org on 2022/11/04 09:57:27 UTC

[iotdb] branch master updated: Adjusted location of trigger section, added an example of REST API (#7906)

This is an automated email from the ASF dual-hosted git repository.

qiaojialin 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 2ef642275c Adjusted location of trigger section, added an example of REST API (#7906)
2ef642275c is described below

commit 2ef642275c8816daaab20a4af9fcf8e318bd6a7b
Author: wanghui42 <10...@users.noreply.github.com>
AuthorDate: Fri Nov 4 17:57:21 2022 +0800

    Adjusted location of trigger section, added an example of REST API (#7906)
---
 docs/UserGuide/Alert/Alerting.md                   |  2 +-
 docs/UserGuide/{Alert => Process-Data}/Triggers.md |  0
 docs/UserGuide/Write-Data/REST-API.md              | 36 +++++++++++++++++++++-
 docs/zh/UserGuide/Alert/Alerting.md                |  2 +-
 .../UserGuide/{Alert => Process-Data}/Triggers.md  |  0
 docs/zh/UserGuide/Write-Data/REST-API.md           | 35 ++++++++++++++++++++-
 site/src/main/.vuepress/config.js                  |  4 +--
 7 files changed, 73 insertions(+), 6 deletions(-)

diff --git a/docs/UserGuide/Alert/Alerting.md b/docs/UserGuide/Alert/Alerting.md
index 3d81377ab7..1f97bc6697 100644
--- a/docs/UserGuide/Alert/Alerting.md
+++ b/docs/UserGuide/Alert/Alerting.md
@@ -39,7 +39,7 @@ The data sink then forwards the alert to the external terminal.
     * It is Suitable for scenarios where the original data needs to be down-sampled and persisted.
     * Since the timing query hardly affects the writing of the original time series, it is suitable for scenarios that are sensitive to the performance of the original data writing performance.
 
-With the introduction of the `trigger` into IoTDB,
+With the introduction of the  [Trigger](../Process-Data/Triggers.md) into IoTDB,
 at present, users can use these two modules with `AlertManager` to realize the writing triggered alerting mode.
 
 
diff --git a/docs/UserGuide/Alert/Triggers.md b/docs/UserGuide/Process-Data/Triggers.md
similarity index 100%
rename from docs/UserGuide/Alert/Triggers.md
rename to docs/UserGuide/Process-Data/Triggers.md
diff --git a/docs/UserGuide/Write-Data/REST-API.md b/docs/UserGuide/Write-Data/REST-API.md
index 2014e7ace7..a298905741 100644
--- a/docs/UserGuide/Write-Data/REST-API.md
+++ b/docs/UserGuide/Write-Data/REST-API.md
@@ -21,4 +21,38 @@
 
 # REST API Write
 
-Refer to [insertTablet](../API/RestService.md#inserttablet)
\ No newline at end of file
+Refer to [insertTablet](../API/RestService.md#inserttablet)
+
+Example:
+
+```JSON
+{
+      "timestamps": [
+            1,
+            2,
+            3
+      ],
+      "measurements": [
+            "temperature",
+            "status"
+      ],
+      "dataTypes": [
+            "FLOAT",
+            "BOOLEAN"
+      ],
+      "values": [
+            [
+                  1.1,
+                  2.2,
+                  3.3
+            ],
+            [
+                  false,
+                  true,
+                  true
+            ]
+      ],
+      "isAligned": false,
+      "deviceId": "root.ln.wf01.wt01"
+}
+```
\ No newline at end of file
diff --git a/docs/zh/UserGuide/Alert/Alerting.md b/docs/zh/UserGuide/Alert/Alerting.md
index 8e3131435b..b75faeb9b1 100644
--- a/docs/zh/UserGuide/Alert/Alerting.md
+++ b/docs/zh/UserGuide/Alert/Alerting.md
@@ -39,7 +39,7 @@ IoTDB 告警功能预计支持两种模式:
     * 适合需要将原始数据降采样并持久化的场景。
     * 由于定时查询几乎不影响原始时间序列的写入,适合对原始数据写入性能敏感的场景。
 
-随着 `Trigger` 模块的引入,可以实现写入触发模式的告警。
+随着 [Trigger](../Process-Data/Triggers.md) 模块的引入,可以实现写入触发模式的告警。
 
 ## 部署 AlertManager 
 
diff --git a/docs/zh/UserGuide/Alert/Triggers.md b/docs/zh/UserGuide/Process-Data/Triggers.md
similarity index 100%
rename from docs/zh/UserGuide/Alert/Triggers.md
rename to docs/zh/UserGuide/Process-Data/Triggers.md
diff --git a/docs/zh/UserGuide/Write-Data/REST-API.md b/docs/zh/UserGuide/Write-Data/REST-API.md
index e77b35f9e0..f53a7641c2 100644
--- a/docs/zh/UserGuide/Write-Data/REST-API.md
+++ b/docs/zh/UserGuide/Write-Data/REST-API.md
@@ -21,4 +21,37 @@
 
 # REST API写入
 
-参考 [insertTablet](../API/RestService.md#inserttablet)
\ No newline at end of file
+参考 [insertTablet](../API/RestService.md#inserttablet)
+
+示例如下:
+```JSON
+{
+      "timestamps": [
+            1,
+            2,
+            3
+      ],
+      "measurements": [
+            "temperature",
+            "status"
+      ],
+      "dataTypes": [
+            "FLOAT",
+            "BOOLEAN"
+      ],
+      "values": [
+            [
+                  1.1,
+                  2.2,
+                  3.3
+            ],
+            [
+                  false,
+                  true,
+                  true
+            ]
+      ],
+      "isAligned": false,
+      "deviceId": "root.ln.wf01.wt01"
+}
+```
diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index 9b4bb287db..2c5876ff1f 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -936,6 +936,7 @@ var config = {
 							['Process-Data/UDF-User-Defined-Function','UDF (User Defined Function)'],
 							['Process-Data/Select-Into','Query Write-back (SELECT INTO)'],
 							['Process-Data/Continuous-Query','CQ (Continuous Query)'],
+							['Process-Data/Triggers','Triggers'],
 						]
 					},
 					{
@@ -943,7 +944,6 @@ var config = {
 						sidebarDepth: 1,
 						children: [
 							['Alert/Alerting','Alerting'],
-							['Alert/Triggers','Triggers'],
 						]
 					},
 					{
@@ -1873,6 +1873,7 @@ var config = {
 							['Process-Data/UDF-User-Defined-Function','用户定义函数(UDF)'],
 							['Process-Data/Select-Into','查询写回(SELECT INTO)'],
 							['Process-Data/Continuous-Query','连续查询(CQ)'],
+							['Process-Data/Triggers','触发器'],
 						]
 					},
 					{
@@ -1880,7 +1881,6 @@ var config = {
 						sidebarDepth: 1,
 						children: [
 							['Alert/Alerting','告警机制'],
-							['Alert/Triggers','触发器'],
 						]
 					},
 					{