You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ja...@apache.org on 2022/12/06 07:52:42 UTC
[iotdb] branch rel/1.0 updated: [IOTDB-5120] update doc about operator-functions
This is an automated email from the ASF dual-hosted git repository.
jackietien pushed a commit to branch rel/1.0
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/rel/1.0 by this push:
new 966be335c5 [IOTDB-5120] update doc about operator-functions
966be335c5 is described below
commit 966be335c587e5bd1e0e90c062d7a0de7cbf4685
Author: Weihao Li <60...@users.noreply.github.com>
AuthorDate: Tue Dec 6 15:52:36 2022 +0800
[IOTDB-5120] update doc about operator-functions
---
docs/UserGuide/Operators-Functions/Data-Profiling.md | 4 ++--
docs/UserGuide/Operators-Functions/String.md | 4 ++--
docs/UserGuide/Operators-Functions/User-Defined-Function.md | 2 +-
docs/zh/UserGuide/Operators-Functions/Data-Profiling.md | 4 ++--
docs/zh/UserGuide/Operators-Functions/Overview.md | 2 +-
docs/zh/UserGuide/Operators-Functions/String.md | 4 ++--
docs/zh/UserGuide/Operators-Functions/User-Defined-Function.md | 2 +-
7 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/docs/UserGuide/Operators-Functions/Data-Profiling.md b/docs/UserGuide/Operators-Functions/Data-Profiling.md
index c6c59962c8..08f8379896 100644
--- a/docs/UserGuide/Operators-Functions/Data-Profiling.md
+++ b/docs/UserGuide/Operators-Functions/Data-Profiling.md
@@ -28,14 +28,14 @@
This function is used to calculate the auto-correlation factor of the input time series,
which equals to cross correlation between the same series.
-For more information, please refer to `XCorr` function.
+For more information, please refer to [XCorr](./Data-Matching.md#XCorr) function.
**Name:** ACF
**Input Series:** Only support a single input numeric series. The type is INT32 / INT64 / FLOAT / DOUBLE.
**Output Series:** Output a single series. The type is DOUBLE.
-There are $2N-1$ data points in the series, and the values are interpreted in details in `XCorr` function.
+There are $2N-1$ data points in the series, and the values are interpreted in details in [XCorr](./Data-Matching.md#XCorr) function.
**Note:**
diff --git a/docs/UserGuide/Operators-Functions/String.md b/docs/UserGuide/Operators-Functions/String.md
index 653b057d95..d6d6ac1b09 100644
--- a/docs/UserGuide/Operators-Functions/String.md
+++ b/docs/UserGuide/Operators-Functions/String.md
@@ -131,13 +131,13 @@ Output series:
+-----------------------------+--------------+----------------------+
```
-## StrLocate
+## Locate
### Usage
The function is used to get the position of the first occurrence of substring `target` in input series. Returns -1 if there are no `target` in input.
-**Name:** LENGTH
+**Name:** LOCATE
**Input Series:** Only support a single input series. The data type is TEXT.
diff --git a/docs/UserGuide/Operators-Functions/User-Defined-Function.md b/docs/UserGuide/Operators-Functions/User-Defined-Function.md
index 1cf71ea686..5bcaf94630 100644
--- a/docs/UserGuide/Operators-Functions/User-Defined-Function.md
+++ b/docs/UserGuide/Operators-Functions/User-Defined-Function.md
@@ -590,7 +590,7 @@ When you have prepared the UDF source code, test cases, and instructions, you ar
## Known Implementation UDF Libraries
-+ [IoTDB-Quality](https://iotdb.apache.org/UserGuide/Master/UDF-Library/Quick-Start.html ), a UDF library about data quality, including data profiling, data quality evalution and data repairing, etc.
++ [IoTDB-Quality](./Data-Profiling.md), a UDF library about data quality, including data profiling, data quality evalution and data repairing, etc.
## Q&A
diff --git a/docs/zh/UserGuide/Operators-Functions/Data-Profiling.md b/docs/zh/UserGuide/Operators-Functions/Data-Profiling.md
index 0fc5977b8b..b496fc6b25 100644
--- a/docs/zh/UserGuide/Operators-Functions/Data-Profiling.md
+++ b/docs/zh/UserGuide/Operators-Functions/Data-Profiling.md
@@ -25,13 +25,13 @@
### 函数简介
-本函数用于计算时间序列的自相关函数值，即序列与自身之间的互相关函数，详情参见`XCorr`函数文档。
+本函数用于计算时间序列的自相关函数值，即序列与自身之间的互相关函数，详情参见[XCorr](./Data-Matching.md#XCorr)函数文档。
**函数名：** ACF
**输入序列：** 仅支持单个输入序列，类型为 INT32 / INT64 / FLOAT / DOUBLE。
-**输出序列：** 输出单个序列，类型为 DOUBLE。序列中共包含$2N-1$个数据点，每个值的具体含义参见`XCorr`函数文档。
+**输出序列：** 输出单个序列，类型为 DOUBLE。序列中共包含$2N-1$个数据点，每个值的具体含义参见[XCorr](./Data-Matching.md#XCorr)函数文档。
**提示：**
diff --git a/docs/zh/UserGuide/Operators-Functions/Overview.md b/docs/zh/UserGuide/Operators-Functions/Overview.md
index f5a64ad0da..bf4ef5d1cf 100644
--- a/docs/zh/UserGuide/Operators-Functions/Overview.md
+++ b/docs/zh/UserGuide/Operators-Functions/Overview.md
@@ -152,7 +152,7 @@ OR, |, ||
| STRING_CONTAINS | TEXT | `s`: 待搜寻的字符串 | BOOLEAN | 判断字符串中是否存在`s` |
| STRING_MATCHES | TEXT | `regex`: Java 标准库风格的正则表达式 | BOOLEAN | 判断字符串是否能够被正则表达式`regex`匹配 |
| LENGTH | TEXT | 无 | INT32 | 返回字符串的长度 |
-| STRLOCATE | TEXT | `target`: 需要被定位的子串 <br/> `reverse`: 指定是否需要倒序定位，默认值为`false`, 即从左至右定位 | INT32 | 获取`target`子串第一次出现在输入序列的位置，如果输入序列中不包含`target`则返回 -1 |
+| LOCATE | TEXT | `target`: 需要被定位的子串 <br/> `reverse`: 指定是否需要倒序定位，默认值为`false`, 即从左至右定位 | INT32 | 获取`target`子串第一次出现在输入序列的位置，如果输入序列中不包含`target`则返回 -1 |
| STARTSWITH | TEXT | `target`: 需要匹配的前缀 | BOOLEAN | 判断字符串是否有指定前缀 |
| ENDSWITH | TEXT | `target`: 需要匹配的后缀 | BOOLEAN | 判断字符串是否有指定后缀 |
| CONCAT | TEXT | `targets`: 一系列 K-V, key需要以`target`为前缀且不重复, value是待拼接的字符串。<br/>`series_behind`: 指定拼接时时间序列是否在后面，默认为`false`。 | TEXT | 拼接字符串和`target`字串 |
diff --git a/docs/zh/UserGuide/Operators-Functions/String.md b/docs/zh/UserGuide/Operators-Functions/String.md
index 935acd9411..3f59900552 100644
--- a/docs/zh/UserGuide/Operators-Functions/String.md
+++ b/docs/zh/UserGuide/Operators-Functions/String.md
@@ -135,13 +135,13 @@ select s1, length(s1) from root.sg1.d1
+-----------------------------+--------------+----------------------+
```
-## StrLocate
+## Locate
### 函数简介
本函数用于获取`target`子串第一次出现在输入序列的位置，如果输入序列中不包含`target`则返回 -1 。
-**函数名:** LENGTH
+**函数名:** LOCATE
**输入序列:** 仅支持单个输入序列，类型为 TEXT。
diff --git a/docs/zh/UserGuide/Operators-Functions/User-Defined-Function.md b/docs/zh/UserGuide/Operators-Functions/User-Defined-Function.md
index 764fdfebb4..6a49cf4458 100644
--- a/docs/zh/UserGuide/Operators-Functions/User-Defined-Function.md
+++ b/docs/zh/UserGuide/Operators-Functions/User-Defined-Function.md
@@ -525,7 +525,7 @@ SHOW FUNCTIONS
## 已知的 UDF 库实现
-+ [IoTDB-Quality](https://iotdb.apache.org/zh/UserGuide/Master/UDF-Library/Quick-Start.html )，一个关于数据质量的 UDF 库实现，包括数据画像、数据质量评估与修复等一系列函数。
++ [IoTDB-Quality](./Data-Profiling.md)，一个关于数据质量的 UDF 库实现，包括数据画像、数据质量评估与修复等一系列函数。
## Q&A