Skip to content

Commit 19a3e39

Browse files
authored
[fix] correct cluster-management, data-governance, load/query/database/function statement doc errors (#3716)
## Summary Fixes 25 small documentation issues across cluster-management, data-governance, DML, load-and-export, data-query, database, and function SQL-statement docs. Each item below is independent. ### cluster-management - **MODIFY-BACKEND.md** — table headers `属性` / `影响` were Chinese in the English doc; replaced with `Property` / `Effect`. - **MODIFY-FRONTEND-HOSTNAME.md** — typo `NOD_PRIV` → `NODE_PRIV`. - **ADD-FOLLOWER.md / ADD-OBSERVER.md / DROP-FOLLOWER.md / DROP-OBSERVER.md** — a usage note read `use[\`SHOW FRONTENDS\`](./SHOW-FRONTENDS.md)command` with no spaces around the markdown link; DROP-FOLLOWER also dropped the verb "use". Rewritten with proper spacing. - **DROP-BROKER.md** — SQL example ended with `.` instead of `;`. - **ALTER-STORAGE-POLICY.md** — typo `PROPERTIE` → `PROPERTIES` in the syntax block and the inline reference. - **ALTER-STORAGE-VAULT.md** — text said the listed hdfs property fields were "prohibited"; corrected to "allowed" (the list describes properties the user *may* set). - **CREATE-STORAGE-POLICY.md** — SQL syntax contained full-width `,` and `|` characters; replaced with ASCII. - **CANCEL-WARM-UP.md** — syntax requires the `JOB` keyword but the example omitted it; example aligned with syntax. - **SHOW-CACHE-HOTSPOT.md** — a `:::info` admonition was unclosed (no `:::` before the next `## Syntax`). ### data-governance - **CREATE-ROW-POLICY.md** — frontmatter `description` and the body Description paragraph said "Explain can view the rewritten execution plan." (a leftover from the EXPLAIN doc); rewritten to actually describe row policies. - **CREATE-ROW-POLICY.md** — two example `CREATE ROW POLICY` statements used the same name `test_row_policy_3`; renamed the second to `test_row_policy_4`. - **CREATE-SQL_BLOCK_RULE.md** — example creates rule `test_rule`, but the simulated error message echoed `order_analysis_rule`; corrected. - **SHOW-SQL_BLOCK_RULE.md** — stray `|` at the end of a parameter-description line; two result tables also had misaligned borders. ### DML / load-and-export / data-query / database / function - **MERGE-INTO.md** — heading `### Duplicate join behavior¶` ended with a stray pilcrow `¶`; removed. - **SHOW-LAST-INSERT.md** — keywords line `SHOW, LASR ,INSERT` typo corrected to `SHOW, LAST, INSERT`. Informal section markers `grammar:` / `illustrate:` replaced with canonical `## Syntax` / `## Return Value` headings. - **CREATE-ROUTINE-LOAD.md** — a frontmatter link pointed at a non-existent anchor `#Example-of-importing-Json-format-data`; corrected to the actual anchor in each version (`#import-examples` for current / 3.x / 4.x; `#load-example` for 2.1). Frontmatter `description` was truncated mid-sentence; completed. - **ALTER-ROUTINE-LOAD.md / PAUSE-ROUTINE-LOAD.md / RESUME-ROUTINE-LOAD.md / STOP-ROUTINE-LOAD.md / SHOW-CREATE-ROUTINE-LOAD.md** — each file's access-control note read "SHOW ROUTINE LOAD requires…" regardless of the actual statement. Replaced with the matching statement name in each file. - **CANCEL-LOAD.md** — STATE parameter list included `FINISHED` / `CANCELLED`, but the syntax + notes only allow `PENDING` / `ETL` / `LOADING`; removed the invalid values. An example used `LABEL like "example_"` which, without `%`, doesn't match anything containing `example_`; changed to `"%example_%"` to match the prose intent. - **SHOW-LOAD.md** — prose said `LOAD = "PENDING"` where it should say `STATE = "PENDING"`. - **SELECT.md** — typo `JOIN Exampel` → `JOIN Example`; truncated `ome additional knowledge` → `Some additional knowledge`; invalid SQL `ORDER by LIMIT 10` → `ORDER BY a LIMIT 10`; renumbered a duplicated list item `2.`. - **SHOW-DATABASES.md** — Chinese heading `## 示例` in the English doc → `## Examples`. - **SHOW-DATABASE-ID.md** — `### Description` (h3) → `## Description` (h2), matching the convention used by sibling docs. - **DROP-FUNCTION.md** — syntax `DROP [ GLOBAL ] <function_name>(...)` was missing the `FUNCTION` keyword. ## Test plan - [ ] CI doc build passes - [ ] Spot-check the affected pages render correctly (Chinese → English headers, link spacing, fixed SQL examples, completed descriptions, h2 headings, FUNCTION keyword in DROP syntax)
1 parent 6f14c26 commit 19a3e39

110 files changed

Lines changed: 202 additions & 202 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The user executing this SQL command must have at least the following permissions
3838

3939
1. Before adding a new FOLLOWER node, make sure the node is properly configured.
4040
2. Before adding a FOLLOWER node, ensure that the number of FOLLOWER nodes in the cluster is an odd number after the addition.
41-
3. After adding the FOLLOWER node, use[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they have been added successfully and are in a normal state.
41+
3. After adding the FOLLOWER node, use the [`SHOW FRONTENDS`](./SHOW-FRONTENDS.md) command to verify that they have been added successfully and are in a normal state.
4242

4343
## Examples
4444

docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The user executing this SQL command must have at least the following permissions
3737
## Usage Notes
3838

3939
1. Before adding a new OBSERVER node, make sure the node is properly configured.
40-
2. After adding the OBSERVER node, use[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they have been added successfully and are in a normal state.
40+
2. After adding the OBSERVER node, use the [`SHOW FRONTENDS`](./SHOW-FRONTENDS.md) command to verify that they have been added successfully and are in a normal state.
4141

4242
## Examples
4343

docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The user who executes this operation needs to have the NODE_PRIV permission.
4343
1. Delete all Brokers
4444

4545
```sql
46-
ALTER SYSTEM DROP ALL BROKER broker_name.
46+
ALTER SYSTEM DROP ALL BROKER broker_name;
4747
```
4848

4949
2. Delete a specific Broker node

docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The user executing this SQL command must have at least the following permissions
3838

3939
1. Before deleting a FOLLOWER node, make sure that the node that needs to be taken offline is not a Master node.
4040
2. Before deleting a FOLLOWER node, ensure that the number of FOLLOWER nodes in the cluster is an odd number after they go offline.
41-
3. After deleting the FOLLOWER node[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they were successfully deleted.
41+
3. After deleting the FOLLOWER node, use the [`SHOW FRONTENDS`](./SHOW-FRONTENDS.md) command to verify that they were successfully deleted.
4242

4343
## Examples
4444

docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The user executing this SQL command must have at least the following permissions
3636

3737
## Usage Notes
3838

39-
1. After deleting the OBSERVER node, use[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they were successfully deleted.
39+
1. After deleting the OBSERVER node, use the [`SHOW FRONTENDS`](./SHOW-FRONTENDS.md) command to verify that they were successfully deleted.
4040

4141
## Examples
4242

docs/sql-manual/sql-statements/cluster-management/instance-management/MODIFY-BACKEND.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
This statement is used to modify the attributes of BE nodes. After modifying the attributes of BE nodes, it will affect the query, write, and data distribution of the current node. The following are the attributes that can be modified:
1212

13-
| 属性 | 影响 |
13+
| Property | Effect |
1414
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1515
| `tag.location` | The resource tag of the BE, with the `default` value being default. After modification, it will affect the data balancing of BEs within the same tag group and the BE nodes for data distribution during table creation. For more information, please refer to[Resource Group](../../../../admin-manual/workload-management/resource-group.md) |
1616
| `disable_query` | Whether to disable queries, with the default value being `false`. After setting it to `true`, no new query requests will be scheduled to this BE node. |

docs/sql-manual/sql-statements/cluster-management/instance-management/MODIFY-FRONTEND-HOSTNAME.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ALTER SYSTEM MODIFY FRONTEND "<frontend_hostname_port>" HOSTNAME "<frontend_new_
2929
3030
## Access Control Requirements
3131

32-
The user executing this SQL command must have at least NOD_PRIV permissions.
32+
The user executing this SQL command must have at least NODE_PRIV permissions.
3333

3434
## Examples
3535

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This statement is used to modify an existing hot-cold tiered migration policy. O
1212

1313
## Syntax
1414
```sql
15-
ALTER STORAGE POLICY '<policy_name>' PROPERTIE ("<key>"="<value>"[, ... ]);
15+
ALTER STORAGE POLICY '<policy_name>' PROPERTIES ("<key>"="<value>"[, ... ]);
1616
```
1717

1818
## Required Parameters
@@ -22,7 +22,7 @@ ALTER STORAGE POLICY '<policy_name>' PROPERTIE ("<key>"="<value>"[, ... ]);
2222
> The name of the storage policy. This is the unique identifier of the storage policy you want to modify, and an existing policy name must be specified.
2323
2424
## Optional Parameters
25-
`PROPERTIE ("<key>"="<value>"[, ... ])`
25+
`PROPERTIES ("<key>"="<value>"[, ... ])`
2626

2727
1.`retention_days`
2828
> Data retention period. Defines the duration for which the data is kept in storage. Data exceeding this period will be automatically deleted.

docs/sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-VAULT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ PROPERTIES (<storage_vault_property>)
3030
>- vault_name: The name of the vault. When a vault is set as the default storage vault using the statement `SET <original_vault_name> DEFAULT STORAGE VAULT`, its name cannot be modified. To rename the vault, you must first unset the default storage vault by executing the `UNSET DEFAULT STORAGE VAULT` command, and then modify its name. Finally, if you need to set the renamed vault as the default storage vault, you can use the statement `SET <new_vault_name> DEFAULT STORAGE VAULT`.
3131
>- use_path_style: Whether to allow path style url, optional values are true, false. The default value is false.
3232
33-
>When type is hdfs, the following fields are prohibited:
33+
>When type is hdfs, the allowed property fields are as follows:
3434
>
3535
>- path_prefix: Storage path prefix
3636
>- fs.defaultFS: hdfs name

docs/sql-manual/sql-statements/cluster-management/storage-management/CANCEL-WARM-UP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Its result is:
4444
Then terminate it through `CANCEL WARM UP`:
4545

4646
```C++
47-
CANCEL WARM UP WHERE id = 90290165739458;
47+
CANCEL WARM UP JOB WHERE id = 90290165739458;
4848
```
4949

5050
If the following content is returned, it indicates that the warm-up job corresponding to the specified id does not exist:

0 commit comments

Comments
 (0)