Skip to content

Commit eb9cfb9

Browse files
authored
docs: simplify warehouse SQL docs (#3038)
* docs: simplify warehouse SQL docs - Update CREATE WAREHOUSE syntax and examples - Remove self-hosted-only warehouse pages from SQL reference - Add self-hosted warehouse SQL reference page (nodes/clusters) * docs: align warehouse docs with MCP execution - Use warehouse names compatible with execution - Remove unsupported warehouse commands from SQL reference - Document node/cluster commands under self-hosted references * docs: clarify quoting for hyphenated warehouse names * docs: align warehouse examples with quoting * docs: simplify warehouse quoting and self-hosted refs
1 parent 0f323f0 commit eb9cfb9

26 files changed

+240
-595
lines changed
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
title: 计算集群 SQL 命令
3+
---
4+
5+
本页列出在自建部署中启用系统管理(system-managed)资源管理后,可用于管理计算集群的 SQL 命令。
6+
7+
## SHOW ONLINE NODES
8+
9+
列出租户中当前在线的查询节点。
10+
11+
```sql
12+
SHOW ONLINE NODES
13+
```
14+
15+
```sql
16+
SHOW ONLINE NODES;
17+
```
18+
19+
## CREATE WAREHOUSE
20+
21+
通过指定节点数量创建系统管理的计算集群。
22+
23+
```sql
24+
CREATE WAREHOUSE <warehouse_name>
25+
WITH warehouse_size = <node_count>
26+
```
27+
28+
```sql
29+
CREATE WAREHOUSE wh1 WITH warehouse_size = 2;
30+
```
31+
32+
## ALTER WAREHOUSE
33+
34+
用于管理计算集群中的集群(cluster)。
35+
36+
```sql
37+
ALTER WAREHOUSE <warehouse_name>
38+
ADD CLUSTER <cluster_name> WITH CLUSTER_SIZE = <node_count>
39+
40+
ALTER WAREHOUSE <warehouse_name>
41+
RENAME CLUSTER <old_cluster_name> TO <new_cluster_name>
42+
43+
ALTER WAREHOUSE <warehouse_name>
44+
DROP CLUSTER <cluster_name>
45+
```
46+
47+
```sql
48+
ALTER WAREHOUSE wh1 ADD CLUSTER c1 WITH CLUSTER_SIZE = 2;
49+
```
50+
51+
## RENAME WAREHOUSE
52+
53+
重命名计算集群。
54+
55+
```sql
56+
RENAME WAREHOUSE <current_name> TO <new_name>
57+
```
58+
59+
```sql
60+
RENAME WAREHOUSE wh1 TO wh1_new;
61+
```
62+
63+
## SUSPEND WAREHOUSE
64+
65+
暂停计算集群。
66+
67+
```sql
68+
SUSPEND WAREHOUSE <warehouse_name>
69+
```
70+
71+
```sql
72+
SUSPEND WAREHOUSE wh1;
73+
```
74+
75+
## RESUME WAREHOUSE
76+
77+
恢复已暂停的计算集群。
78+
79+
```sql
80+
RESUME WAREHOUSE <warehouse_name>
81+
```
82+
83+
```sql
84+
RESUME WAREHOUSE wh1;
85+
```
86+
87+
## 另请参阅
88+
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/alter-warehouse.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,24 @@ import FunctionDescription from '@site/src/components/FunctionDescription';
66

77
<FunctionDescription description="引入或更新于:v1.2.687"/>
88

9-
创建一个具有指定大小的计算集群(Warehouse),或通过从特定节点组分配节点来创建
9+
创建一个具有指定大小的计算集群。
1010

1111
## 语法
1212

1313
```sql
14-
CREATE WAREHOUSE <warehouse_name>
15-
[WITH warehouse_size = <size> | ( ASSIGN <node_count> NODES FROM <node_group>[, <node_count> NODES FROM <node_group> ... ] ) ]
14+
CREATE WAREHOUSE '<warehouse_name>'
15+
WITH WAREHOUSE_SIZE = '<warehouse_size>'
1616
```
1717

18-
## 示例
18+
说明:
1919

20-
此示例创建一个大小为 10 的计算集群(Warehouse):
20+
- `<warehouse_name>` 只能包含英文字母、数字和 `-`。建议统一使用单引号包裹。
21+
- `<warehouse_size>` 不区分大小写,可选值为:`XSMALL``SMALL``MEDIUM``LARGE``XLARGE``XXLARGE``XXXLARGE`。建议统一使用单引号包裹。
2122

22-
```sql
23-
CREATE WAREHOUSE test_warehouse WITH warehouse_size = 10;
24-
```
23+
## 示例
2524

26-
此示例通过从特定节点组分配节点来创建一个计算集群(Warehouse)
25+
此示例创建一个 `XSMALL` 规格的计算集群
2726

2827
```sql
29-
CREATE WAREHOUSE test_warehouse (ASSIGN 1 NODES FROM log_node, ASSIGN 2 NODES FROM infra_node);
30-
```
28+
CREATE WAREHOUSE 'testwarehouse' WITH WAREHOUSE_SIZE = 'XSMALL';
29+
```

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,22 @@ title: DROP WAREHOUSE
33
---
44
import FunctionDescription from '@site/src/components/FunctionDescription';
55

6-
<FunctionDescription description="Introduced or updated: v1.2.687"/>
6+
<FunctionDescription description="引入或更新于:v1.2.687"/>
77

88
删除指定的计算集群并释放与其关联的资源。
99

1010
## 语法
1111

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

16+
建议统一使用单引号包裹 `<warehouse_name>`
17+
1618
## 示例
1719

18-
此示例删除 `test_warehouse` 计算集群:
20+
此示例删除 `testwarehouse` 计算集群:
1921

2022
```sql
21-
DROP WAREHOUSE test_warehouse;
22-
```
23+
DROP WAREHOUSE 'testwarehouse';
24+
```

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

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,22 @@
22
title: 计算集群(Warehouse)
33
---
44

5-
本页面全面概述了 Databend 中计算集群的操作,按功能分类,便于参考
5+
计算集群相关的 SQL 命令
66

77
## 计算集群管理
88

99
| 命令 | 描述 |
1010
|---------|-------------|
1111
| [CREATE WAREHOUSE](create-warehouse.md) | 创建新的计算集群用于计算资源 |
12-
| [ALTER WAREHOUSE](alter-warehouse.md) | 修改现有计算集群的配置 |
1312
| [DROP WAREHOUSE](drop-warehouse.md) | 删除计算集群 |
14-
| [RENAME WAREHOUSE](rename-warehouse.md) | 更改计算集群的名称 |
15-
| [SUSPEND WAREHOUSE](suspend-warehouse.md) | 临时停止计算集群以节省资源 |
16-
| [RESUME WAREHOUSE](resume-warehouse.md) | 重启已暂停的计算集群 |
1713
| [USE WAREHOUSE](use-warehouse.md) | 为当前会话设置计算集群 |
1814

1915
## 计算集群信息
2016

2117
| 命令 | 描述 |
2218
|---------|-------------|
2319
| [SHOW WAREHOUSES](show-warehouses.md) | 列出所有计算集群 |
24-
| [SHOW ONLINE NODES](show-online-nodes.md) | 显示当前计算集群中的活跃计算节点 |
2520

2621
:::note
27-
Databend 中的计算集群代表执行查询(Query)的计算资源。它们可以根据工作负载需求进行扩容或缩容,并在不使用时暂停以优化成本
28-
:::
22+
计算集群代表用于执行查询的计算资源
23+
:::

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

Lines changed: 0 additions & 45 deletions
This file was deleted.

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

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-online-nodes.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-warehouses.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ title: SHOW WAREHOUSES
33
---
44
import FunctionDescription from '@site/src/components/FunctionDescription';
55

6-
<FunctionDescription description="Introduced or updated: v1.2.687"/>
6+
<FunctionDescription description="引入或更新于:v1.2.687"/>
77

8-
返回所有现有计算集群的列表,以及它们的类型和状态。
8+
列出当前租户下的所有计算集群。
9+
10+
结果包含 `name``state``size``version``auto_suspend``cache_size``spill_size``created_on` 等列。
911

1012
## 语法
1113

@@ -17,10 +19,4 @@ SHOW WAREHOUSES
1719

1820
```sql
1921
SHOW WAREHOUSES;
20-
21-
┌───────────────────────────────────────────┐
22-
│ warehouse │ type │ status │
23-
├────────────────┼────────────────┼─────────┤
24-
│ test_warehouse │ System-Managed │ Running │
25-
└───────────────────────────────────────────┘
26-
```
22+
```

0 commit comments

Comments
 (0)