You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by hu...@apache.org on 2023/03/14 08:32:44 UTC
[iotdb] branch rel/1.0 updated: [To rel/1.0] [IOTDB-5612] [doc] Remove some functions which are not built-in from doc (#9318)
This is an automated email from the ASF dual-hosted git repository.
hui 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 acfd62b71d [To rel/1.0] [IOTDB-5612] [doc] Remove some functions which are not built-in from doc (#9318)
acfd62b71d is described below
commit acfd62b71d9aa35943b658571a1ab26d9b485b20
Author: Liao Lanyu <14...@qq.com>
AuthorDate: Tue Mar 14 16:32:36 2023 +0800
[To rel/1.0] [IOTDB-5612] [doc] Remove some functions which are not built-in from doc (#9318)
* fix
* fix
---
docs/UserGuide/Operators-Functions/String.md | 8 ++++----
docs/zh/UserGuide/Operators-Functions/Overview.md | 6 ++----
docs/zh/UserGuide/Operators-Functions/String.md | 8 ++++----
3 files changed, 10 insertions(+), 12 deletions(-)
diff --git a/docs/UserGuide/Operators-Functions/String.md b/docs/UserGuide/Operators-Functions/String.md
index d6d6ac1b09..baef2100de 100644
--- a/docs/UserGuide/Operators-Functions/String.md
+++ b/docs/UserGuide/Operators-Functions/String.md
@@ -589,7 +589,7 @@ Output series:
### Usage
-The function is used to replace the specific substring with given string.
+**This is not a built-in function and can only be used after registering the library-udf.** The function is used to replace the specific substring with given string.
**Name:** STRREPLACE
@@ -668,7 +668,7 @@ Output series:
### Usage
-The function is used to fetch matched contents from text with given regular expression.
+**This is not a built-in function and can only be used after registering the library-udf.** The function is used to fetch matched contents from text with given regular expression.
**Name:** REGEXMATCH
@@ -727,7 +727,7 @@ Output series:
### Usage
-The function is used to replace the specific regular expression matches with given string.
+**This is not a built-in function and can only be used after registering the library-udf.** The function is used to replace the specific regular expression matches with given string.
**Name:** REGEXREPLACE
@@ -786,7 +786,7 @@ Output series:
### Usage
-The function is used to split text with given regular expression and return specific element.
+**This is not a built-in function and can only be used after registering the library-udf.** The function is used to split text with given regular expression and return specific element.
**Name:** REGEXSPLIT
diff --git a/docs/zh/UserGuide/Operators-Functions/Overview.md b/docs/zh/UserGuide/Operators-Functions/Overview.md
index cdd0842688..bc50e77641 100644
--- a/docs/zh/UserGuide/Operators-Functions/Overview.md
+++ b/docs/zh/UserGuide/Operators-Functions/Overview.md
@@ -92,6 +92,8 @@ OR, |, ||
## 内置函数列表
+列表中的函数无须注册即可在 IoTDB 中使用，数据函数质量库中的函数需要参考注册步骤进行注册后才能使用。
+
### 聚合函数
| 函数名 | 功能描述 | 允许的输入类型 | 输出类型 |
@@ -161,10 +163,6 @@ OR, |, ||
| LOWER | TEXT | 无 | TEXT | 将字符串转化为小写 |
| TRIM | TEXT | 无 | TEXT | 移除字符串前后的空格 |
| STRCMP | TEXT | 无 | TEXT | 用于比较两个输入序列，如果值相同返回 `0` , 序列1的值小于序列2的值返回一个`负数`，序列1的值大于序列2的值返回一个`正数` |
-| STRREPLACE | TEXT | `target`: 需要替换的字符子串 <br/> `replace`: 替换后的字符串 <br/> `limit`: 替换次数，大于等于 -1 的整数，默认为 -1 表示所有匹配的子串都会被替换 <br/>`offset`: 需要跳过的匹配次数，即前`offset`次匹配到的字符子串并不会被替换，默认为 0 <br/>`reverse`: 是否需要反向计数，默认为 false 即按照从左向右的次序 | TEXT | 将字符串中的子串替换为指定的字符串|
-| REGEXMATCH | TEXT | `regex`: Java 标准库风格的正则表达式 <br/> `group`: 输出的匹配组序号，根据 java.util.regex 规定，第 0 组为整个正则表达式，此后的组按照左括号出现的顺序依次编号 | TEXT | 用于正则表达式匹配文本中的具体内容并返回 |
-| REGEXREPLACE | TEXT | `regex`: Java 标准库风格的正则表达式 <br/> `replace`: 替换后的字符串，支持 Java 正则表达式中的后向引用 <br/> `limit`: 替换次数，大于等于 -1 的整数，默认为 -1 表示所有匹配的子串都会被替换 <br/> `offset`: 需要跳过的匹配次数，即前`offset`次匹配到的字符子串并不会被替换，默认为 0 <br/> `reverse`: 是否需要反向计数，默认为 false 即按照从左向右的次序 | TEXT | 用于将文本中符合正则表达式的匹配结果替换为指定的字符串 |
-| REGEXSPLIT | TEXT | `regex`: Java 标准库风格的正则表达式 <br/> `index`: 输出结果在切分后数组中的序号 | TEXT | 用于使用给定的正则表达式切分文本，并返回指定的项 |
详细说明及示例见文档 [字符串处理函数](./String.md)。
diff --git a/docs/zh/UserGuide/Operators-Functions/String.md b/docs/zh/UserGuide/Operators-Functions/String.md
index 3f59900552..c1f910754d 100644
--- a/docs/zh/UserGuide/Operators-Functions/String.md
+++ b/docs/zh/UserGuide/Operators-Functions/String.md
@@ -591,7 +591,7 @@ select s1, s2, strcmp(s1, s2) from root.sg1.d1
### 函数简介
-本函数用于将文本中的子串替换为指定的字符串。
+**非内置函数，需要注册数据质量函数库后才能使用。**本函数用于将文本中的子串替换为指定的字符串。
**函数名：** STRREPLACE
@@ -669,7 +669,7 @@ select strreplace(s1, "target"=",", "replace"="/", "limit"="1", "offset"="1", "r
### 函数简介
-本函数用于正则表达式匹配文本中的具体内容并返回。
+**非内置函数，需要注册数据质量函数库后才能使用。**本函数用于正则表达式匹配文本中的具体内容并返回。
**函数名：** REGEXMATCH
@@ -726,7 +726,7 @@ select regexmatch(s1, "regex"="\d+\.\d+\.\d+\.\d+", "group"="0") from root.test.
### 函数简介
-本函数用于将文本中符合正则表达式的匹配结果替换为指定的字符串。
+**非内置函数，需要注册数据质量函数库后才能使用。**本函数用于将文本中符合正则表达式的匹配结果替换为指定的字符串。
**函数名：** REGEXREPLACE
@@ -784,7 +784,7 @@ select regexreplace(s1, "regex"="192\.168\.0\.(\d+)", "replace"="cluster-$1", "l
### 函数简介
-本函数用于使用给定的正则表达式切分文本，并返回指定的项。
+**非内置函数，需要注册数据质量函数库后才能使用。**本函数用于使用给定的正则表达式切分文本，并返回指定的项。
**函数名：** REGEXSPLIT