# db-g
**Repository Path**: gin9/db-g
## Basic Information
- **Project Name**: db-g
- **Description**: db desktop client via mygo
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-10-13
- **Last Updated**: 2026-11-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
简体中文 · English
# DB-G
[](https://awesomemygo.dev/apps/db-g)
对标 [db-k](https://github.com/Kuangcp/DB-K) 的数据库客户端(Go + mygo)。
**已完成与后续规划见 [`Roadmap.md`](Roadmap.md)**
## 为什么选 DB-G
**一个可执行文件,四个数据源,键盘上一路到底。**
DB-G 是本地优先的桌面数据库客户端:不装运行时、不连云端、不收集数据。下载后双击就是一个完整的 SQL 工作台,连接、查询、改数据、导出全部在本机完成。
- **开箱即用**:Windows / Linux 各一个独立可执行文件,无 Java、无 Electron、无 WebView 运行时;界面原生绘制,冷启动即用。
- **命令行打开 SQL**:`db-g -o /path/to/aa.sql`(可重复 `-o`),等价于把 `.sql` 文件拖入窗口;已有实例运行时会通过本机 IPC 转交给它并聚焦已有窗口,不再开新窗口;`db-g -version` 查看版本。
- **一个窗口四类库**:SQLite、MySQL、PostgreSQL、ClickHouse 共用对象树、补全、结果表格与导出流程,不必在几个客户端之间切换。
- **连接随手开关**:顶栏数据源名双击连接/断开;断开后圆点变灰、已加载的对象树保留,再双击重连并展开。
- **为键盘设计**:`Ctrl+Enter` 执行、`Ctrl+Tab` 切最近控制台、`Ctrl+Q` 看 DDL、`Ctrl+F` 查找,快捷键全部可改绑。
- **大库不卡**:对象按页加载 + 24 小时磁盘缓存,几万个对象也只查当前需要的那一页。
- **结果能干活**:结果钉住对比、单元格编辑单事务提交、JSON 树查看、CSV / JSON / SQL INSERT 导出。
- **数据留在本机**:连接密码 AES-256-GCM 本机加密,日志自动脱敏,无遥测、无账号。
## 截图
|
|
## 下载与运行
Release 页面提供安装包(GitHub / Gitee 均可):
| 平台 | 文件 | 运行要求 |
|---|---|---|
| Windows x64 | `db-g-setup-<版本>-amd64.exe` | Windows 10 / 11;每用户安装,支持签名自动更新 |
| Linux x64 | `db-g-<版本>-linux-amd64.tar.gz`(含 `install.sh`)或 `db-g_<版本>_amd64.deb` | GTK 3(Arch `gtk3`、Debian/Ubuntu `libgtk-3-0`、Fedora `gtk3`);归档解压后运行 `sh install.sh` 安装到用户目录 |
配置、日志与控制台文件默认落在 `~/.config/db-g/`(Windows 为 `%AppData%\db-g\`);
开发构建(`make run` / `make install`,没有 `releaseBuild` 标记)使用独立的 `~/.config/db-g.dev/`。
## 功能清单
- [x] 编辑器:mygo `ui/editor`(SQL 高亮、行号、查找替换 Ctrl+F、折叠、多光标、撤销;
百万行级视口布局,性能基准见 docs/spike-results.md 的 A1 一节);
编辑器/结果分隔线按窗口高度取比例,`Alt+D` 随时隐藏/显示结果区
- [x] 主窗口位置/大小记忆:退出时保存正常窗口的位置与尺寸,启动时恢复
(`window-state.json`,发布/开发构建目录隔离)
- [x] M1:打开 SQLite 文件、异步执行 SQL(Ctrl+Enter)、虚拟化结果表格
(行号/截断徽章/错误横幅/停止取消/500 行与 1MB 单格上限、可配置结果预算,默认 8MB)
- [x] M2:主页面布局对齐 db-k 骨架(侧栏/顶栏/单行工具栏);连接管理
(JSON 持久化/新建/编辑/删除/状态点);SQLite 对象树(懒加载)
- [x] 侧栏连接树:文件夹(可嵌套、新建/重命名/删除、同层重名拦截;删除时连接与
子文件夹上移到父级)、文件夹折叠与子项计数;每个数据源显示对应品牌图标;
连接行/文件夹行无边框,悬停浅底;**Ctrl+拖动**排序、把连接或文件夹拖入文件夹;
顶部搜索框按连接名/文件夹名/**已加载对象名**过滤并自动展开命中(只覆盖已加载对象);
连接弹窗可选所属文件夹;连接行右键菜单:**复制数据源**(同文件夹生成副本、
名称自动去重)、**删除连接**(仍需二次确认)
- [x] 大库元数据(对齐 db-k):先取各对象组计数,展开分组才按页加载(每页 1000、
单组最多 5000);查询在后台线程,连接/展开不再同步拉全量对象;
编辑器补全目录只取前 2000 条,避免 6 万张表把 UI 和补全拖死
- [x] 元数据磁盘缓存(对齐 db-k):`/db-g/meta/.json`,24h TTL;
连接身份指纹一致时展开零查询,过期先用后刷;删除连接、改目标地址、
手动「重载对象树」会自动清理缓存
- [x] 选区执行:仅执行编辑器选中的 SQL,无选区时禁用(禁止跑整个控制台)
- [x] 查询超时:连接弹窗按数据源配置(秒,空/0 = 默认 30,可设到 24h);
超时后主动取消驱动的语句并在结果区显示「查询超时(Ns),已取消」
- [x] 数据源:SQLite / MySQL / **PostgreSQL**(pgx)/ **ClickHouse**(只读优先)
—— 连接、执行、对象树、列目录(含主键)、补全、导出;四个驱动都实现了对象
DDL 查看;PostgreSQL / MySQL / ClickHouse 支持顶栏切换 schema/库(MySQL/CK 显示库名,
PG 显示「库.schema」),切换后补全、DDL、裸表名查询都跟随当前 schema;
MySQL 连接不填默认库时也能按库惰性加载对象与列目录;
PostgreSQL 支持写操作,ClickHouse 只读
- [x] 控制台 + 工作区:一个数据源多个命名控制台,每个绑定
`~/.config/db-g/consoles/-.sql`;标签条/工作区切换、防抖自动落盘(延迟可在设置里调,默认 5 秒)、
Ctrl+S 立即保存、重启恢复工作区与控制台正文/光标。**关闭标签(×)只是移出当前
工作区,文件保留**;右键「删除…」才删元数据与 .sql。侧栏每个数据源下列出它的
全部控制台,可重新打开。标签按「数据源 / 控制台」显示(单控制台时省略控制台名),
放不下的标签收进标签条末尾的 More 菜单,工作区切换器始终可见;**新建控制台只在
侧栏数据源下的入口**。**按住 Ctrl 拖动标签**调整工作区内顺序;**Ctrl+Tab** 在最近
使用的两个控制台之间切换(Alt-Tab 式)。
- [x] P1 日常查询闭环:
**多语句执行**(有选区跑选区、无选区跑光标语句;逐条顺序执行、失败即停、
结果按语句分 Tab、编辑器行底色标记语句状态);
**结果区**:**单元格级选择**(两级高亮:选中格最深、所在行浅色、其余行斑马纹
交替,`Ctrl+C` 复制选区(单格时只复制该格))、整行复制、右键「复制本行 → INSERT」;
`Ctrl+Shift+N` 把选中单元格(支持多格)设为 NULL,主键/只读列与 NOT NULL 列自动跳过;
多行多列选区右键「**复制选区**」子菜单(TSV / 含表头 TSV / CSV),或
「**导出选区**」子菜单导出为 CSV / JSON / SQL INSERT;
MySQL 的 `DATETIME`/`TIMESTAMP` 统一按 `YYYY-MM-DD HH:MM:SS[.ffffff]` 显示与复制,
复制本行 → INSERT 也使用该字面量;`DATE` 与其它数据源保持原格式;
表格单元格只渲染前 512 个字符(长文本以 `…` 结尾,避免每帧排版大字段),
Ctrl+C / 右键复制 / 查看器 / 编辑框仍取完整内容;
**查看完整内容**:双击单元格,合法 JSON 渲染成可折叠树(键排序、展开/收起、类型着色),
其它内容按原文本;复制/关闭按钮在标题栏右上角,复制左侧可切换自动折行,
右下角可拖拽调整弹窗大小,
窗口初始尺寸按内容自适应(短文本小窗口,长文本/复杂 JSON 最大 880×660);
**Ctrl+双击编辑**:短内容直接在结果表格里编辑(Enter/失焦提交、Escape 取消),
长内容或多行文本打开与查看器同尺寸、同样可调整大小的编辑窗口;右键表头排序(NULL 总在最后)与每列筛选、
**取更多**(派生表分页追加)、**导出** CSV / JSON / SQL INSERT
(含全量流式导出,重新执行查询;导出期间导出按钮旁显示进度与已写行数,关闭窗口会先确认);
**结果钉住**:图钉把查询结果固定成最左侧结果 Tab(仅查询结果,最多 10 个),
新执行时 pinned Tab 保留在左、新结果追加到右;切控制台各自保留,重启消失(内存态);
**刷新查询**:查询结果工具条最左侧的刷新按钮用该结果对应的 SQL 在原结果 Tab 里重跑,
写语句/DDL 等无结果集的执行不显示;
**常驻状态栏**(结果区底栏;Alt+D 隐藏结果、执行计划下也保留):显示当前数据库名、
数据源版本(连接后异步读取)、数据源标签,以及最近一次执行的耗时
(查询区分「执行 / 读取」两段;驱动在读行时同时上报进度);
每个数据源最多 3 个彩色标签,在连接弹窗里输入后 Enter 添加(可模糊搜索复用已有标签),
标签右侧 × 移除,点色块循环换色;
**SQL 历史**(每个数据源一个 `history/.jsonl`,最多保留 5000 条,
到 6000 条才惰性裁剪;面板展示最近 100 条可插入/复制,完整记录直接看文件);
**对象树**双击插入预览 SQL(复用该数据源已有控制台并追加带分号的 `SELECT ... LIMIT 200`,没有才新建;不自动执行)、右键查看 DDL(只读 SQL 编辑器:保守格式化 +
语法高亮 + 鼠标选中部分复制;选中对象后 `Ctrl+Q` 也可打开);
**保守 SQL 格式化**(只改空白与关键字大小写,可撤销)
- [x] M3(部分):多语句执行 + SQL 历史(语句级进度/gutter 状态已做,历史面板已做)
- [x] P2 写操作(M6):单表 + 主键的结果可编辑 —— Ctrl+双击改格(短内容就地编辑,
长内容弹窗)、增行(新增行可直接双击/编辑任意列,包括主键列;留空的列走库默认)、
删行(新增行可直接移除)、撤销;
提交前逐条参数化 SQL 预览,**单事务**执行,影响行数 ≠ 1 整体回滚;
JOIN / 视图 / 主键不在结果里 / 别名表达式列一律只读(工具条显示原因);
写操作需要驱动声明 `CapEditableResult` + 实现 `Transactional`(sqlite / mysql 均已实现)
- [x] 自动补全(A2):SQL 关键字/函数/类型 + 当前数据源的表/视图;打字自动弹,
`Ctrl+Space` 显式触发;表/视图目录按连接缓存(TTL 5 分钟,顶栏「设置」里
可手动「刷新补全缓存」);**关键字/类型/函数随数据源方言**(MySQL 的
AUTO_INCREMENT / ENGINE / GROUP_CONCAT,PostgreSQL 的 RETURNING / SERIAL,
ClickHouse 的 LowCardinality / DateTime64,SQLite 的 AUTOINCREMENT 等),
编辑器语法高亮同步使用同一份方言词表;列补全按**光标所在语句/子查询引用的表**提示
(FROM · JOIN · UPDATE · INTO,支持多表 JOIN、别名与 CTE 展开;**函数/表达式
括号内(sum、avg、coalesce、WHERE (…))也照常补列**;语句里没有表时不出列);
FROM/JOIN/UPDATE/INTO 后正在写表名时优先提示表/视图;相邻语句漏写分号时,
补全按行首 `SELECT`/`INSERT` 等关键字隔开,不会把下一条语句的表混进当前补全
- [x] 内联 AI 补全:编辑器里按 `Alt+\` 或点工具条「AI 补全」,按当前语句/光标上下文请求模型;
建议作为补全菜单第一项(Detail「AI」),Tab 才插入;光标/正文版本变化后旧建议自动丢弃
- [x] AI 助手(第一阶段):右侧可折叠、可拖动调整宽度的面板做 Chat-to-SQL,默认本地 Ollama、也可配置
任意 OpenAI-compatible 服务;默认只发送表结构 + 当前 SQL,样本/历史/错误日志逐项开启;
「查看上下文」列出最近 12 次 AI 请求(对话/修复/补全/计划/改写),展示发给模型的完整
system/user 消息与估算 token(只存内存,不写日志或磁盘);流式回复,生成的 SQL 需用户点「插入 SQL」才进入编辑器;
设置窗口「AI」分区先填服务地址与 API Key,再通过 OpenAI 协议的 `/models` 自动获取模型列表下拉选择;
获取失败或服务未返回时保留手动输入模型名;API Key 本机加密;会话按工作区保存,
支持多段历史切换与新建(搜索、滚动分页);标题默认取首条消息截取,可在设置里开关 AI 生成标题
- [x] 执行计划:顶栏「执行计划」按当前语句/选区跑 EXPLAIN,结果区展示统一计划树,
节点按代价着色并显示估算 rows、actual time/rows/loops、PG BUFFERS;支持 SQLite
`EXPLAIN QUERY PLAN`、PostgreSQL JSON、MySQL JSON/TREE、ClickHouse JSON,解析失败
回退原始结果;ANALYZE 每次确认且只允许 SELECT/WITH,只有 PostgreSQL / MySQL 显示
「ANALYZE 重跑」(SQLite / ClickHouse 无此能力);可一键把计划树交给 AI 做诊断
- [x] AI 改写选中 SQL:编辑器里选中 SQL 按 `Ctrl+K`(无选区时用光标所在语句)打开浮窗,
写诉求(如「只保留需要的列」「改成参数化查询」)后按 `Ctrl+Enter` 生成;diff 预览,
「替换选区」或「追加到选区后」由用户确认,原文被改过则拒绝应用;生成结果不自动执行;
每次生成都记入 AI 助手的会话历史(标题以改写要求开头,执行历史仍只记真实执行)
- [x] SQL 错误修复:执行失败横幅点「AI 修复」,把失败 SQL、驱动错误和涉及表结构发给模型;
结果用 diff 预览,用户点「应用修复」或「应用并执行」才改编辑器;模型没返回 SQL 代码块时明确报错
- [x] 高危 SQL 拦截:本地确定性规则检查 UPDATE/DELETE 无 WHERE、恒真条件、DROP/TRUNCATE;
默认弹窗提醒,连接档案可开启「高危 SQL 直接阻断」;不依赖 AI,AI 只负责解释
- [x] 安全与收尾(P4):连接密码 **AES-256-GCM 本机加密**(密钥 `/db-g/secret.key`,
0600;存量明文加载时自动加密回写,密钥变更导致解不开时给出警告并要求重填);
连接档案**导出/导入**(默认不含密码;导入去重、id 冲突重映射;设置窗口操作);
连接弹窗「复制」按 key: value 复制,**包含明文密码**;「测试连接」等待中可随时
**取消**;
侧栏状态点:灰=未连接、绿=连接中、红=打开失败(悬停看原因)。
- [x] 日志/诊断(P0):`~/.config/db-g/logs/YYYY-MM/YYYY-MM-DD_N.log`
(纯文本:时间、级别、标签、消息、key=value;一次启动一个文件,`0600`);
记录启动/连接/执行(SQL 截断到 200 字符,不再记录结果)/控制台/补全加载失败/panic
堆栈;设置窗口可打开日志目录。DSN 与密码字段自动脱敏。
- [x] Git 同步(数据源 + 控制台):设置窗口「同步」分区填仓库地址(支持自定义分支与 SSH 私钥,
留空用系统 ssh/agent),点「拉取」/「提交并推送」与 git 仓库双向同步连接、文件夹、工作区与
内部控制台 SQL;外部文件控制台、执行历史、缓存、光标与主题/快捷键/AI 配置不同步。
连接信息整条 AES-GCM 加密后进仓库(`db-g/connections/.enc`),控制台 SQL 明文;
本机 `sync.key` + 仓库 `key.kcv` 双重校验,错钥在解密/提交前中止。
提交前扫描 SQL 中的疑似明文凭据(URL 凭据、DDL 密码、私钥、已知密钥前缀等),
命中后必须二次确认才继续;占位符/变量/列名不误报,已确认项按 HMAC 指纹去重。
首次拉取自动 clone 仓库并检出配置分支后导入;后续拉取为 fetch/merge 后导入;
**拉取不会删除本地独有数据**(同 id 以远端为准,其余保留并提示数量,下次提交可共存);
提交为本地快照 commit → merge 远端(冲突中止)→ push;空库与首次覆盖都有守卫。
- [x] 快捷键:统一动作表 + 可改键(`keymap.json`,设置窗口里点「录制」改);
`Ctrl+Enter` 执行、`Ctrl+S` 保存、`Ctrl+C` 复制(编辑器内为复制文本、结果区为复制单元格)、
`Ctrl+Shift+N` 将结果区选中单元格设为 NULL、
`Ctrl+Y` 复制当前行、`Ctrl+D` 删除当前行/选区、`Ctrl+/` 注释/取消注释当前行(单光标时自动下移一行)、
`Ctrl+Shift+F` 格式化、
`Ctrl+Tab` 切换最近使用的控制台、`Alt+D` 显隐结果区、`Ctrl+Q` 查看所选对象 DDL、
`Alt+\` 请求 AI 内联补全、`Ctrl+K` AI 改写选中 SQL
- [x] 外观:基于 [Lobe UI](https://github.com/lobehub/lobe-ui) 设计 token(浅/深色成对生成)
的统一配色与层级;跟随系统 / 浅色 / 深色;配色方案(默认/海洋/森林/暖阳/自定义,
自定义可分别设置浅色与深色的背景/容器/边框/正文/次要文字)、强调色(默认/预设/自定义 hex)、
设置里可关闭 GPU 渲染改用 CPU 光栅化(重启生效,规避部分 Linux/X11 驱动的黑屏闪烁)、
间距密度、圆角、界面字号,修改即时生效并存 `~/.config/db-g/theme.json`;支持主题文件
导出/导入(带 app/version 校验,配色一并保存,非法字段逐项忽略);设置窗口「外观」分区实时预览。
隐藏系统标题栏,自绘可拖动标题栏(双击最大化),右上角依次是打开 SQL、历史、AI 助手、设置
与最小化/最大化/关闭;应用操作和窗口控制之间留有空隙;
无边框窗口按外观圆角裁剪(macOS / Windows 11),Windows 保留左右与底边缩放
- [x] 外部 SQL 文件:拖入 `.sql` 或顶栏「打开 SQL 文件…」后选择数据源绑定为临时控制台
(同一路径复用,不复制文件);8 MiB 上限,非 UTF-8 / 含 NUL / 非 `.sql` 直接拒绝;
写回时保留原文件 BOM、换行风格与权限;
编辑防抖自动写回原文件;每秒、窗口获得焦点、执行/保存前检查磁盘变化——
本地干净自动重载,本地有改动则暂停自动写并在编辑器上方提示
「重新加载 / 保留本地 / 另存为」,执行或保存前弹窗确认;
写盘前校验磁盘内容,绝不覆盖外部编辑;文件缺失不擅自重建(可重新创建/另存为),
启动时从工作区移除;删除控制台只解除绑定,保留用户文件
- [x] Linux 自举安装/升级(仅发布构建):`~/.config/db-g/bin/db-g` 或 `version` 不存在、
或当前运行版本更新时,顶栏设置图标右侧出现安装/升级图标;确认后把当前程序原子复制到
`bin/db-g`,写入 `version`(`build=10000` 数值 + 展示版本),并生成
`~/.local/share/applications/db-g.desktop` 与 `~/.local/share/icons/db-g.png`
(desktop 的 Icon 用绝对路径,不依赖图标缓存),之后可从应用菜单启动;
路径遵循 `XDG_CONFIG_HOME` / `XDG_DATA_HOME`
- [x] 发布与自动更新:推送 `v*` 标签后 GitHub Actions 并行构建 Linux/Windows、签名更新归档并发布
Release;应用内置 mygo 原生更新窗口,自动检查、下载、校验签名并在下次启动生效
- [x] 设置窗口:左右布局(外观 / 字体 / 快捷键 / 连接档案 / 日志 / 开发),左下角版本号;
与主窗口一致的无边框自绘标题栏(可拖动/双击最大化),大小与位置随 `window-state.json` 记忆;
编辑区、结果区、控制台标签、功能界面四套字体(字体族 + 字号,功能界面字号跟随外观),
修改即时生效,存 `~/.config/db-g/fonts.json`(旧 `editor.json` 自动迁移)
- [ ] M7:编辑器格式化(补全已完成:关键字/表/列)
## 构建与测试
```bash
export GO=$GOBIN/go1.27.3
CGO_ENABLED=0 $GO run . # 交互窗口(本机 cgo 链接有 .sframe 环境问题,统一关掉 cgo)
CGO_ENABLED=0 $GO test -p 1 ./... # 全量(含编辑器与结果网格基准;-p 1 避免并行包争 CPU 导致基准超限)
CGO_ENABLED=0 $GO test ./ui -run 'TestEditor.*Perf' -v # 只跑编辑器性能基准
$GO tool mygo vet . # UI 生命周期检查
make release # 生成 dist/ 下 Windows / Linux 发布二进制(版本号取自 git tag)
```
顶栏「设置」打开独立设置窗口(单例):编辑器信息(行数/字节/版本)与 3k/12k/100k
演示预设(写入当前激活控制台并立即落盘,性能自测用)。