技术文档摘要
DevDb
<p align="center">
<a href="https://github.com/damms005/devdb-vscode/actions"><img alt="测试通过" src="https://img.shields.io/github/actions/workflow/status/damms005/devdb-vscode/deploy.yml?style=for-the-badge&logo=github&label=测试"></a>
<a href="https://marketplace.visualstudio.com/items?itemName=damms005.devdb"><img alt="VS Code Marketplace 安装量" src="https://img.shields.io/visual-studio-marketplace/i/damms005.devdb?style=for-the-badge&cacheSeconds=10800"></a>
<a href="https://marketplace.visualstudio.com/items?itemName=damms005.devdb&ssr=false#review-details"><img alt="VS Code Marketplace 评分" src="https://img.shields.io/visual-studio-marketplace/r/damms005.devdb?style=for-the-badge&cacheSeconds=10800"></a>
<a href="https://github.com/sponsors/damms005"><img alt="赞助" src="https://img.shields.io/badge/赞助-%E2%9D%A4-%23db61a2.svg?&logo=github&logoColor=white&labelColor=181717&style=for-the-badge"></a>
</p>
<p align="center">
<a href="https://marketplace.visualstudio.com/items?itemName=damms005.devdb">VS Code Marketplace 页面</a>
⋅
<a href="https://open-vsx.org/extension/damms005/devdb">Open VSX 注册表页面</a>
</p>
一个轻量级的 VS Code 扩展,自动加载您的数据库,并提供从数据库到开发和调试的支持。
由 💖 为开发者打造。
特别收录
<table>
<tr><td>
<a title="Laravel 新闻" href="https://laravel-news.com/devdb">
<img alt="Laravel 新闻" height="40" src="resources/featured/laravel-new.png" /></a>
</td>
<td>
<a title="DDEV 文档" href="https://ddev.readthedocs.io/en/latest/users/usage/database-management/#database-guis">
<img alt="DDEV 文档" height="40" src="resources/featured/ddev.png" />
</a>
</td>
<td>
<a title="每日开发" href="https://app.daily.dev/posts/JAhlsLY2E">
<img alt="每日开发" height="20" src="resources/featured/daily-dev.png" />
</a>
</td>
<td>
<a title="TestDevTools" href="https://testdev.tools/dev-db">
<img alt="TestDevTools" height="40" src="resources/featured/test-dev-tools.png" />
</a>
</td>
</tr>
</table>
最新功能
- 允许 IDE(VS Code、Cursor、Windsurf 等)对应用程序数据库执行 SQL 查询
- 新的零配置支持:在 DDEV 中运行的应用程序
- 新的零配置支持:Django、Ruby on Rails 和 Adonis(Lucid ORM)
赞助商
我们真诚地感谢以下 DevDb 的赞助商:
功能
-
MCP 服务器:向 AI 驱动的 IDE 和 MCP 客户端(如 Cursor、Windsurf 等)提供您的数据库信息。
-
快速打开表命令:按 Cmd+K Cmd+G(Mac)或 Ctrl+K Ctrl+G(Windows/Linux)快速打开任何表。
-
零配置数据库自动发现:自动发现并加载您的数据库——无需手动配置。支持环境包括 DDEV、Adonis、Laravel、容器化设置(Laravel Sail)等。
-
本地开发数据库支持:由于对数据库模式的深入了解,DevDb 可以提供有助于开发和调试的功能,例如一键生成 Eloquent 模型工厂等。
-
强大的 IDE 集成:DevDb 将您的数据库与 IDE 集成,提供非常有用的 IDE 驱动的功能,如上下文菜单和代码透镜集成,直接在编辑器中提供功能,如从代码中打开表,当进行查询优化任务时调用 SQL 查询解释器等。
-
丰富的数据库客户端与直观的用户体验:专用的数据库客户端视图,具有一键数据浏览、内联编辑、删除、一键重新连接等功能。轻松修改、设置值为 null、预览复杂的 JSON 数据,所有这些都在响应式界面中完成。
-
数据导出:导出表格数据为格式良好的 JSON 或 SQL 插入语句,复制到剪贴板或保存到文件。
-
全面的多数据库支持:无缝对接 SQLite、MySQL、MariaDB、PostgreSQL 和 Microsoft SQL Server;更多即将推出!
-
直观的配置系统:在无法使用自动 零配置 的环境中,DevDb 提供快速片段,生成格式良好的模板,以及 JSON Schema 验证智能感知,这使得创建连接数据库的配置文件成为一种愉快的体验。
-
集成框架与工具支持:针对流行的框架和工具(包括 Laravel、DDEV、Ruby on Rails 和 Adonis)的定制支持,确保无缝的开发体验。需要特定环境的功能吗?我们正在倾听!。
-
跨平台兼容性:设计用于在 Linux、macOS 和 Windows 上一致运行,确保最大灵活性,您可以在所有这些平台上继续工作。
截图

要求
- VS Code 1.83 或更高版本
- 使用任何 支持的数据库 的 VS Code 项目
操作系统/平台支持
- Linux *(Linux-x64, Linux-arm64, Linux-arm, Alpine-x64)
- macOS (Darwin-x64, Darwin-arm64 Apple Silicon)
- Windows (Win32-x64)
<small>
Ubuntu 20.04(包括等效发行版)及以下版本不被支持,因为它们已达到生命周期结束,并且不再支持 GitHub Actions 中的运行器。详情见 https://github.com/actions/runner-images/issues/11101
</small>
快速开始
- 在使用任何 支持的数据库 的 VS Code 项目中,确保您的数据库已正确配置并且可以从应用程序代码访问。
- 对于 零配置环境,DevDb 自动发现并 自动加载您的数据库。通过打开 DevDb 视图(如截图所示),或者通过 快捷键 查看您的数据库。
[!注意]
DevDb 还提供了多种 语言和框架集成
UI 操作和快捷键映射
Cmd + K + D 切换视图面板
Cmd + K + G 跳转到一个表
Cmd + 单击 侧边栏中的表名,在当前标签页中打开该表
Cmd + 单击 数据库值以编辑它
- 单击任何值以在窗格中预览它(对于查看漂亮的 JSON 字符串值很有用)
- 右侧窗格提供选项来查看当前表模式或所选值
- 在编辑会话期间(激活于数据编辑/删除期间),控制框如截图所示出现
- 在编辑会话期间:
Cmd + Z 撤销更改,Cmd + Y 重做更改,Cmd + S 保存更改
- 新增“建议新功能”按钮
一键操作(数据操作)
- 单击表行上的垃圾桶图标以删除它
- 单击数据库值上的
设为空 按钮将其值设为 null

支持的数据库
目前支持的数据库:
- SQLite
- MySQL
- MariaDB
- PostgreSQL
- Microsoft SQL Server
加载数据库
DevDb 可以使用 VS Code 工作区中的连接详细信息自动发现和加载您的数据库(零配置 模式)。当这种零配置自动发现不可用时,提供了一个 配置文件 选项。
1. 零配置(自动数据库发现)
当工作区根目录包含以下任意一项时,不需要 配置文件:
- 由 DDEV 管理的应用程序
- 使用默认 .env 配置的 MySQL 和 PostgreSQL 的 Adonis(带有 Lucid ORM)
- 使用 settings.py 配置的 SQLite、MySQL 和 PostgreSQL 的 Django
- 使用 config/database.yml 配置的 SQLite、MySQL 和 PostgreSQL 的 Ruby on Rails
- 使用默认本地 SQLite 数据库的 Laravel
- 使用默认 .env 配置的 MySQL/MariaDB、PostgreSQL 和 Microsoft SQL Server 的 Laravel
- 使用默认 .env/docker-compose.yml 配置的容器化 Laravel MySQL(Laravel Sail)(包括 开发容器 支持)
2. 基于配置的数据库加载
如果 零配置 不适用于您的环境,请在项目根目录下创建一个 .devdbrc 文件,其中包含您的数据库连接详细信息。
[!警告]
通过将 .devdbrc 配置文件添加到 .gitignore 来排除版本控制。这可以保护敏感信息,并允许团队成员使用不同的数据库配置。
配置文件应包含一个数据库连接对象数组。DevDb 提供了丰富的编辑功能用于 .devdbrc:
- JSON Schema 验证:自动配置验证
- 智能感知:所有字段的自动补全,包括
type
- 片段:快速配置模板:
devdb mysql:MySQL 配置
devdb mariadb:MariaDB 配置
devdb postgres:PostgreSQL 配置
devdb sqlite:SQLite 配置
devdb mssql:Microsoft SQL Server 配置
配置文件示例
[
{
"name": "我的测试 MySQL 数据库",
"type": "mysql",
"host": "127.0.0.1",
"port": "3306",
"username": "root",
"password": "12345",
"database": "test" // <-- 显示在 VS Code DevDb 视图中的数据库
},
{
"type": "sqlite",
"path": "/path/to/database.sqlite"
},
{
"name": "我的 MSSQL 数据库",
"type": "mssql",
"host": "localhost",
"port": "1433",
"username": "sa",
"password": "YourPassword123",
"database": "master",
"options": {
"trustServerCertificate": true
}
}
]
工具和框架集成
上下文菜单项
在任何框架/编程语言的编辑器中右键单击其名称/模型/实体,即可在 DevDb 中打开任何数据库表。
来自 Node.js 应用程序的示例

Laravel
Eloquent 模型代码透镜
DevDb 提供代码透镜功能:
- 查看 Eloquent 模型的基础表
- 为模型生成工厂(自动填充基础表的真实数据)

[!注意]
工厂生成也可通过上下文菜单获得
查询解释器
查询解释器与 MySQL Visual Explain 集成,通过分析 MySQL 的查询执行计划来优化 SQL 查询。使用方法:
- 打开包含 SQL 查询的 Laravel PHP 文件(Eloquent 或
DB 门面)
- 选择要分析的 SQL 查询
- 单击
解释查询 代码透镜或从上下文菜单中选择 解释查询
- 在浏览器中查看解释或复制 URL

[!注意]
VS Code 多根工作区 支持正在开发中。跟踪进度 这里。
<!-- TODO: 更新完成时 -->
MCP 配置
- 如截图所示,点击锤子图标复制 MCP 设置。
- 在您的 IDE 的 MCP 设置文件(例如
.vscode/mcp.json、windsurf/mcp_config.json 等)中,将复制的 JSON 作为可用的 MCP 服务器之一粘贴。
您的 IDE/AI 工具现在应该能够与您的应用程序数据库一起工作。

URI 处理程序
DevDb 提供自定义 URI 处理程序,允许您直接从外部应用或链接打开特定的数据库表。这对于将 DevDb 与其他工具集成或创建频繁访问表的快捷方式非常有用。
URI 格式
URI 格式遵循以下模式:
vscode://devdb/open/table?connectionId=123&database=main&table=users&workspace=...
参数:
connectionId:数据库连接的 ID
database:数据库名称
table:要打开的表名
workspace:(可选)工作区路径
支持
您可以通过 贡献 功能并提交 PR,或通过 赞助开发 来支持 DevDb 的开发。我们感激您的 DevDb 赞助,并提供奖励,您可以检查 赞助页面 获取可用的赞助选项。
您还可以通过使用我们的赞助商提供的服务来支持这个项目:
请务必查看 Damilola Olowookere 的 其他项目 以获取其他赞助选项。
贡献
[!重要]
目前贡献仅限于扩展核心代码。UI 代码暂不对公众开放贡献。
- 分叉此仓库并在本地克隆您的分叉
- 运行
bun install 安装依赖
- 对代码库进行贡献
- 按
F5 启动调试器并在本地测试更改
- 使用
bun run test-services 运行测试套件,并确保所有测试通过
- 将更改推送到您的分叉
- 打开此仓库的 PR
- 拿走您的鲜花! 💐🌺🌹