hwc-dws-cli

华为云 DWS（Data Warehouse Service / GaussDB(DWS)）命令行工具，提供 SQL 执行、元数据查询、集群管理、SQL 调优、语义元数据构建与数据导入导出能力，适用于 DBA 与数据工程师日常运维与分析。

版本

hwc-dws-cli 1.0.1

功能特性

SQL 执行: psycopg2 直连 DWS，统一 Envelope 响应；EXPLAIN dry-run 支持。
SQL 守卫: PermissionGate — SELECT 默认放行；DML/DDL 需 --write；DROP/TRUNCATE 需 --write + --confirm-dangerous。
元数据管理: schemas / tables / columns / databases 查询，describe 富信息（8 段），DDL 与元数据导出。
语义构建: 8 阶段 pipeline（表发现 → 分布键 → 列注释 → UDF → 列采样 → 列画像 → 历史挖掘 → JOIN 推断），SQLite 存储。
集群管理: 77 条 DWS OpenAPI 端点，覆盖 list/show/configurations/audit/datasource/workload/scale-out/scale-up/vw/upgrade/sql-block/auto-vacuumfull/event/alarm/backup-dr。
API 透传: 通用 GET + list-quotas + list-projects，SDK-HMAC-SHA256 签名。
运维监控: ops 18 个只读 SQL 直查 + Autopilot API（metric/metric-list/host-list/alarm）。
数据导入导出: upload（批量 INSERT / COPY FROM STDIN）/ download / purge / resume / foreign 外表管理。
审计管理: audit show/search/clean + SQL/API 写操作审计（HMAC 链防篡改）。
SQL 调优: tune config 规则配置管理，118 条内置规则（46 语法 + 27 执行计划 + 11 PERFORMANCE 扩展 + 34 对象）+ 自定义规则。
加密: AES-256-GCM（机器指纹 + PBKDF2 派生），SK / proxy 密码 / 连接密码静态加密。

文档导航

安装

pip install, 环境要求

正式使用模式安装与依赖说明。

快速开始

config set, 首个 SQL, meta, cluster

5 分钟完成首次 SQL 查询与元数据查看。

配置

config.yaml, crypto.json, store.db

三层配置、加密与本地文件说明。

命令参考

10 个顶层命令, 208+ 子命令

完整命令树与使用示例。

快速示例

# 安装（pip 或源码目录安装脚本）
pip install hwc-dws-cli
# ./install.sh            # Linux / macOS
# .\install.ps1           # Windows (PowerShell)

# 引导式配置（8 步向导：AK/SK -> proxy -> region -> cluster
# -> endpoint -> credentials -> DB 连通性 -> API 连通性）
hwc-dws-cli config set

# 执行 SQL
hwc-dws-cli sql --exec "SELECT * FROM pg_tables LIMIT 5" --format table

# 查询元数据
hwc-dws-cli meta list-tables --schema public
hwc-dws-cli meta describe ads_live.ads_anchor_ranking

# 调用华为云 API
hwc-dws-cli api GET /v1.0/{project_id}/clusters

# 集群详情
hwc-dws-cli cluster show info

# 语义构建
hwc-dws-cli meta semantic build --schema public

# 运维监控
hwc-dws-cli ops session --format table

# 配置查看
hwc-dws-cli config show