diff --git a/docs/cn/guides/20-self-hosted/04-references/warehouse-sql-commands.md b/docs/cn/guides/20-self-hosted/04-references/warehouse-sql-commands.md new file mode 100644 index 0000000000..7e709c1c3f --- /dev/null +++ b/docs/cn/guides/20-self-hosted/04-references/warehouse-sql-commands.md @@ -0,0 +1,90 @@ +--- +title: 计算集群 SQL 命令 +--- + +本页列出在自建部署中启用系统管理（system-managed）资源管理后，可用于管理计算集群的 SQL 命令。 + +## SHOW ONLINE NODES + +列出租户中当前在线的查询节点。 + +```sql +SHOW ONLINE NODES +``` + +```sql +SHOW ONLINE NODES; +``` + +## CREATE WAREHOUSE + +通过指定节点数量创建系统管理的计算集群。 + +```sql +CREATE WAREHOUSE + WITH warehouse_size = +``` + +```sql +CREATE WAREHOUSE wh1 WITH warehouse_size = 2; +``` + +## ALTER WAREHOUSE + +用于管理计算集群中的集群（cluster）。 + +```sql +ALTER WAREHOUSE + ADD CLUSTER WITH CLUSTER_SIZE = + +ALTER WAREHOUSE + RENAME CLUSTER TO + +ALTER WAREHOUSE + DROP CLUSTER +``` + +```sql +ALTER WAREHOUSE wh1 ADD CLUSTER c1 WITH CLUSTER_SIZE = 2; +``` + +## RENAME WAREHOUSE + +重命名计算集群。 + +```sql +RENAME WAREHOUSE TO +``` + +```sql +RENAME WAREHOUSE wh1 TO wh1_new; +``` + +## SUSPEND WAREHOUSE + +暂停计算集群。 + +```sql +SUSPEND WAREHOUSE +``` + +```sql +SUSPEND WAREHOUSE wh1; +``` + +## RESUME WAREHOUSE + +恢复已暂停的计算集群。 + +```sql +RESUME WAREHOUSE +``` + +```sql +RESUME WAREHOUSE wh1; +``` + +## 另请参阅 + +- [USE WAREHOUSE](/sql/sql-commands/ddl/warehouse/use-warehouse) +- [DROP WAREHOUSE](/sql/sql-commands/ddl/warehouse/drop-warehouse) diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/alter-warehouse.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/alter-warehouse.md deleted file mode 100644 index a3e806b8e7..0000000000 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/alter-warehouse.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: ALTER WAREHOUSE ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -动态调整计算集群的配置，包括添加/删除集群、重命名集群和分配/取消分配节点。 - -## Syntax - -```sql -ALTER WAREHOUSE - [ADD CLUSTER [WITH CLUSTER_SIZE = ] | (ASSIGN NODES FROM ) ] - | [RENAME CLUSTER TO ] - | [DROP CLUSTER ] - | [ASSIGN NODES (ASSIGN NODES [FROM ] FOR )] - | [UNASSIGN NODES (UNASSIGN NODES [FROM ] FOR )] - -``` - -## Examples - -此示例向现有计算集群添加集群： - -```sql -ALTER WAREHOUSE test_warehouse ADD CLUSTER test_cluster WITH CLUSTER_SIZE = 3; -``` - -此示例重命名现有集群： - -```sql -ALTER WAREHOUSE test_warehouse RENAME CLUSTER default TO test_cluster_2; -``` - -此示例删除现有集群： - -```sql -ALTER WAREHOUSE test_warehouse DROP CLUSTER test_cluster_2; -``` - -此示例向现有计算集群添加节点： - -```sql -ALTER WAREHOUSE test_warehouse ASSIGN NODES (ASSIGN 2 NODES FOR test_cluster); -``` - -此示例从现有计算集群中删除节点： - -```sql -ALTER WAREHOUSE test_warehouse UNASSIGN NODES (UNASSIGN 1 NODES FOR test_cluster); -``` - -此示例通过从特定节点组中选择节点来创建集群： - -```sql -ALTER WAREHOUSE test_warehouse ADD CLUSTER test_cluster (ASSIGN 1 NODES FROM dev_node, ASSIGN 1 NODES FROM infra_node); -``` - -此示例将特定节点组中的节点添加到现有计算集群： - -```sql -ALTER WAREHOUSE test_warehouse ASSIGN NODES (ASSIGN 1 NODES FROM dev_node FOR default, ASSIGN 1 NODES FROM infra_node FOR default); -``` - -此示例删除计算集群中特定节点组中的节点： - -```sql -ALTER WAREHOUSE test_warehouse UNASSIGN NODES (UNASSIGN 1 NODES FROM dev_node FOR default, UNASSIGN 2 NODES FROM infra_node FOR default); -``` \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md index 2e2d7b3c66..d37879fbba 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md @@ -6,25 +6,24 @@ import FunctionDescription from '@site/src/components/FunctionDescription'; -创建一个具有指定大小的计算集群（Warehouse），或通过从特定节点组分配节点来创建。 +创建一个具有指定大小的计算集群。 ## 语法 ```sql -CREATE WAREHOUSE -[WITH warehouse_size = | ( ASSIGN NODES FROM [, NODES FROM ... ] ) ] +CREATE WAREHOUSE '' + WITH WAREHOUSE_SIZE = '' ``` -## 示例 +说明： -此示例创建一个大小为 10 的计算集群（Warehouse）： +- `` 只能包含英文字母、数字和 `-`。建议统一使用单引号包裹。 +- `` 不区分大小写，可选值为：`XSMALL`、`SMALL`、`MEDIUM`、`LARGE`、`XLARGE`、`XXLARGE`、`XXXLARGE`。建议统一使用单引号包裹。 -```sql -CREATE WAREHOUSE test_warehouse WITH warehouse_size = 10; -``` +## 示例 -此示例通过从特定节点组分配节点来创建一个计算集群（Warehouse）： +此示例创建一个 `XSMALL` 规格的计算集群： ```sql -CREATE WAREHOUSE test_warehouse (ASSIGN 1 NODES FROM log_node, ASSIGN 2 NODES FROM infra_node); -``` \ No newline at end of file +CREATE WAREHOUSE 'testwarehouse' WITH WAREHOUSE_SIZE = 'XSMALL'; +``` diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md index dc358ee5ee..1f17d0c67c 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md @@ -3,20 +3,22 @@ title: DROP WAREHOUSE --- import FunctionDescription from '@site/src/components/FunctionDescription'; - + 删除指定的计算集群并释放与其关联的资源。 ## 语法 ```sql -DROP WAREHOUSE +DROP WAREHOUSE '' ``` +建议统一使用单引号包裹 ``。 + ## 示例 -此示例删除 `test_warehouse` 计算集群： +此示例删除 `testwarehouse` 计算集群： ```sql -DROP WAREHOUSE test_warehouse; -``` \ No newline at end of file +DROP WAREHOUSE 'testwarehouse'; +``` diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md index 7628cb54bb..dc5e5ed55c 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md @@ -2,18 +2,14 @@ title: 计算集群（Warehouse） --- -本页面全面概述了 Databend 中计算集群的操作，按功能分类，便于参考。 +计算集群相关的 SQL 命令。 ## 计算集群管理 | 命令 | 描述 | |---------|-------------| | [CREATE WAREHOUSE](create-warehouse.md) | 创建新的计算集群用于计算资源 | -| [ALTER WAREHOUSE](alter-warehouse.md) | 修改现有计算集群的配置 | | [DROP WAREHOUSE](drop-warehouse.md) | 删除计算集群 | -| [RENAME WAREHOUSE](rename-warehouse.md) | 更改计算集群的名称 | -| [SUSPEND WAREHOUSE](suspend-warehouse.md) | 临时停止计算集群以节省资源 | -| [RESUME WAREHOUSE](resume-warehouse.md) | 重启已暂停的计算集群 | | [USE WAREHOUSE](use-warehouse.md) | 为当前会话设置计算集群 | ## 计算集群信息 @@ -21,8 +17,7 @@ title: 计算集群（Warehouse） | 命令 | 描述 | |---------|-------------| | [SHOW WAREHOUSES](show-warehouses.md) | 列出所有计算集群 | -| [SHOW ONLINE NODES](show-online-nodes.md) | 显示当前计算集群中的活跃计算节点 | :::note -Databend 中的计算集群代表执行查询（Query）的计算资源。它们可以根据工作负载需求进行扩容或缩容，并在不使用时暂停以优化成本。 -::: \ No newline at end of file +计算集群代表用于执行查询的计算资源。 +::: diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/rename-warehouse.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/rename-warehouse.md deleted file mode 100644 index 6a110e9199..0000000000 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/rename-warehouse.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: RENAME WAREHOUSE ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -将现有的计算集群重命名为新名称。 - -当您重命名计算集群时，如果尝试 `USE` 重命名的计算集群而不先退出并重新连接，会话将遇到错误。这是因为会话仍然引用旧的计算集群名称。要解决此问题，请退出当前会话，然后在尝试使用重命名的计算集群之前重新连接。 - -```sql title='Example:' -root@(test_warehouse_1)/default> rename warehouse test_warehouse_1 to test_warehouse; - -rename warehouse test_warehouse_1 to test_warehouse - -0 row read in 0.027 sec. Processed 0 row, 0 B (0 row/s, 0 B/s) - -root@(test_warehouse_1)/default> use warehouse test_warehouse; -error: APIError: fail to POST http://localhost:8000/v1/query: BadRequest:(500 Internal Server Error)[500]Some(500) UnknownWarehouse. Code: 2406, Text = Unknown warehouse or self managed warehouse "test_warehouse_1" -(while in warehouse request forward). - -root@(test_warehouse_1)/default> exit -Bye~ - -root@localhost:8000/default> use warehouse test_warehouse; - -use warehouse test_warehouse - -0 row read in 0.019 sec. Processed 0 row, 0 B (0 row/s, 0 B/s) -``` - -## 语法 - -```sql -RENAME WAREHOUSE TO -``` - -## 示例 - -此示例将 `test_warehouse_1` 重命名为 `test_warehouse`： - -```sql -RENAME WAREHOUSE test_warehouse_1 TO test_warehouse; -``` \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/resume-warehouse.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/resume-warehouse.md deleted file mode 100644 index c42483385e..0000000000 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/resume-warehouse.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: RESUME WAREHOUSE ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -重新启动之前暂停的计算集群，使其恢复在线状态并重新分配其机器资源。如果没有可用的节点，RESUME WAREHOUSE 命令将失败。尝试恢复计算集群时，请确保有必要的资源可用于计算集群成功重启。 - -## 语法 - -```sql -RESUME WAREHOUSE -``` - -## 示例 - -此示例恢复 `test_warehouse` 计算集群： - -```sql -RESUME WAREHOUSE test_warehouse; -``` \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-online-nodes.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-online-nodes.md deleted file mode 100644 index 6f9bf88d6a..0000000000 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-online-nodes.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: SHOW ONLINE NODES ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -列出租户中当前所有在线节点，显示节点 ID、类型、节点组、计算集群、集群和版本等详细信息。 - -## Syntax - -```sql -SHOW ONLINE NODES -``` - -## Examples - -```sql -SHOW ONLINE NODES; - -┌─────────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│ id │ type │ node_group │ warehouse │ cluster │ version │ -├────────────────────────┼───────────────┼────────────┼───────────┼─────────┼─────────────────────────────┤ -│ 9rabYMxa0ReDyZe6F9igH5 │ SystemManaged │ log_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ CbzfLlTVO29EhkZXdeR625 │ SystemManaged │ log_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ O0kOetbvkFjxrQ2kx4uMI │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ R2epWlGVd8S0maSTuwbsv4 │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ SoZcaT4gmhVoGKcChlDw93 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ UeNVzwHCXhxJTTB4Xonj07 │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ Zu7rmhVZ2s2HqTUCdFBdu2 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ bRubWZEzIibFgRgFad2MS3 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ ilPer0ps5wWnEDOLIlk821 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ shnWu1TC41sAxVwJMIVQF3 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -└─────────────────────────────────────────────────────────────────────────────────────────────────────────┘ -``` \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-warehouses.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-warehouses.md index e3fa34e196..43886b4ad3 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-warehouses.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-warehouses.md @@ -3,9 +3,11 @@ title: SHOW WAREHOUSES --- import FunctionDescription from '@site/src/components/FunctionDescription'; - + -返回所有现有计算集群的列表，以及它们的类型和状态。 +列出当前租户下的所有计算集群。 + +结果包含 `name`、`state`、`size`、`version`、`auto_suspend`、`cache_size`、`spill_size`、`created_on` 等列。 ## 语法 @@ -17,10 +19,4 @@ SHOW WAREHOUSES ```sql SHOW WAREHOUSES; - -┌───────────────────────────────────────────┐ -│ warehouse │ type │ status │ -├────────────────┼────────────────┼─────────┤ -│ test_warehouse │ System-Managed │ Running │ -└───────────────────────────────────────────┘ -``` \ No newline at end of file +``` diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/suspend-warehouse.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/suspend-warehouse.md deleted file mode 100644 index 25636617f0..0000000000 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/suspend-warehouse.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: SUSPEND WAREHOUSE ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -暂停一个计算集群，释放相关的机器资源，但不会删除该计算集群。 - -当您暂停一个计算集群时，它会释放与该计算集群相关的机器资源。但是，此操作可能会在尝试与计算集群交互时导致问题。具体来说，如果您尝试使用或查询一个已暂停的计算集群，您可能会遇到错误，表明该计算集群不可用。例如，尝试运行 SHOW ONLINE NODES 或其他引用已暂停计算集群的命令将导致错误。要解决此问题，您需要退出当前会话并重新连接。 - -```sql title='Example:' -root@(test_warehouse)/default> suspend warehouse test_warehouse; - -suspend warehouse test_warehouse - -0 row read in 0.036 sec. Processed 0 row, 0 B (0 row/s, 0 B/s) - -root@(test_warehouse)/default> show online nodes; -error: APIError: fail to POST http://localhost:8000/v1/query: BadRequest:(400 Bad Request)[400]Some(400) UnknownWarehouse. Code: 2406, Text = Not find the 'test_warehouse' warehouse; it is possible that all nodes of the warehouse have gone offline. Please exit the client and reconnect, or use `use warehouse `. - -root@(test_warehouse_1)/default> exit -Bye~ - -root@localhost:8000/default> show online nodes; - -show online nodes - -┌─────────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│ id │ type │ node_group │ warehouse │ cluster │ version │ -│ String │ String │ String │ String │ String │ String │ -├────────────────────────┼───────────────┼────────────┼───────────┼─────────┼─────────────────────────────┤ -│ 9rabYMxa0ReDyZe6F9igH5 │ SystemManaged │ log_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ CbzfLlTVO29EhkZXdeR625 │ SystemManaged │ log_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ O0kOetbvkFjxrQ2kx4uMI │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ R2epWlGVd8S0maSTuwbsv4 │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ SoZcaT4gmhVoGKcChlDw93 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ UeNVzwHCXhxJTTB4Xonj07 │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ Zu7rmhVZ2s2HqTUCdFBdu2 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ bRubWZEzIibFgRgFad2MS3 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ ilPer0ps5wWnEDOLIlk821 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ shnWu1TC41sAxVwJMIVQF3 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -└─────────────────────────────────────────────────────────────────────────────────────────────────────────┘ -10 rows read in 0.133 sec. Processed 0 rows, 0 B (0 row/s, 0 B/s) -``` - -## Syntax - -```sql -SUSPEND WAREHOUSE -``` - -## Examples - -此示例暂停 `test_warehouse` 计算集群： - -```sql -SUSPEND WAREHOUSE test_warehouse; -``` \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md index bab8e68fd8..70dba1651f 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md @@ -3,20 +3,22 @@ title: USE WAREHOUSE --- import FunctionDescription from '@site/src/components/FunctionDescription'; - + 设置用于执行查询的活动计算集群。 ## 语法 ```sql -USE WAREHOUSE +USE WAREHOUSE '' ``` +建议统一使用单引号包裹 ``。 + ## 示例 -此示例将 `test_warehouse` 设置为活动计算集群： +此示例将 `testwarehouse` 设置为当前使用的计算集群： ```sql -USE WAREHOUSE test_warehouse; -``` \ No newline at end of file +USE WAREHOUSE 'testwarehouse'; +``` diff --git a/docs/en/guides/20-self-hosted/04-references/warehouse-sql-commands.md b/docs/en/guides/20-self-hosted/04-references/warehouse-sql-commands.md new file mode 100644 index 0000000000..f0d9d3b8cf --- /dev/null +++ b/docs/en/guides/20-self-hosted/04-references/warehouse-sql-commands.md @@ -0,0 +1,90 @@ +--- +title: Warehouse SQL Commands +--- + +This page lists warehouse-related SQL commands for self-hosted deployments with system-managed resources management enabled. + +## SHOW ONLINE NODES + +Lists online query nodes in the tenant. + +```sql +SHOW ONLINE NODES +``` + +```sql +SHOW ONLINE NODES; +``` + +## CREATE WAREHOUSE + +Creates a system-managed warehouse by specifying the number of nodes. + +```sql +CREATE WAREHOUSE + WITH warehouse_size = +``` + +```sql +CREATE WAREHOUSE wh1 WITH warehouse_size = 2; +``` + +## ALTER WAREHOUSE + +Manages clusters in a warehouse. + +```sql +ALTER WAREHOUSE + ADD CLUSTER WITH CLUSTER_SIZE = + +ALTER WAREHOUSE + RENAME CLUSTER TO + +ALTER WAREHOUSE + DROP CLUSTER +``` + +```sql +ALTER WAREHOUSE wh1 ADD CLUSTER c1 WITH CLUSTER_SIZE = 2; +``` + +## RENAME WAREHOUSE + +Renames a warehouse. + +```sql +RENAME WAREHOUSE TO +``` + +```sql +RENAME WAREHOUSE wh1 TO wh1_new; +``` + +## SUSPEND WAREHOUSE + +Suspends a warehouse. + +```sql +SUSPEND WAREHOUSE +``` + +```sql +SUSPEND WAREHOUSE wh1; +``` + +## RESUME WAREHOUSE + +Resumes a suspended warehouse. + +```sql +RESUME WAREHOUSE +``` + +```sql +RESUME WAREHOUSE wh1; +``` + +## See Also + +- [USE WAREHOUSE](/sql/sql-commands/ddl/warehouse/use-warehouse) +- [DROP WAREHOUSE](/sql/sql-commands/ddl/warehouse/drop-warehouse) diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/alter-warehouse.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/alter-warehouse.md deleted file mode 100644 index 346423a227..0000000000 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/alter-warehouse.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: ALTER WAREHOUSE ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -Dynamically adjusts the configuration of a warehouse, including adding/removing clusters, renaming clusters, and assigning/unassigning nodes. - -## Syntax - -```sql -ALTER WAREHOUSE - [ADD CLUSTER [WITH CLUSTER_SIZE = ] | (ASSIGN NODES FROM ) ] - | [RENAME CLUSTER TO ] - | [DROP CLUSTER ] - | [ASSIGN NODES (ASSIGN NODES [FROM ] FOR )] - | [UNASSIGN NODES (UNASSIGN NODES [FROM ] FOR )] - -``` - -## Examples - -This example adds a cluster to an existing warehouse: - -```sql -ALTER WAREHOUSE test_warehouse ADD CLUSTER test_cluster WITH CLUSTER_SIZE = 3; -``` - -This example renames an existing cluster: - -```sql -ALTER WAREHOUSE test_warehouse RENAME CLUSTER default TO test_cluster_2; -``` - -This example removes an existing cluster: - -```sql -ALTER WAREHOUSE test_warehouse DROP CLUSTER test_cluster_2; -``` - -This example adds nodes to an existing warehouse: - -```sql -ALTER WAREHOUSE test_warehouse ASSIGN NODES (ASSIGN 2 NODES FOR test_cluster); -``` - -This example removes nodes from an existing warehouse: - -```sql -ALTER WAREHOUSE test_warehouse UNASSIGN NODES (UNASSIGN 1 NODES FOR test_cluster); -``` - -This example creates a cluster by selecting nodes from specific node groups: - -```sql -ALTER WAREHOUSE test_warehouse ADD CLUSTER test_cluster (ASSIGN 1 NODES FROM dev_node, ASSIGN 1 NODES FROM infra_node); -``` - -This example adds nodes from specific node groups to an existing warehouse: - -```sql -ALTER WAREHOUSE test_warehouse ASSIGN NODES (ASSIGN 1 NODES FROM dev_node FOR default, ASSIGN 1 NODES FROM infra_node FOR default); -``` - -This example removes nodes from specific node groups in a warehouse: - -```sql -ALTER WAREHOUSE test_warehouse UNASSIGN NODES (UNASSIGN 1 NODES FROM dev_node FOR default, UNASSIGN 2 NODES FROM infra_node FOR default); -``` \ No newline at end of file diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md index d1c5232242..fcb3762de4 100644 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md +++ b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/create-warehouse.md @@ -6,25 +6,24 @@ import FunctionDescription from '@site/src/components/FunctionDescription'; -Creates a warehouse with specified size or by assigning nodes from specific node groups. +Creates a warehouse. ## Syntax ```sql -CREATE WAREHOUSE -[WITH warehouse_size = | ( ASSIGN NODES FROM [, NODES FROM ... ] ) ] +CREATE WAREHOUSE '' + WITH WAREHOUSE_SIZE = '' ``` -## Examples +Where: -This example creates a warehouse with a size of 10: +- `` must contain only English letters, digits, and `-`. We recommend always using single quotes. +- `` is case-insensitive and can be one of: `XSMALL`, `SMALL`, `MEDIUM`, `LARGE`, `XLARGE`, `XXLARGE`, `XXXLARGE`. We recommend using single quotes. -```sql -CREATE WAREHOUSE test_warehouse WITH warehouse_size = 10; -``` +## Examples -This example creates a warehouse by assigning specific nodes from node groups: +This example creates an `XSMALL` warehouse: ```sql -CREATE WAREHOUSE test_warehouse (ASSIGN 1 NODES FROM log_node, ASSIGN 2 NODES FROM infra_node); +CREATE WAREHOUSE 'testwarehouse' WITH WAREHOUSE_SIZE = 'XSMALL'; ``` diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md index a9eb67a995..86b4089157 100644 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md +++ b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/drop-warehouse.md @@ -10,13 +10,15 @@ Removes the specified warehouse and frees up the resources associated with it. ## Syntax ```sql -DROP WAREHOUSE +DROP WAREHOUSE '' ``` +We recommend always using single quotes for ``. + ## Examples -This example removes the `test_warehouse` warehouse: +This example removes the `testwarehouse` warehouse: ```sql -DROP WAREHOUSE test_warehouse; -``` \ No newline at end of file +DROP WAREHOUSE 'testwarehouse'; +``` diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md index dfc05cbfc7..8060b78705 100644 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md +++ b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md @@ -2,18 +2,14 @@ title: Warehouse --- -This page provides a comprehensive overview of Warehouse operations in Databend, organized by functionality for easy reference. +Warehouse-related SQL commands. ## Warehouse Management | Command | Description | |---------|-------------| | [CREATE WAREHOUSE](create-warehouse.md) | Creates a new warehouse for compute resources | -| [ALTER WAREHOUSE](alter-warehouse.md) | Modifies an existing warehouse configuration | | [DROP WAREHOUSE](drop-warehouse.md) | Removes a warehouse | -| [RENAME WAREHOUSE](rename-warehouse.md) | Changes the name of a warehouse | -| [SUSPEND WAREHOUSE](suspend-warehouse.md) | Temporarily stops a warehouse to save resources | -| [RESUME WAREHOUSE](resume-warehouse.md) | Restarts a suspended warehouse | | [USE WAREHOUSE](use-warehouse.md) | Sets the current warehouse for the session | ## Warehouse Information @@ -21,8 +17,7 @@ This page provides a comprehensive overview of Warehouse operations in Databend, | Command | Description | |---------|-------------| | [SHOW WAREHOUSES](show-warehouses.md) | Lists all warehouses | -| [SHOW ONLINE NODES](show-online-nodes.md) | Displays active compute nodes in the current warehouse | :::note -Warehouses in Databend represent compute resources that execute queries. They can be scaled up or down based on workload requirements and can be suspended when not in use to optimize costs. -::: \ No newline at end of file +A warehouse represents compute resources used to run queries. +::: diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/rename-warehouse.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/rename-warehouse.md deleted file mode 100644 index e30d8344c4..0000000000 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/rename-warehouse.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: RENAME WAREHOUSE ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -Renames an existing warehouse to a new name. - -When you rename a warehouse, the session will encounter an error if trying to USE the renamed warehouse without first exiting and reconnecting. This is because the session still references the old warehouse name. To resolve this issue, exit the current session and then reconnect before attempting to use the renamed warehouse. - -```sql title='Example:' -root@(test_warehouse_1)/default> rename warehouse test_warehouse_1 to test_warehouse; - -rename warehouse test_warehouse_1 to test_warehouse - -0 row read in 0.027 sec. Processed 0 row, 0 B (0 row/s, 0 B/s) - -root@(test_warehouse_1)/default> use warehouse test_warehouse; -error: APIError: fail to POST http://localhost:8000/v1/query: BadRequest:(500 Internal Server Error)[500]Some(500) UnknownWarehouse. Code: 2406, Text = Unknown warehouse or self managed warehouse "test_warehouse_1" -(while in warehouse request forward). - -root@(test_warehouse_1)/default> exit -Bye~ - -root@localhost:8000/default> use warehouse test_warehouse; - -use warehouse test_warehouse - -0 row read in 0.019 sec. Processed 0 row, 0 B (0 row/s, 0 B/s) -``` - -## Syntax - -```sql -RENAME WAREHOUSE TO -``` - -## Examples - -This example renames `test_warehouse_1` to `test_warehouse`: - -```sql -RENAME WAREHOUSE test_warehouse_1 TO test_warehouse; -``` - diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/resume-warehouse.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/resume-warehouse.md deleted file mode 100644 index 80ded5d9b3..0000000000 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/resume-warehouse.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: RESUME WAREHOUSE ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -Restarts a previously suspended warehouse, bringing it back online and re-allocating its machine resources. If there are no available nodes, the RESUME WAREHOUSE command will fail. When trying to resume a warehouse, ensure that the necessary resources are available for the warehouse to restart successfully. - -## Syntax - -```sql -RESUME WAREHOUSE -``` - -## Examples - -This example resumes the `test_warehouse` warehouse: - -```sql -RESUME WAREHOUSE test_warehouse; -``` \ No newline at end of file diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-online-nodes.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-online-nodes.md deleted file mode 100644 index 96bee36138..0000000000 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-online-nodes.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: SHOW ONLINE NODES ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -Lists all currently online nodes within the tenant, showing details such as node ID, type, node group, warehouse, cluster, and version. - -## Syntax - -```sql -SHOW ONLINE NODES -``` - -## Examples - -```sql -SHOW ONLINE NODES; - -┌─────────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│ id │ type │ node_group │ warehouse │ cluster │ version │ -├────────────────────────┼───────────────┼────────────┼───────────┼─────────┼─────────────────────────────┤ -│ 9rabYMxa0ReDyZe6F9igH5 │ SystemManaged │ log_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ CbzfLlTVO29EhkZXdeR625 │ SystemManaged │ log_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ O0kOetbvkFjxrQ2kx4uMI │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ R2epWlGVd8S0maSTuwbsv4 │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ SoZcaT4gmhVoGKcChlDw93 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ UeNVzwHCXhxJTTB4Xonj07 │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ Zu7rmhVZ2s2HqTUCdFBdu2 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ bRubWZEzIibFgRgFad2MS3 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ ilPer0ps5wWnEDOLIlk821 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ shnWu1TC41sAxVwJMIVQF3 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -└─────────────────────────────────────────────────────────────────────────────────────────────────────────┘ -``` \ No newline at end of file diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-warehouses.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-warehouses.md index 428ae10d5f..7d53ae8eda 100644 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-warehouses.md +++ b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/show-warehouses.md @@ -5,7 +5,9 @@ import FunctionDescription from '@site/src/components/FunctionDescription'; -Returns a list of all existing warehouses along with their type and status. +Lists all warehouses in the current tenant. + +The result includes columns like `name`, `state`, `size`, `version`, `auto_suspend`, `cache_size`, `spill_size`, and `created_on`. ## Syntax @@ -17,10 +19,4 @@ SHOW WAREHOUSES ```sql SHOW WAREHOUSES; - -┌───────────────────────────────────────────┐ -│ warehouse │ type │ status │ -├────────────────┼────────────────┼─────────┤ -│ test_warehouse │ System-Managed │ Running │ -└───────────────────────────────────────────┘ -``` \ No newline at end of file +``` diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/suspend-warehouse.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/suspend-warehouse.md deleted file mode 100644 index 2e5dce42e9..0000000000 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/suspend-warehouse.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: SUSPEND WAREHOUSE ---- -import FunctionDescription from '@site/src/components/FunctionDescription'; - - - -Suspends a warehouse, releasing the associated machine resources, but does not delete the warehouse. - -When you suspend a warehouse, it releases the machine resources associated with the warehouse. However, this action can cause issues when attempting to interact with the warehouse. Specifically, if you try to use or query a suspended warehouse, you may encounter errors indicating that the warehouse is unavailable. For example, attempting to run SHOW ONLINE NODES or other commands that reference the suspended warehouse will result in an error. To resolve this, you need to exit the current session and reconnect. - -```sql title='Example:' -root@(test_warehouse)/default> suspend warehouse test_warehouse; - -suspend warehouse test_warehouse - -0 row read in 0.036 sec. Processed 0 row, 0 B (0 row/s, 0 B/s) - -root@(test_warehouse)/default> show online nodes; -error: APIError: fail to POST http://localhost:8000/v1/query: BadRequest:(400 Bad Request)[400]Some(400) UnknownWarehouse. Code: 2406, Text = Not find the 'test_warehouse' warehouse; it is possible that all nodes of the warehouse have gone offline. Please exit the client and reconnect, or use `use warehouse `. - -root@(test_warehouse_1)/default> exit -Bye~ - -root@localhost:8000/default> show online nodes; - -show online nodes - -┌─────────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│ id │ type │ node_group │ warehouse │ cluster │ version │ -│ String │ String │ String │ String │ String │ String │ -├────────────────────────┼───────────────┼────────────┼───────────┼─────────┼─────────────────────────────┤ -│ 9rabYMxa0ReDyZe6F9igH5 │ SystemManaged │ log_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ CbzfLlTVO29EhkZXdeR625 │ SystemManaged │ log_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ O0kOetbvkFjxrQ2kx4uMI │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ R2epWlGVd8S0maSTuwbsv4 │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ SoZcaT4gmhVoGKcChlDw93 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ UeNVzwHCXhxJTTB4Xonj07 │ SystemManaged │ dev_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ Zu7rmhVZ2s2HqTUCdFBdu2 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ bRubWZEzIibFgRgFad2MS3 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ ilPer0ps5wWnEDOLIlk821 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -│ shnWu1TC41sAxVwJMIVQF3 │ SystemManaged │ infra_node │ │ │ v1.2.665-nightly-bcb2c16f67 │ -└─────────────────────────────────────────────────────────────────────────────────────────────────────────┘ -10 rows read in 0.133 sec. Processed 0 rows, 0 B (0 row/s, 0 B/s) -``` - -## Syntax - -```sql -SUSPEND WAREHOUSE -``` - -## Examples - -This example suspends the `test_warehouse` warehouse: - -```sql -SUSPEND WAREHOUSE test_warehouse; -``` \ No newline at end of file diff --git a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md index 764738db8f..becb37accb 100644 --- a/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md +++ b/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/use-warehouse.md @@ -10,13 +10,15 @@ Sets the active warehouse for executing queries. ## Syntax ```sql -USE WAREHOUSE +USE WAREHOUSE '' ``` +We recommend always using single quotes for ``. + ## Examples -This example sets `test_warehouse` as the active warehouse: +This example sets `testwarehouse` as the active warehouse: ```sql -USE WAREHOUSE test_warehouse; -``` \ No newline at end of file +USE WAREHOUSE 'testwarehouse'; +``` diff --git a/pdf/docs.databend.cn-sql.txt b/pdf/docs.databend.cn-sql.txt index 48a341b357..a29bb3bc40 100644 --- a/pdf/docs.databend.cn-sql.txt +++ b/pdf/docs.databend.cn-sql.txt @@ -431,14 +431,9 @@ https://docs.databend.cn/sql/sql-commands/ddl/virtual-column/ https://docs.databend.cn/sql/sql-commands/ddl/virtual-column/refresh-virtual-column https://docs.databend.cn/sql/sql-commands/ddl/virtual-column/show-virtual-columns https://docs.databend.cn/sql/sql-commands/ddl/warehouse/ -https://docs.databend.cn/sql/sql-commands/ddl/warehouse/alter-warehouse https://docs.databend.cn/sql/sql-commands/ddl/warehouse/create-warehouse https://docs.databend.cn/sql/sql-commands/ddl/warehouse/drop-warehouse -https://docs.databend.cn/sql/sql-commands/ddl/warehouse/rename-warehouse -https://docs.databend.cn/sql/sql-commands/ddl/warehouse/resume-warehouse -https://docs.databend.cn/sql/sql-commands/ddl/warehouse/show-online-nodes https://docs.databend.cn/sql/sql-commands/ddl/warehouse/show-warehouses -https://docs.databend.cn/sql/sql-commands/ddl/warehouse/suspend-warehouse https://docs.databend.cn/sql/sql-commands/ddl/warehouse/use-warehouse https://docs.databend.cn/sql/sql-commands/ddl/workload-group/ https://docs.databend.cn/sql/sql-commands/ddl/workload-group/alter-workload-group diff --git a/pdf/docs.databend.en-sql.txt b/pdf/docs.databend.en-sql.txt index befefb14fc..3bded75c7f 100644 --- a/pdf/docs.databend.en-sql.txt +++ b/pdf/docs.databend.en-sql.txt @@ -431,14 +431,9 @@ https://docs.databend.com/sql/sql-commands/ddl/virtual-column/ https://docs.databend.com/sql/sql-commands/ddl/virtual-column/refresh-virtual-column https://docs.databend.com/sql/sql-commands/ddl/virtual-column/show-virtual-columns https://docs.databend.com/sql/sql-commands/ddl/warehouse/ -https://docs.databend.com/sql/sql-commands/ddl/warehouse/alter-warehouse https://docs.databend.com/sql/sql-commands/ddl/warehouse/create-warehouse https://docs.databend.com/sql/sql-commands/ddl/warehouse/drop-warehouse -https://docs.databend.com/sql/sql-commands/ddl/warehouse/rename-warehouse -https://docs.databend.com/sql/sql-commands/ddl/warehouse/resume-warehouse -https://docs.databend.com/sql/sql-commands/ddl/warehouse/show-online-nodes https://docs.databend.com/sql/sql-commands/ddl/warehouse/show-warehouses -https://docs.databend.com/sql/sql-commands/ddl/warehouse/suspend-warehouse https://docs.databend.com/sql/sql-commands/ddl/warehouse/use-warehouse https://docs.databend.com/sql/sql-commands/ddl/workload-group/ https://docs.databend.com/sql/sql-commands/ddl/workload-group/alter-workload-group diff --git a/scripts/sitemap-cn.xml b/scripts/sitemap-cn.xml index 0446adc04e..e0c5fccd4e 100644 --- a/scripts/sitemap-cn.xml +++ b/scripts/sitemap-cn.xml @@ -2180,11 +2180,6 @@ daily 0.5 - - https://docs.databend.cn/sql/sql-commands/ddl/warehouse/alter-warehouse - daily - 0.5 - https://docs.databend.cn/sql/sql-commands/ddl/warehouse/create-warehouse daily @@ -2195,31 +2190,11 @@ daily 0.5 - - https://docs.databend.cn/sql/sql-commands/ddl/warehouse/rename-warehouse - daily - 0.5 - - - https://docs.databend.cn/sql/sql-commands/ddl/warehouse/resume-warehouse - daily - 0.5 - - - https://docs.databend.cn/sql/sql-commands/ddl/warehouse/show-online-nodes - daily - 0.5 - https://docs.databend.cn/sql/sql-commands/ddl/warehouse/show-warehouses daily 0.5 - - https://docs.databend.cn/sql/sql-commands/ddl/warehouse/suspend-warehouse - daily - 0.5 - https://docs.databend.cn/sql/sql-commands/ddl/warehouse/use-warehouse daily diff --git a/scripts/sitemap-en.xml b/scripts/sitemap-en.xml index 2dab91c02f..ceca353070 100644 --- a/scripts/sitemap-en.xml +++ b/scripts/sitemap-en.xml @@ -2181,11 +2181,6 @@ daily 0.5 - - https://docs.databend.com/sql/sql-commands/ddl/warehouse/alter-warehouse - daily - 0.5 - https://docs.databend.com/sql/sql-commands/ddl/warehouse/create-warehouse daily @@ -2196,31 +2191,11 @@ daily 0.5 - - https://docs.databend.com/sql/sql-commands/ddl/warehouse/rename-warehouse - daily - 0.5 - - - https://docs.databend.com/sql/sql-commands/ddl/warehouse/resume-warehouse - daily - 0.5 - - - https://docs.databend.com/sql/sql-commands/ddl/warehouse/show-online-nodes - daily - 0.5 - https://docs.databend.com/sql/sql-commands/ddl/warehouse/show-warehouses daily 0.5 - - https://docs.databend.com/sql/sql-commands/ddl/warehouse/suspend-warehouse - daily - 0.5 - https://docs.databend.com/sql/sql-commands/ddl/warehouse/use-warehouse daily