命令参考

hwc-dws-cli 由 Click 构建，根命令为 cli，注册 10 个顶层命令。所有命令自动注入全局选项，可在命令行的任意位置使用。

顶层命令

全局选项

以下选项由 FlexibleFormatGroup 自动注入到所有子命令，可在命令任意位置使用（前缀 / 命令后 / 参数后）：

sql — SQL 执行

参数：--exec <SQL> / --file <path>（二选一）、--param（可重复）、--dry-run

# 执行查询（默认 JSON Envelope 输出）
hwc-dws-cli sql --exec "SELECT current_database()" --format table

# 执行 SQL 文件
hwc-dws-cli sql --file script.sql

# EXPLAIN VERBOSE 干跑，不实际执行
hwc-dws-cli sql --exec "DELETE FROM t WHERE id=1" --dry-run

# 写操作
hwc-dws-cli sql --exec "INSERT INTO t VALUES (1)" --write

# 危险操作
hwc-dws-cli sql --exec "DROP TABLE t" --write --confirm-dangerous

check-con — 连接检查

hwc-dws-cli check-con --format table

config — 配置管理

meta — 元数据查询

hwc-dws-cli meta list-tables --schema public
hwc-dws-cli meta describe ads_live.ads_anchor_ranking --format table
hwc-dws-cli meta describe ads_anchor_ranking --schema ads_live

meta semantic — 语义元数据

hwc-dws-cli meta semantic build --schema public
hwc-dws-cli meta semantic show demo --schema public --scope table

audit — 审计管理

hwc-dws-cli audit show --limit 50 --action SQL
hwc-dws-cli audit search --action API --from 2026-10-01 --to 2026-10-13
hwc-dws-cli audit clean --days 7

cluster — 集群管理

只读查询命令组，全部基于 gateway/api_defs.py 的 77 条 DWS OpenAPI 端点。集群 ID 自动从 config 注入，可用 --cluster-id 覆盖。--dry-run 输出 endpoint/path/params 预览。

hwc-dws-cli cluster list clusters --format table
hwc-dws-cli cluster show info --cluster-id xxx-xxx-xxx
hwc-dws-cli cluster workload pools show my_pool
hwc-dws-cli cluster backup-dr snapshots
hwc-dws-cli cluster show info --dry-run   # 预览 API 调用

api — API 透传

hwc-dws-cli api GET /v1.0/{project_id}/clusters
hwc-dws-cli api GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots
hwc-dws-cli api list-quotas

data — 数据导入导出

hwc-dws-cli data upload --file data.csv --table fact_sales --schema dwd
hwc-dws-cli data upload --file big.csv --table fact --copy --copy-options "delimiter=|,null=\\N"
hwc-dws-cli data download --query "SELECT * FROM fact_sales" --file out.csv
hwc-dws-cli data purge --table stg_sales --confirm-dangerous

ops — 运维监控

ops --help 分两段展示：SQL 直查（集群实时状态）与 Autopilot API（DMS 监控）。

SQL 直查（18 个只读命令）

Autopilot API（DMS 监控）

hwc-dws-cli ops session --format table
hwc-dws-cli ops topsql --limit 20
hwc-dws-cli ops metric cpu_usage --format table
hwc-dws-cli ops host-list --format table
hwc-dws-cli ops alarm search --severity urgent --format table

tune — SQL 调优配置

hwc-dws-cli tune config show
hwc-dws-cli tune config set global.tuning.disabled_rules "UPR-001,UOR-15"
hwc-dws-cli tune config add-rule --file custom_rule.yaml
hwc-dws-cli tune config remove-rule "CUSTOM-001"

退出码

退出码由 Envelope.exit_code 映射：