Skip to content

Commit 65e6cd6

Browse files
BohuTANGBohuTANG
committed
docs: simplify warehouse quoting and self-hosted refs
1 parent f7a57a5 commit 65e6cd6

File tree

12 files changed

+33
-171
lines changed

12 files changed

+33
-171
lines changed

‎docs/cn/guides/20-self-hosted/04-references/warehouse-sql-commands.md‎

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 计算集群 SQL 命令
33
---
44

5-
本页介绍在自建部署中启用系统管理（system-managed）资源管理后，可用于管理计算集群的 SQL 命令。
5+
本页列出在自建部署中启用系统管理（system-managed）资源管理后，可用于管理计算集群的 SQL 命令。
66

77
## SHOW ONLINE NODES
88

@@ -18,71 +18,36 @@ SHOW ONLINE NODES;
1818

1919
## CREATE WAREHOUSE
2020

21-
创建计算集群：可以指定节点数量，也可以从节点组分配节点。
21+
通过指定节点数量创建系统管理的计算集群。
2222

2323
```sql
24-
-- 通过节点数量创建
2524
CREATE WAREHOUSE <warehouse_name>
2625
WITH warehouse_size = <node_count>
27-
28-
-- 通过分配节点创建
29-
CREATE WAREHOUSE <warehouse_name>
30-
(ASSIGN <node_count> NODES [FROM <node_group>] [, ASSIGN <node_count> NODES [FROM <node_group>] ... ])
3126
```
3227

3328
```sql
3429
CREATE WAREHOUSE wh1 WITH warehouse_size = 2;
3530
```
3631

37-
```sql
38-
CREATE WAREHOUSE wh2 (ASSIGN 1 NODES FROM group_a, ASSIGN 1 NODES);
39-
```
40-
4132
## ALTER WAREHOUSE
4233

43-
用于管理计算集群中的集群（cluster）与节点。
34+
用于管理计算集群中的集群（cluster）。
4435

4536
```sql
4637
ALTER WAREHOUSE <warehouse_name>
4738
ADD CLUSTER <cluster_name> WITH CLUSTER_SIZE = <node_count>
4839

49-
ALTER WAREHOUSE <warehouse_name>
50-
ADD CLUSTER <cluster_name>
51-
(ASSIGN <node_count> NODES [FROM <node_group>] [, ASSIGN <node_count> NODES [FROM <node_group>] ... ])
52-
5340
ALTER WAREHOUSE <warehouse_name>
5441
RENAME CLUSTER <old_cluster_name> TO <new_cluster_name>
5542

5643
ALTER WAREHOUSE <warehouse_name>
5744
DROP CLUSTER <cluster_name>
58-
59-
ALTER WAREHOUSE <warehouse_name>
60-
ASSIGN NODES (ASSIGN <node_count> NODES [FROM <node_group>] FOR <cluster_name> [, ...])
61-
62-
ALTER WAREHOUSE <warehouse_name>
63-
UNASSIGN NODES (UNASSIGN <node_count> NODES [FROM <node_group>] FOR <cluster_name> [, ...])
6445
```
6546

6647
```sql
6748
ALTER WAREHOUSE wh1 ADD CLUSTER c1 WITH CLUSTER_SIZE = 2;
6849
```
6950

70-
```sql
71-
ALTER WAREHOUSE wh1 ASSIGN NODES (ASSIGN 1 NODES FOR default);
72-
```
73-
74-
## USE WAREHOUSE
75-
76-
设置当前会话使用的计算集群。
77-
78-
```sql
79-
USE WAREHOUSE <warehouse_name>
80-
```
81-
82-
```sql
83-
USE WAREHOUSE wh1;
84-
```
85-
8651
## RENAME WAREHOUSE
8752

8853
重命名计算集群。
@@ -119,14 +84,7 @@ RESUME WAREHOUSE <warehouse_name>
11984
RESUME WAREHOUSE wh1;
12085
```
12186

122-
## DROP WAREHOUSE
123-
124-
删除计算集群。
87+
## 另请参阅
12588

126-
```sql
127-
DROP WAREHOUSE <warehouse_name>
128-
```
129-
130-
```sql
131-
DROP WAREHOUSE wh1;
132-
```
89+
- [USE WAREHOUSE](/sql/sql-commands/ddl/warehouse/use-warehouse)
90+
- [DROP WAREHOUSE](/sql/sql-commands/ddl/warehouse/drop-warehouse)

‎docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,14 @@ import FunctionDescription from '@site/src/components/FunctionDescription';
1111
## 语法
1212

1313
```sql
14-
CREATE WAREHOUSE <warehouse_name>
15-
WITH WAREHOUSE_SIZE = { XSMALL | SMALL | MEDIUM | LARGE | XLARGE | XXLARGE | XXXLARGE }
14+
CREATE WAREHOUSE '<warehouse_name>'
15+
WITH WAREHOUSE_SIZE = '<warehouse_size>'
1616
```
1717

18-
提示：如果 `<warehouse_name>` 包含 `-`，请用引号包裹，例如：`'name-with-hyphen'`、`` `name-with-hyphen` `` 或 `"name-with-hyphen"`。
18+
说明：
19+
20+
- `<warehouse_name>` 只能包含英文字母、数字和 `-`。建议统一使用单引号包裹。
21+
- `<warehouse_size>` 不区分大小写，可选值为：`XSMALL`、`SMALL`、`MEDIUM`、`LARGE`、`XLARGE`、`XXLARGE`、`XXXLARGE`。建议统一使用单引号包裹。
1922

2023
## 示例
2124

‎docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ import FunctionDescription from '@site/src/components/FunctionDescription';
1010
## 语法
1111

1212
```sql
13-
DROP WAREHOUSE <warehouse_name>
13+
DROP WAREHOUSE '<warehouse_name>'
1414
```
1515

16-
提示：如果 `<warehouse_name>` 包含 `-`，请用引号包裹，例如：`'name-with-hyphen'`、`` `name-with-hyphen` `` 或 `"name-with-hyphen"`。
16+
建议统一使用单引号包裹 `<warehouse_name>`。
1717

1818
## 示例
1919

‎docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ import FunctionDescription from '@site/src/components/FunctionDescription';
1010
## 语法
1111

1212
```sql
13-
USE WAREHOUSE <warehouse_name>
13+
USE WAREHOUSE '<warehouse_name>'
1414
```
1515

16-
提示：如果 `<warehouse_name>` 包含 `-`，请用引号包裹，例如：`'name-with-hyphen'`、`` `name-with-hyphen` `` 或 `"name-with-hyphen"`。
16+
建议统一使用单引号包裹 `<warehouse_name>`。
1717

1818
## 示例
1919

‎docs/en/guides/20-self-hosted/04-references/warehouse-sql-commands.md‎

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Warehouse SQL Commands
33
---
44

5-
This page documents warehouse-related SQL commands for self-hosted deployments that use system-managed resources management.
5+
This page lists warehouse-related SQL commands for self-hosted deployments with system-managed resources management enabled.
66

77
## SHOW ONLINE NODES
88

@@ -18,71 +18,36 @@ SHOW ONLINE NODES;
1818

1919
## CREATE WAREHOUSE
2020

21-
Creates a warehouse by either specifying the number of nodes, or assigning nodes from node groups.
21+
Creates a system-managed warehouse by specifying the number of nodes.
2222

2323
```sql
24-
-- Create a warehouse with a node count
2524
CREATE WAREHOUSE <warehouse_name>
2625
WITH warehouse_size = <node_count>
27-
28-
-- Create a warehouse by assigning nodes
29-
CREATE WAREHOUSE <warehouse_name>
30-
(ASSIGN <node_count> NODES [FROM <node_group>] [, ASSIGN <node_count> NODES [FROM <node_group>] ... ])
3126
```
3227

3328
```sql
3429
CREATE WAREHOUSE wh1 WITH warehouse_size = 2;
3530
```
3631

37-
```sql
38-
CREATE WAREHOUSE wh2 (ASSIGN 1 NODES FROM group_a, ASSIGN 1 NODES);
39-
```
40-
4132
## ALTER WAREHOUSE
4233

43-
Manages clusters and nodes in a warehouse.
34+
Manages clusters in a warehouse.
4435

4536
```sql
4637
ALTER WAREHOUSE <warehouse_name>
4738
ADD CLUSTER <cluster_name> WITH CLUSTER_SIZE = <node_count>
4839

49-
ALTER WAREHOUSE <warehouse_name>
50-
ADD CLUSTER <cluster_name>
51-
(ASSIGN <node_count> NODES [FROM <node_group>] [, ASSIGN <node_count> NODES [FROM <node_group>] ... ])
52-
5340
ALTER WAREHOUSE <warehouse_name>
5441
RENAME CLUSTER <old_cluster_name> TO <new_cluster_name>
5542

5643
ALTER WAREHOUSE <warehouse_name>
5744
DROP CLUSTER <cluster_name>
58-
59-
ALTER WAREHOUSE <warehouse_name>
60-
ASSIGN NODES (ASSIGN <node_count> NODES [FROM <node_group>] FOR <cluster_name> [, ...])
61-
62-
ALTER WAREHOUSE <warehouse_name>
63-
UNASSIGN NODES (UNASSIGN <node_count> NODES [FROM <node_group>] FOR <cluster_name> [, ...])
6445
```
6546

6647
```sql
6748
ALTER WAREHOUSE wh1 ADD CLUSTER c1 WITH CLUSTER_SIZE = 2;
6849
```
6950

70-
```sql
71-
ALTER WAREHOUSE wh1 ASSIGN NODES (ASSIGN 1 NODES FOR default);
72-
```
73-
74-
## USE WAREHOUSE
75-
76-
Sets the current warehouse for the session.
77-
78-
```sql
79-
USE WAREHOUSE <warehouse_name>
80-
```
81-
82-
```sql
83-
USE WAREHOUSE wh1;
84-
```
85-
8651
## RENAME WAREHOUSE
8752

8853
Renames a warehouse.
@@ -119,14 +84,7 @@ RESUME WAREHOUSE <warehouse_name>
11984
RESUME WAREHOUSE wh1;
12085
```
12186

122-
## DROP WAREHOUSE
123-
124-
Drops a warehouse.
87+
## See Also
12588

126-
```sql
127-
DROP WAREHOUSE <warehouse_name>
128-
```
129-
130-
```sql
131-
DROP WAREHOUSE wh1;
132-
```
89+
- [USE WAREHOUSE](/sql/sql-commands/ddl/warehouse/use-warehouse)
90+
- [DROP WAREHOUSE](/sql/sql-commands/ddl/warehouse/drop-warehouse)

‎docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,19 @@ import FunctionDescription from '@site/src/components/FunctionDescription';
66

77
<FunctionDescription description="Introduced or updated: v1.2.687"/>
88

9-
Creates a warehouse with specified size.
9+
Creates a warehouse.
1010

1111
## Syntax
1212

1313
```sql
14-
CREATE WAREHOUSE <warehouse_name>
15-
WITH WAREHOUSE_SIZE = { XSMALL | SMALL | MEDIUM | LARGE | XLARGE | XXLARGE | XXXLARGE }
14+
CREATE WAREHOUSE '<warehouse_name>'
15+
WITH WAREHOUSE_SIZE = '<warehouse_size>'
1616
```
1717

18-
Tip: If `<warehouse_name>` contains `-`, quote it with quotes (for example, `'name-with-hyphen'`, `` `name-with-hyphen` ``, or `"name-with-hyphen"`).
18+
Where:
19+
20+
- `<warehouse_name>` must contain only English letters, digits, and `-`. We recommend always using single quotes.
21+
- `<warehouse_size>` is case-insensitive and can be one of: `XSMALL`, `SMALL`, `MEDIUM`, `LARGE`, `XLARGE`, `XXLARGE`, `XXXLARGE`. We recommend using single quotes.
1922

2023
## Examples
2124

‎docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Removes the specified warehouse and frees up the resources associated with it.
1010
## Syntax
1111

1212
```sql
13-
DROP WAREHOUSE <warehouse_name>
13+
DROP WAREHOUSE '<warehouse_name>'
1414
```
1515

16-
Tip: If `<warehouse_name>` contains `-`, quote it with quotes (for example, `'name-with-hyphen'`, `` `name-with-hyphen` ``, or `"name-with-hyphen"`).
16+
We recommend always using single quotes for `<warehouse_name>`.
1717

1818
## Examples
1919

‎docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Sets the active warehouse for executing queries.
1010
## Syntax
1111

1212
```sql
13-
USE WAREHOUSE <warehouse_name>
13+
USE WAREHOUSE '<warehouse_name>'
1414
```
1515

16-
Tip: If `<warehouse_name>` contains `-`, quote it with quotes (for example, `'name-with-hyphen'`, `` `name-with-hyphen` ``, or `"name-with-hyphen"`).
16+
We recommend always using single quotes for `<warehouse_name>`.
1717

1818
## Examples
1919

‎pdf/docs.databend.cn-sql.txt‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -431,14 +431,9 @@ https://docs.databend.cn/sql/sql-commands/ddl/virtual-column/
431431
https://docs.databend.cn/sql/sql-commands/ddl/virtual-column/refresh-virtual-column
432432
https://docs.databend.cn/sql/sql-commands/ddl/virtual-column/show-virtual-columns
433433
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/
434-
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/alter-warehouse
435434
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/create-warehouse
436435
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/drop-warehouse
437-
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/rename-warehouse
438-
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/resume-warehouse
439-
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/show-online-nodes
440436
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/show-warehouses
441-
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/suspend-warehouse
442437
https://docs.databend.cn/sql/sql-commands/ddl/warehouse/use-warehouse
443438
https://docs.databend.cn/sql/sql-commands/ddl/workload-group/
444439
https://docs.databend.cn/sql/sql-commands/ddl/workload-group/alter-workload-group

‎pdf/docs.databend.en-sql.txt‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -431,14 +431,9 @@ https://docs.databend.com/sql/sql-commands/ddl/virtual-column/
431431
https://docs.databend.com/sql/sql-commands/ddl/virtual-column/refresh-virtual-column
432432
https://docs.databend.com/sql/sql-commands/ddl/virtual-column/show-virtual-columns
433433
https://docs.databend.com/sql/sql-commands/ddl/warehouse/
434-
https://docs.databend.com/sql/sql-commands/ddl/warehouse/alter-warehouse
435434
https://docs.databend.com/sql/sql-commands/ddl/warehouse/create-warehouse
436435
https://docs.databend.com/sql/sql-commands/ddl/warehouse/drop-warehouse
437-
https://docs.databend.com/sql/sql-commands/ddl/warehouse/rename-warehouse
438-
https://docs.databend.com/sql/sql-commands/ddl/warehouse/resume-warehouse
439-
https://docs.databend.com/sql/sql-commands/ddl/warehouse/show-online-nodes
440436
https://docs.databend.com/sql/sql-commands/ddl/warehouse/show-warehouses
441-
https://docs.databend.com/sql/sql-commands/ddl/warehouse/suspend-warehouse
442437
https://docs.databend.com/sql/sql-commands/ddl/warehouse/use-warehouse
443438
https://docs.databend.com/sql/sql-commands/ddl/workload-group/
444439
https://docs.databend.com/sql/sql-commands/ddl/workload-group/alter-workload-group

0 commit comments

Comments
 (0)