[opt](reference) update some json and string function docs #1891

cool-joker · 2025-01-21T10:04:23Z

Versions

dev
3.0
2.1
2.0

Languages

Chinese
English

Docs Checklist

Checked by AI
Test Cases Built

…oris-website into shenxiaohu-jira_new

morrySnow

只评论了dev 英文版。其他版本也对应修改一下

docs/sql-manual/sql-functions/scalar-functions/json-functions/get-json-double.md

docs/sql-manual/sql-functions/scalar-functions/json-functions/get-json-string.md

docs/sql-manual/sql-functions/scalar-functions/json-functions/json-contains.md

morrySnow · 2025-01-21T13:37:15Z

docs/sql-manual/sql-functions/scalar-functions/json-functions/json-contains.md

+
+```sql
+
+SET @j = '{"a": 1, "b": 2, "c": {"d": 4}}';


例子中最好不要使用变量，前后的例子最好不要有依赖关系

morrySnow · 2025-01-21T13:43:58Z

docs/sql-manual/sql-functions/scalar-functions/json-functions/json-type.md


 ```sql
-STRING json_type(JSON j, VARCHAR json_path)
+STRING JSON_TYPE( <JSON j> )


Suggested change

STRING JSON_TYPE( <JSON j> )

STRING JSON_TYPE( <json> )

morrySnow · 2025-01-21T13:44:22Z

docs/sql-manual/sql-functions/scalar-functions/json-functions/json-type.md


 ```sql
-STRING json_type(JSON j, VARCHAR json_path)


json_path 被去掉了，是其实不支持？

morrySnow · 2025-01-21T13:44:32Z

docs/sql-manual/sql-functions/scalar-functions/json-functions/json-type.md

+
+| Parameter | Description |
+|------|------|
+| `<JSON j>` | The JSON string to check the type of. |


morrySnow · 2025-01-21T13:44:55Z

docs/sql-manual/sql-functions/scalar-functions/json-functions/json-valid.md


-`JSONB json_valid(VARCHAR json_str)`
+```sql
+JSONB JSON_VALID( <str> )


Suggested change

JSONB JSON_VALID( <str> )

JSON_VALID( <str> )

morrySnow · 2025-01-21T13:45:37Z

docs/sql-manual/sql-functions/scalar-functions/string-functions/ucase.md


+- upper


Suggested change

- upper

- UPPER

…oris-website into shenxiaohu-jira_new

morrySnow · 2025-01-22T06:52:12Z

...content-docs/current/sql-manual/sql-functions/scalar-functions/json-functions/json-length.md

@@ -30,7 +30,9 @@ under the License.

 ## 语法

-`JSON_LENGTH(JSON <json_str>,  <json_path>)`
+```sql
+JSON_LENGTH(JSON <json_str> [ , <json_path>])


参数不要带类型

Suggested change

JSON_LENGTH(JSON <json_str> [ , <json_path>])

JSON_LENGTH(<json_str> [ , <json_path>])

morrySnow · 2025-01-22T06:52:26Z

...n-content-docs/current/sql-manual/sql-functions/scalar-functions/json-functions/json-type.md

@@ -43,7 +43,7 @@ under the License.
 ## 语法

 ```sql
-STRING JSON_TYPE( <JSON j> )
+STRING JSON_TYPE( <JSON> )


参数用小写

Suggested change

STRING JSON_TYPE( <JSON> )

STRING JSON_TYPE( <json> )

…oris-website into shenxiaohu-jira_new

morrySnow

几个共性问题，麻烦检查一下所有文档

语法中参数未用尖括号报错
部分文档缺少参数章节
示例中，查询和结果要放入两个 code block 中，查询使用 sql 格式，结果使用 text 格式

morrySnow · 2025-01-23T03:37:34Z

...rent/sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY.md

 ```sql
-ALTER STORAGE POLICY  'policy_name'
-PROPERTIES ("key"="value", ...);
+ALTER STORAGE POLICY  'policy_name' PROPERTIES ("key"="value", ...);


参数需要尖括号包裹

变长参数部分，应该用方括号包裹

Suggested change

ALTER STORAGE POLICY 'policy_name' PROPERTIES ("key"="value", ...);

ALTER STORAGE POLICY "<policy_name>" PROPERTIES ("<key>"="<value>" [, ... ]);

morrySnow · 2025-01-23T03:38:16Z

...rent/sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY.md

 ```sql
-ALTER STORAGE POLICY  'policy_name'
-PROPERTIES ("key"="value", ...);
+ALTER STORAGE POLICY  'policy_name' PROPERTIES ("key"="value", ...);
 ```



缺少参数描述部分

morrySnow · 2025-01-23T03:38:38Z

...rent/sql-manual/sql-statements/cluster-management/storage-management/CREATE-STORAGE-VAULT.md

 ## 描述

 该命令用于创建存储库。本文档的主题描述了创建 Doris 自管理存储库的语法。

+
+## 语法
+
 ```sql
 CREATE STORAGE VAULT [IF NOT EXISTS] vault
 [properties]


Suggested change

[properties]

[ <properties> ]

morrySnow · 2025-01-23T03:40:00Z

...rent/sql-manual/sql-statements/cluster-management/storage-management/CREATE-STORAGE-VAULT.md

 ```sql
 CREATE STORAGE VAULT [IF NOT EXISTS] vault
 [properties]
 ```

-#### properties
+## 参数

 | 参数     | 是否必需 | 描述                     |
 |:-------|:-----|:-----------------------|


这是参数 properties 的 key 的可选范围。
参数需要先写 <properties>，介绍 properties 的用处。
然后再介绍 properties 时，再用另外一个表格介绍 properties 的 key 都的可选范围。

morrySnow · 2025-01-23T03:40:49Z

...sql-manual/sql-statements/cluster-management/storage-management/SET-DEFAULT-STORAGE-VAULT.md

@@ -34,8 +34,7 @@ under the License.
 SET vault_name DEFAULT STORAGE VAULT


Suggested change

SET vault_name DEFAULT STORAGE VAULT

SET <vault_name> DEFAULT STORAGE VAULT

morrySnow · 2025-01-23T03:42:30Z

...urrent/sql-manual/sql-statements/cluster-management/storage-management/SHOW-CACHE-HOTSPOT.md

@@ -36,26 +36,20 @@ under the License.



语法中的参数需要尖括号包裹

SHOW CACHE HOTSPOT '/[<compute_group_name>/<table_name>]';

morrySnow · 2025-01-23T03:42:57Z

...urrent/sql-manual/sql-statements/cluster-management/storage-management/SHOW-CACHE-HOTSPOT.md

+| compute_group_name        | 计算组的名称。                                               |
+| table_name                | 表的名称。                                                   |


morrySnow · 2025-01-23T03:43:11Z

...sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md

@@ -30,7 +30,7 @@ under the License.

 查看所有/指定存储策略关联的表和分区

-语法：
+## 语法

 ```sql
 SHOW STORAGE POLICY USING [FOR some_policy]


Suggested change

SHOW STORAGE POLICY USING [FOR some_policy]

SHOW STORAGE POLICY USING [FOR <some_policy>]

morrySnow · 2025-01-23T03:43:47Z

...sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md

@@ -30,7 +30,7 @@ under the License.

 查看所有/指定存储策略关联的表和分区

-语法：
+## 语法

 ```sql
 SHOW STORAGE POLICY USING [FOR some_policy]


缺少参数章节

morrySnow · 2025-01-23T03:44:04Z

...sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md

@@ -40,7 +40,7 @@ SHOW STORAGE POLICY USING [FOR some_policy]

 1. 查看所有启用了存储策略的对象
   ```sql
-   mysql> show storage policy using;
+   show storage policy using;


查询和结果要放到两个 code block 中

cool-joker added 13 commits January 17, 2025 18:52

string-function_dev

bdbc6eb

string_function_dev_2

e08c0a0

tstring_function_dev_3

41591c5

string_function_total

0cf619e

Merge branch 'apache:master' into shenxiaohu-jira_new

9678e5b

string_function_total_2

5c328cb

Merge branch 'shenxiaohu-jira_new' of https://github.com/cool-joker/d…

5e0ebf3

…oris-website into shenxiaohu-jira_new

json_function_part2_zh

3471dd7

json_function_en_dev

f418b0a

json_function_en_3.0

9f4fc93

josn_function_en_2.1

02cc51d

changes_fix_new_0121

99701b1

Merge branch 'shenxiaohu-jira_new' of https://github.com/cool-joker/d…

9aa1f52

…oris-website into shenxiaohu-jira_new

cool-joker temporarily deployed to Production January 21, 2025 10:05 — with GitHub Actions Inactive

KassieZ requested a review from morrySnow January 21, 2025 10:06

KassieZ added the request review label Jan 21, 2025

morrySnow changed the title ~~Shenxiaohu jira new~~ [opt](reference) update json function docs Jan 21, 2025

morrySnow changed the title ~~[opt](reference) update json function docs~~ [opt](reference) update some json and string function docs Jan 21, 2025

morrySnow reviewed Jan 21, 2025

View reviewed changes

cool-joker added 2 commits January 22, 2025 14:20

en_fix

d7a66f6

Merge branch 'apache:master' into shenxiaohu-jira_new

b2604e5

KassieZ requested a review from morrySnow January 22, 2025 06:24

zh_fix

a1403b7

morrySnow approved these changes Jan 22, 2025

View reviewed changes

Merge branch 'shenxiaohu-jira_new' of https://github.com/cool-joker/d…

8ed2bc2

…oris-website into shenxiaohu-jira_new

morrySnow requested a review from KassieZ January 22, 2025 06:50

morrySnow reviewed Jan 22, 2025

View reviewed changes

morrySnow self-requested a review January 22, 2025 06:52

cool-joker temporarily deployed to Production January 23, 2025 02:42 — with GitHub Actions Inactive

Refresh cluster management_dev&3.0

4a8b326

cool-joker added 3 commits January 23, 2025 11:28

Merge branch 'apache:master' into shenxiaohu-jira_new

ef77238

zh_fix_parameters

2aed7b5

Merge branch 'shenxiaohu-jira_new' of https://github.com/cool-joker/d…

9ea3af7

…oris-website into shenxiaohu-jira_new

morrySnow reviewed Jan 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[opt](reference) update some json and string function docs #1891

[opt](reference) update some json and string function docs #1891

cool-joker commented Jan 21, 2025

morrySnow left a comment

morrySnow Jan 21, 2025

morrySnow Jan 21, 2025

morrySnow Jan 21, 2025

morrySnow Jan 21, 2025

morrySnow Jan 21, 2025

morrySnow Jan 21, 2025

morrySnow Jan 22, 2025

morrySnow Jan 22, 2025

morrySnow left a comment

morrySnow Jan 23, 2025

morrySnow Jan 23, 2025

morrySnow Jan 23, 2025

morrySnow Jan 23, 2025

morrySnow Jan 23, 2025

morrySnow Jan 23, 2025

morrySnow Jan 23, 2025

morrySnow Jan 23, 2025

morrySnow Jan 23, 2025

morrySnow Jan 23, 2025

	\| `<JSON j>` \| The JSON string to check the type of. \|
	\| `<json>` \| The JSON string to check the type of. \|

	JSON_LENGTH(JSON <json_str> [ , <json_path>])
	JSON_LENGTH(<json_str> [ , <json_path>])

	ALTER STORAGE POLICY 'policy_name' PROPERTIES ("key"="value", ...);
	ALTER STORAGE POLICY "<policy_name>" PROPERTIES ("<key>"="<value>" [, ... ]);

		@@ -34,8 +34,7 @@ under the License.
		SET vault_name DEFAULT STORAGE VAULT

	SET vault_name DEFAULT STORAGE VAULT
	SET <vault_name> DEFAULT STORAGE VAULT

		\| compute_group_name \| 计算组的名称。 \|
		\| table_name \| 表的名称。 \|

	SHOW STORAGE POLICY USING [FOR some_policy]
	SHOW STORAGE POLICY USING [FOR <some_policy>]

[opt](reference) update some json and string function docs #1891

Are you sure you want to change the base?

[opt](reference) update some json and string function docs #1891

Conversation

cool-joker commented Jan 21, 2025

Versions

Languages

Docs Checklist

morrySnow left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morrySnow left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment