Merge Help document to documentation (#1586)
Help document collation (integration of help and documentation documents)
This commit is contained in:
xy720
@ -1,14 +1,13 @@
|
||||
# ascii
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`INT ascii(VARCHAR str)`
|
||||
|
||||
## Description
|
||||
|
||||
返回字符串第一个字符对应的 ascii 码
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select ascii('1');
|
||||
@ -25,3 +24,5 @@ mysql> select ascii('234');
|
||||
| 50 |
|
||||
+--------------+
|
||||
```
|
||||
##keyword
|
||||
ASCII
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# concat
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR concat(VARCHAR,...)`
|
||||
|
||||
## Description
|
||||
|
||||
将多个字符串连接起来, 如果参数中任意一个值是 NULL，那么返回的结果就是 NULL
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select concat("a", "b");
|
||||
@ -32,3 +31,5 @@ mysql> select concat("a", null, "c");
|
||||
| NULL |
|
||||
+------------------------+
|
||||
```
|
||||
##keyword
|
||||
CONCAT
|
||||
|
||||
@ -1,16 +1,15 @@
|
||||
# concat_ws
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR concat_ws(VARCHAR sep, VARCHAR str,...)`
|
||||
|
||||
## Description
|
||||
|
||||
使用第一个参数 sep 作为连接符，将第二个参数以及后续所有参数拼接成一个字符串.
|
||||
如果分隔符是 NULL，返回 NULL。
|
||||
`concat_ws`函数不会跳过空字符串，会跳过 NULL 值
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select concat_ws("or", "d", "is");
|
||||
@ -34,3 +33,5 @@ mysql> select concat_ws("or", "d", NULL,"is");
|
||||
| doris |
|
||||
+---------------------------------+
|
||||
```
|
||||
##keyword
|
||||
CONCAT_WS,CONCAT,WS
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# find_in_set
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`INT find_in_set(VARCHAR str, VARCHAR strlist)`
|
||||
|
||||
## Description
|
||||
|
||||
返回 strlist 中第一次出现 str 的位置（从1开始计数）。strlist 是用逗号分隔的字符串。如果没有找到，返回0。任意参数为 NULL ，返回 NULL。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select find_in_set("b", "a,b,c");
|
||||
@ -18,3 +17,5 @@ mysql> select find_in_set("b", "a,b,c");
|
||||
| 2 |
|
||||
+---------------------------+
|
||||
```
|
||||
##keyword
|
||||
FIND_IN_SET,FIND,IN,SET
|
||||
|
||||
@ -1,10 +1,9 @@
|
||||
# get_json_double
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`DOUBLE get_json_double(VARCHAR json_str, VARCHAR json_path)
|
||||
|
||||
## Description
|
||||
|
||||
解析并获取 json 字符串内指定路径的浮点型内容。
|
||||
其中 json_path 必须以 $ 符号作为开头，使用 . 作为路径分割符。如果路径中包含 . ，则可以使用双引号包围。
|
||||
@ -12,7 +11,7 @@
|
||||
path 的内容不能包含 ", [ 和 ]。
|
||||
如果 json_string 格式不对，或 json_path 格式不对，或无法找到匹配项，则返回 NULL。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
1. 获取 key 为 "k1" 的 value
|
||||
|
||||
@ -45,3 +44,5 @@ mysql> SELECT get_json_double('{"k1.key":{"k2":[1.1, 2.2]}}', '$."k1.key".k2[0]'
|
||||
| 1.1 |
|
||||
+---------------------------------------------------------------------+
|
||||
```
|
||||
##keyword
|
||||
GET_JSON_DOUBLE,GET,JSON,DOUBLE
|
||||
|
||||
@ -1,10 +1,9 @@
|
||||
# get_json_int
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`INT get_json_int(VARCHAR json_str, VARCHAR json_path)
|
||||
|
||||
## Description
|
||||
|
||||
解析并获取 json 字符串内指定路径的整型内容。
|
||||
其中 json_path 必须以 $ 符号作为开头，使用 . 作为路径分割符。如果路径中包含 . ，则可以使用双引号包围。
|
||||
@ -12,7 +11,7 @@
|
||||
path 的内容不能包含 ", [ 和 ]。
|
||||
如果 json_string 格式不对，或 json_path 格式不对，或无法找到匹配项，则返回 NULL。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
1. 获取 key 为 "k1" 的 value
|
||||
|
||||
@ -45,3 +44,5 @@ mysql> SELECT get_json_int('{"k1.key":{"k2":[1, 2]}}', '$."k1.key".k2[0]');
|
||||
| 1 |
|
||||
+--------------------------------------------------------------+
|
||||
```
|
||||
##keyword
|
||||
GET_JSON_INT,GET,JSON,INT
|
||||
|
||||
@ -1,10 +1,9 @@
|
||||
# get_json_string
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR get_json_string(VARCHAR json_str, VARCHAR json_path)
|
||||
|
||||
## Description
|
||||
|
||||
解析并获取 json 字符串内指定路径的字符串内容。
|
||||
其中 json_path 必须以 $ 符号作为开头，使用 . 作为路径分割符。如果路径中包含 . ，则可以使用双引号包围。
|
||||
@ -12,7 +11,7 @@
|
||||
path 的内容不能包含 ", [ 和 ]。
|
||||
如果 json_string 格式不对，或 json_path 格式不对，或无法找到匹配项，则返回 NULL。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
1. 获取 key 为 "k1" 的 value
|
||||
|
||||
@ -55,3 +54,5 @@ mysql> SELECT get_json_string('[{"k1":"v1"}, {"k2":"v2"}, {"k1":"v3"}, {"k1":"v4
|
||||
| ["v1","v3","v4"] |
|
||||
+---------------------------------------------------------------------------------+
|
||||
```
|
||||
##keyword
|
||||
GET_JSON_STRING,GET,JSON,STRING
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# group_concat
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR group_concat(VARCHAR str[, VARCHAR sep])`
|
||||
|
||||
## Description
|
||||
|
||||
该函数是类似于 sum() 的聚合函数，group_concat 将结果集中的多行结果连接成一个字符串。第二个参数 sep 为字符串之间的连接符号，该参数可以省略。该函数通常需要和 group by 语句一起使用。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select value from test;
|
||||
@ -34,3 +33,5 @@ mysql> select group_concat(value, " ") from test;
|
||||
| a b c |
|
||||
+----------------------------+
|
||||
```
|
||||
##keyword
|
||||
GROUP_CONCAT,GROUP,CONCAT
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# instr
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`INT instr(VARCHAR str, VARCHAR substr)`
|
||||
|
||||
## Description
|
||||
|
||||
返回 substr 在 str 中第一次出现的位置（从1开始计数）。如果 substr 不在 str 中出现，则返回0。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select instr("abc", "b");
|
||||
@ -25,3 +24,5 @@ mysql> select instr("abc", "d");
|
||||
| 0 |
|
||||
+-------------------+
|
||||
```
|
||||
##keyword
|
||||
INSTR
|
||||
|
||||
@ -1,10 +1,11 @@
|
||||
# lcase
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`INT lcase(VARCHAR str)`
|
||||
|
||||
## Description
|
||||
|
||||
与`lower`一致
|
||||
|
||||
##keyword
|
||||
LCASE
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# left
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR left(VARCHAR str)`
|
||||
|
||||
## Description
|
||||
|
||||
它返回具有指定长度的字符串的左边部分
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select left("Hello doris",5);
|
||||
@ -18,3 +17,5 @@ mysql> select left("Hello doris",5);
|
||||
| Hello |
|
||||
+------------------------+
|
||||
```
|
||||
##keyword
|
||||
LEFT
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# length
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`INT length(VARCHAR str)`
|
||||
|
||||
## Description
|
||||
|
||||
返回字符串的长度，对于多字节字符，返回的字符数。比如5个两字节宽度字，返回的长度是10。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select length("abc");
|
||||
@ -25,3 +24,5 @@ mysql> select length("中国");
|
||||
| 6 |
|
||||
+------------------+
|
||||
```
|
||||
##keyword
|
||||
LENGTH
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# locate
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`INT locate(VARCHAR substr, VARCHAR str[, INT pos])`
|
||||
|
||||
## Description
|
||||
|
||||
返回 substr 在 str 中出现的位置（从1开始计数）。如果指定第3个参数 pos，则从 str 以 pos 下标开始的字符串处开始查找 substr 出现的位置。如果没有找到，返回0
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> SELECT LOCATE('bar', 'foobarbar');
|
||||
@ -32,3 +31,5 @@ mysql> SELECT LOCATE('bar', 'foobarbar', 5);
|
||||
| 7 |
|
||||
+-------------------------------+
|
||||
```
|
||||
##keyword
|
||||
LOCATE
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# lower
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`INT lower(VARCHAR str)`
|
||||
|
||||
## Description
|
||||
|
||||
将参数中所有的字符串都转换成小写
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> SELECT lower("AbC123");
|
||||
@ -18,3 +17,5 @@ mysql> SELECT lower("AbC123");
|
||||
| abc123 |
|
||||
+-----------------+
|
||||
```
|
||||
##keyword
|
||||
LOWER
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# lpad
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR lpad(VARCHAR str, INT len, VARCHAR pad)`
|
||||
|
||||
## Description
|
||||
|
||||
返回 str 中长度为 len（从首字母开始算起）的字符串。如果 len 大于 str 的长度，则在 str 的前面不断补充 pad 字符，直到该字符串的长度达到 len 为止。如果 len 小于 str 的长度，该函数相当于截断 str 字符串，只返回长度为 len 的字符串。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> SELECT lpad("hi", 5, "xy");
|
||||
@ -25,3 +24,5 @@ mysql> SELECT lpad("hi", 1, "xy");
|
||||
| h |
|
||||
+---------------------+
|
||||
```
|
||||
##keyword
|
||||
LPAD
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# ltrim
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR ltrim(VARCHAR str)`
|
||||
|
||||
## Description
|
||||
|
||||
将参数 str 中从开始部分连续出现的空格去掉
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> SELECT ltrim(' ab d');
|
||||
@ -18,3 +17,5 @@ mysql> SELECT ltrim(' ab d');
|
||||
| ab d |
|
||||
+------------------+
|
||||
```
|
||||
##keyword
|
||||
LTRIM
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# money_format
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
VARCHAR money_format(Number)
|
||||
|
||||
## Description
|
||||
|
||||
将数字按照货币格式输出，整数部分每隔3位用逗号分隔，小数部分保留2位
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select money_format(17014116);
|
||||
@ -32,3 +31,5 @@ mysql> select money_format(1123.4);
|
||||
| 1,123.40 |
|
||||
+----------------------+
|
||||
```
|
||||
##keyword
|
||||
MONEY_FORMAT,MONEY,FORMAT
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# regexp_extract
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR regexp_extract(VARCHAR str, VARCHAR pattern, int pos)`
|
||||
|
||||
## Description
|
||||
|
||||
对字符串 str 进行正则匹配，抽取符合 pattern 的第 pos 个匹配部分。需要 pattern 完全匹配 str 中的某部分，这样才能返回 pattern 部分中需匹配部分。如果没有匹配，返回空字符串。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> SELECT regexp_extract('AbCdE', '([[:lower:]]+)C([[:lower:]]+)', 1);
|
||||
@ -25,3 +24,5 @@ mysql> SELECT regexp_extract('AbCdE', '([[:lower:]]+)C([[:lower:]]+)', 2);
|
||||
| d |
|
||||
+-------------------------------------------------------------+
|
||||
```
|
||||
##keyword
|
||||
REGEXP_EXTRACT,REGEXP,EXTRACT
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# regexp_replace
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR regexp_replace(VARCHAR str, VARCHAR pattern, VARCHAR repl)
|
||||
|
||||
## Description
|
||||
|
||||
对字符串 str 进行正则匹配, 将命中 pattern 的部分使用 repl 来进行替换
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> SELECT regexp_replace('a b c', " ", "-");
|
||||
@ -25,3 +24,5 @@ mysql> SELECT regexp_replace('a b c','(b)','<\\1>');
|
||||
| a <b> c |
|
||||
+----------------------------------------+
|
||||
```
|
||||
##keyword
|
||||
REGEXP_REPLACE,REGEXP,REPLACE
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# repeat
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR repeat(VARCHAR str, INT count)
|
||||
|
||||
## Description
|
||||
|
||||
将字符串 str 重复 count 次输出，count 小于1时返回空串，str，count 任一为NULL时，返回 NULL
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> SELECT repeat("a", 3);
|
||||
@ -25,3 +24,5 @@ mysql> SELECT repeat("a", -1);
|
||||
| |
|
||||
+-----------------+
|
||||
```
|
||||
##keyword
|
||||
REPEAT,
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# right
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR right(VARCHAR str)`
|
||||
|
||||
## Description
|
||||
|
||||
它返回具有指定长度的字符串的右边部分
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select right("Hello doris",5);
|
||||
@ -18,3 +17,5 @@ mysql> select right("Hello doris",5);
|
||||
| doris |
|
||||
+-------------------------+
|
||||
```
|
||||
##keyword
|
||||
RIGHT
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# split_part
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR split_part(VARCHAR content, VARCHAR delimiter, INT field)`
|
||||
|
||||
## Description
|
||||
|
||||
根据分割符拆分字符串, 返回指定的分割部分(从一开始计数)。
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select split_part("hello world", " ", 1);
|
||||
@ -40,3 +39,5 @@ mysql> select split_part("abca", "a", 1);
|
||||
| |
|
||||
+----------------------------+
|
||||
```
|
||||
##keyword
|
||||
SPLIT_PART,SPLIT,PART
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# strleft
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR strleft(VARCHAR str)`
|
||||
|
||||
## Description
|
||||
|
||||
它返回具有指定长度的字符串的左边部分
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select strleft("Hello doris",5);
|
||||
@ -18,3 +17,5 @@ mysql> select strleft("Hello doris",5);
|
||||
| Hello |
|
||||
+------------------------+
|
||||
```
|
||||
##keyword
|
||||
STRLEFT
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
# strright
|
||||
|
||||
## Syntax
|
||||
## description
|
||||
### Syntax
|
||||
|
||||
`VARCHAR strright(VARCHAR str)`
|
||||
|
||||
## Description
|
||||
|
||||
它返回具有指定长度的字符串的右边部分
|
||||
|
||||
## Examples
|
||||
## example
|
||||
|
||||
```
|
||||
mysql> select strright("Hello doris",5);
|
||||
@ -18,3 +17,5 @@ mysql> select strright("Hello doris",5);
|
||||
| doris |
|
||||
+-------------------------+
|
||||
```
|
||||
##keyword
|
||||
STRRIGHT
|
||||
|
||||
Reference in New Issue
Block a user