Skip to content

docs: missing documentation for RESUME/SUSPEND/RENAME WAREHOUSE and warehouse cluster management DDL #3262

@sundy-li

Description

@sundy-li

What's Missing

The following warehouse lifecycle and cluster management DDL statements are implemented in the Databend source but have no documentation pages:

  • RESUME WAREHOUSE <name>
  • SUSPEND WAREHOUSE <name>
  • RENAME WAREHOUSE <name> TO <new_name>
  • ADD CLUSTER <cluster> TO WAREHOUSE <name> [WITH ...]
  • DROP CLUSTER <cluster> FROM WAREHOUSE <name>
  • RENAME CLUSTER <cluster> TO <new_cluster> IN WAREHOUSE <name>

Source File

/workspace/databend/src/query/sql/src/planner/binder/ddl/warehouse.rs

Relevant bind functions:

  • bind_resume_warehouse
  • bind_suspend_warehouse
  • bind_rename_warehouse
  • bind_add_warehouse_cluster
  • bind_drop_warehouse_cluster
  • bind_rename_warehouse_cluster

What They Do

  • RESUME/SUSPEND WAREHOUSE: Start or stop a warehouse (compute cluster), controlling resource usage and billing.
  • RENAME WAREHOUSE: Rename an existing warehouse.
  • ADD CLUSTER TO WAREHOUSE: Add a new cluster group to a warehouse with optional node configuration.
  • DROP CLUSTER FROM WAREHOUSE: Remove a cluster from a warehouse.
  • RENAME CLUSTER IN WAREHOUSE: Rename a cluster within a warehouse.

Note: INSPECT WAREHOUSE and SHOW ONLINE NODES are tracked separately in open PRs #3162 and #3161. ALTER WAREHOUSE ASSIGN/UNASSIGN NODES is tracked in PRs #3163/#3164.

Suggested Doc Location

/docs/en/sql-reference/10-sql-commands/00-ddl/19-warehouse/

New files to add:

  • resume-warehouse.md
  • suspend-warehouse.md
  • rename-warehouse.md
  • add-warehouse-cluster.md
  • drop-warehouse-cluster.md
  • rename-warehouse-cluster.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions