⚠️ 警告：gscli 仅适用于华为云 GaussDB 数据库，不兼容 PostgreSQL 及其他数据库。
GaussDB 命令行客户端，支持自动补全、语法高亮和 GaussDB 特有功能。
gscli 基于 pgcli (v3.4.1) 深度改造，专为 华为云 GaussDB 数据库设计。使用 GaussDB 官方 psycopg2 驱动，支持 SSL 安全连接。
核心功能：
- SQL 自动补全（关键字、表名、列名、函数、Schema）
- 语法高亮（基于 Pygments）
- 多行编辑、命令历史、可配置提示符
- 多种输出格式（grid、csv、vertical 等）
GaussDB 专属功能：
- 兼容模式自动检测（Oracle A / MySQL B,M / PostgreSQL C）
- 分布式部署支持（节点信息、数据分片查询）
- 工作负载管理（资源池查看）
- 性能诊断快捷命令（基于
dbe_perf视图） - 20+ 个反斜杠命令，含 6 个 GaussDB 专属命令
连接与安全：
- GaussDB SSL 连接（sslmode/sslcert/sslkey/sslrootcert）
- SSH 隧道支持
- 输入校验防止 SQL 注入
pip install gscli连接 GaussDB 数据库：
# 非 SSL 连接
gscli -h <host> -p <port> -U <user> -d <database>
# SSL 连接（verify-ca 模式）
gscli -h <host> -p <port> -U <user> -d <database> \
--sslmode verify-ca \
--sslrootcert /path/to/ca.pem
# 带客户端证书的 SSL 连接
gscli -h <host> -p <port> -U <user> -d <database> \
--sslmode verify-ca \
--sslcert /path/to/client-cert.pem \
--sslkey /path/to/client-key.pem \
--sslrootcert /path/to/ca.pem
# 使用 DSN 连接
gscli 'gaussdb://user:password@host:port/database'连接后自动检测：
Server: GaussDB (version)
兼容模式: Oracle (A) / MySQL (B/M) / PostgreSQL (C)
分布式: 是/否
通用命令：
| 命令 | 说明 |
|---|---|
\l |
列出所有数据库 |
\dt [+] [模式] |
列出表 |
\di [+] [模式] |
列出索引 |
\dv [+] [模式] |
列出视图 |
\ds [+] [模式] |
列出序列 |
\df [+] [模式] |
列出函数 |
\dn [+] |
列出 Schema |
\du [+] |
列出用户/角色 |
\d [+] [表名] |
查看表结构 |
\encoding |
显示客户端编码 |
\c [db [user [host port]]] |
切换数据库连接 |
\x |
切换扩展/垂直显示模式 |
\o [文件名] |
将查询结果输出到文件 |
\conninfo |
显示当前连接信息 |
\T [格式] |
更改输出表格格式 |
\i 文件名 |
从文件执行 SQL |
\e [文件名] |
在外部编辑器中编辑查询 |
\watch [秒数] |
重复执行查询（默认间隔 2s） |
\q |
退出 gscli |
\? |
显示所有命令帮助 |
\# |
刷新自动补全 |
GaussDB 专属命令：
| 命令 | 说明 |
|---|---|
\version |
显示 GaussDB 版本信息 |
\compat |
显示当前数据库兼容模式 |
\nodes |
显示分布式节点信息 |
\perf |
显示性能统计（pg_stat_database） |
\workload |
显示工作负载/资源池信息 |
\dist <表名> |
显示表分布信息 |
配置文件位置：
- Linux/macOS:
~/.config/gscli/config - Windows:
%USERPROFILE%\AppData\Local\dbcli\gscli\config
配置文件支持自定义：
- 关键字大小写策略（
keyword_casing） - 表格式（
table_format） - 多行模式（
multi_line） - 滚动条、颜色主题
- DSN 别名（
[alias_dsn]段） - SSL 默认参数
gscli 支持 GaussDB SSL 连接，详见 华为云 GaussDB 开发指南。
SSL 参数可通过以下方式指定：
- 命令行选项：
--sslmode,--sslcert,--sslkey,--sslrootcert - 环境变量：
GSSLMODE,GSSLCERT,GSSLKEY,GSSLROOTCERT - 配置文件：
~/.config/gscli/config
SSL 模式说明：
disable- 不使用 SSLallow- 服务器要求时尝试 SSLprefer- 优先使用 SSL（默认行为）require- 强制 SSL，不验证服务器证书verify-ca- 强制 SSL，验证服务器 CA 证书verify-full- 强制 SSL，验证服务器身份（GaussDB 暂不支持）
连接参数：
GSHOST- 数据库主机GSPORT- 数据库端口GSDATABASE- 数据库名GSUSER- 用户名GSPASSWORD- 密码
SSL 参数：
GSSLMODE- SSL 模式GSSLCERT- 客户端证书路径GSSLKEY- 客户端密钥路径GSSLROOTCERT- 根 CA 证书路径
其他：
GSLIRC- 配置文件路径GSSERVICE- 服务名（gs_service.conf 风格）GSROWLIMIT- 行数限制EDITOR- 外部编辑器（用于\e命令）
- 仅支持 GaussDB：gscli 不兼容 PostgreSQL、Redshift 等数据库
- 深度 GaussDB 适配：移除 pgspecial 依赖，内置 GaussDB 专属反斜杠命令
- 兼容模式检测：连接时自动识别 Oracle/MySQL/PostgreSQL 兼容模式
- 分布式支持：查询分布式节点、数据分片信息
- 性能诊断：内置
\perf、\workload等快捷命令 - GaussDB 关键字：224 个 SQL 关键字、231 个函数、92 种数据类型
- 环境变量：
GS前缀替代PG - 配置路径：
~/.config/gscli/替代~/.config/pgcli/
- click >= 4.1
- Pygments >= 2.0
- prompt_toolkit >= 2.0.6
- sqlparse >= 0.3.0
- configobj >= 5.0.6
- pendulum >= 2.1.0
- cli_helpers >= 2.2.1
BSD License。详见 LICENSE.txt。
gscli 基于 pgcli 项目（v3.4.1）深度改造，专为华为云 GaussDB 数据库设计。