SQLQuay原名 Database Workbench。独立实现的 VS Code 只读 SQL 工作台。JDBC 与 DMS 使用同一套连接表单、数据库对象树、绑定 SQL 编辑器和多结果面板与会话内查询历史。
当前发行范围离线 Demo 可直接使用。在线连接当前支持 macOS / Linux，随扩展附带 MIT 许可的只读策略，无需下载私人脚本。JDBC 需要 Java 8+、Python 3.10+ 和可信 JDBC 驱动；DMS 需要 Python 3.10+、已配置的阿里云 CLI 及现有 DMS 插件。Windows 当前可用离线 Demo，在线通道暂未支持。 正式发行 ID 为 TomMajor.sqlquay，保留 版本记录 · GitHub 维护与 Marketplace 上架 先用离线 Demo 跑通
用 JDBC 读你自己的数据库在 VS Code 用户设置中把 在 Database 标题右侧点 +，选择 JDBC，再选择 MySQL 或 Apache Doris / SelectDB，填写主机、端口、精确库名和只读账号。Save 只保存，Connect 先读取当前库的表清单、成功后保存。密码只由 VS Code SecretStorage 保存，不进入连接清单或命令参数。JDBC 默认使用 TLS → Verify server identity，加密并校验服务器证书与主机名。对于不提供 TLS 的端点，可以在单条连接里显式选 Disabled (unencrypted) 并确认。此模式不验证服务端身份，SQL 和结果不加密；公网生产优先用 DMS。原连接保留默认校验，查询失败不会自动切换 TLS 模式。切换或编辑连接后，原查询编辑器不会无提示改绑。 普通数据查询须使用有界谓词；MySQL 源表要有可核实的前导索引，扫描计划上限 10 万行；Doris / SelectDB 仅支持已识别的内部 OLAP 扫描，上限 1000 万行。 用 DMS 读已核实的库先在本机安装阿里云官方 CLI 和 在 Database → + → DMS 选择 CLI profile。插件只通过 没有 profile 时，点 Configure CLI authentication…，在打开的本机终端中把示例 填写 Search keyword（DMS 搜索关键词）、Schema（精确库名）、Database ID（已核实的 DMS 数字 ID）。Save 只保存；Connect 读取表清单后保存。打开 New Query 可先运行 DMS 使用所选 profile 和 region 调用本机 CLI 与附带的 直接执行已有 SQL 文件打开本地 SQL 文件，点击状态栏的 选择执行连接 或编辑器右上的数据库图标，选择 JDBC 或 DMS。随后按 执行连接按文件保存在工作区状态，重开该文件仍可使用；不改 SQL 内容。状态栏始终显示当前文件的连接、库和通道。已明确选择的执行连接也用于该文件的悬停和预览。原有单文件预览选择和工作区默认预览连接仍只负责预览，不会自动成为执行连接。 只改连接名称、分组或 DMS 搜索关键词，不会让原绑定失效。修改库、地址、端口、DMS Database ID、CLI profile/region、TLS 或认证后，仍须重新选择连接；不自动换库或重跑。 多结果、固定与会话历史普通 SQL、表数据预览和 Properties 各自打开新结果页。结果工具栏点 固定结果，关闭面板后仍可从 会话历史 恢复；恢复只读取内存，不重新执行 SQL，也不会切换文件连接。侧栏标题的历史图标及命令 会话查询历史 都能打开列表。 固定、取消固定和同一结果的状态更新会保留输入框中尚未执行的 SQL 编辑；会话历史记录的仍是实际执行的 SQL。 每个扩展宿主会话最多保留 20 份结果。只淘汰已关闭、未固定的最旧记录；打开或固定的结果不被替换。若 20 份都打开或固定，先关闭或取消固定，再运行新查询。清除已关闭且未固定的会话历史 不影响打开或固定结果。SQL 和结果不写历史文件，重载窗口后会话历史清空。 表名搜索与元数据补全侧栏搜索图标或 Tables 节点右键的 搜索已加载的表 会筛选内存中的表清单。选中后定位对象树，不发数据查询；尚未加载表清单时先用 Load / Refresh Tables。 SQL 的 FROM/JOIN 后可补全表名；输入表别名加点（例如 函数括号内和相关子查询可解析可见的表别名；内层别名优先，内层 CTE 不会遮蔽外层物理表。别名与库名相同时先按别名补全字段。 常用文件中的嵌入 SQL支持 Markdown 的 sql/mysql/pgsql 等 SQL 代码围栏、Python 三引号字符串、Java 文本块，以及 JavaScript/TypeScript 的反引号模板字符串。把光标放在静态 SQL 块内，用编辑器的 Run SQL 或右键运行；悬停表名即可预览 DDL，并可点击 预览数据。每份文件独立选择连接。 不运行 Python/Java/JavaScript，不解析 f-string 或模板插值，也不解码宿主转义。动态字符串、含反斜杠转义或未闭合代码块不自动识别。其他文本格式可手动选中纯 SQL 后用右键或命令运行；模板参数必须先明确化。非 SQL 文件不接管 JS/TS 正则字面量中的反引号文字不会被当作 SQL 模板；普通除法表达式不影响后续静态 SQL 模板的识别。 悬停查看表定义打开已有的本地 在 SQLQuay → Database 列表顶部点击 DDL 默认预览连接，给工作区内未单独设置的 SQL 文件指定默认连接。显式执行连接优先，其次是文件单独预览设置，最后是工作区默认。可用 选择表定义预览连接 更换或清除单文件预览设置；这些预览设置不改变 Run SQL 的绑定。 首次停在未缓存的表名上时，Workbench 用当前预览连接执行只读 点悬停卡片里的 预览数据，直接在 Query Result 看最多 100 行。不需要选字段；Workbench 只读取当前连接下单张物理表的显式非敏感列，不添加筛选或排序。JDBC 和 DMS 都先对不含 LIMIT 的扫描做 EXPLAIN，使用相同的扫描阈值和全机查询锁；估算不明或超限时拒绝预览，超时不重试。DMS 的专用预览入口复用已批准执行器的目标核对和 AI Mode 清理，普通 SQL 仍走原预检。 两种连接的运行行为连接方式在新建时选择，已有连接仍使用原方式；若要换方式，为同一目标另建连接。编辑器和结果页的重跑使用绑定连接，不会因为切换侧栏或查询失败而改走另一通道。两种方式均使用本机共享查询锁，超时不重试。DMS 超时或清理失败、以及任一方式服务端状态未知时，Workbench 暂停两个在线通道；先核对服务端终态（DMS 还需核对 AI Mode 已关闭），再用 Confirm Online Query Ended and Unlock 解锁。 结果只保存在会话内存，普通查询最多展示已返回的 200 行，表预览最多 100 行。行数显示“已加载”，不充当表总数；筛选、排序、复制和翻页只操作已加载行。数值列按精确值排序，不把长整数或 Decimal 转为浮点数；NULL 升序在前、降序在后。DMS 不提供列类型时，仅在该列全部非空值都是数字格式时按数值排序。 分阶段耗时与连接复用取舍JDBC 与 DMS 返回本次测量的连接、预检、执行耗时；结果页另列总耗时及其他开销。连接阶段包含桥接启动或 DMS 认证与目标解析；预检包含结构验证和 EXPLAIN。其他开销包含本地处理、传输和清理。未得到完整阶段指标时不展示分阶段数值，避免把未知耗时显示成 0。Demo 不显示数据库阶段耗时。 本版保留一次用户操作一个受控生命周期。DMS 必须在操作后关闭 AI Mode，不跨操作保持认证会话；JDBC 长驻桥接需要处理断线、连接配置变更和超时隔离。先用新指标观察真实操作，再决定是否引入长驻桥接；不通过删除预检或复用过去的 EXPLAIN 来降低耗时。 开发开发需要 Node.js 22+、JDK 8+、Python 3.10+。先运行 GitHub CI 安装锁定的开发依赖，检查公开内容、运行单测和两种通道的离线夹具，再构建 VSIX。夹具使用随仓库分发的策略、合成驱动与假 CLI，不访问真实数据库或本机账号。 仓库中的数据测试及截图只用合成数据。数据库连接和密码由本机 VS Code 保存，结果及历史只存会话内存；这些内容不提交仓库。请勿把真实账号、连接地址、业务 SQL、日志或含真实数据的截图放进 Issue 或提交。
|
