内容
<img src="media/tuplebase-wordmark-github-680.png" alt="TupleBase" width="340">
<br>
### 您的数据库工作空间，在 VS Code 中。
探索模式、编写查询、检查结果和回顾查询历史，无需离开编辑器。
TupleBase 在可提交的 `.tuplebase.json` 文件中保存连接配置，同时将凭证安全地存储在您的机器上。其内置的 MCP 服务器允许 AI 代理访问相同的连接，默认情况下阻止写入。
> TupleBase `0.1.0` 是一个预发布版本。PostgreSQL 是此首个公开版本中启用的引擎。
[从 VS Code 市场安装](https://marketplace.visualstudio.com/items?itemName=tuplebase.tuplebase) · [从 Open VSX 安装](https://open-vsx.org/extension/tuplebase/tuplebase)
<img src="media/tuplebase-overview.png" alt="TupleBase 在 VS Code 中，带有 PostgreSQL 模式、SQL 编辑器、查询历史和结果网格">
## 功能
- **浏览模式**，通过连接资源管理器，以项目定义的组组织。
- **在编写时运行 SQL**，使用 CodeLens 操作、`cmd+enter` / `ctrl+enter` 或整个文件执行。
- **检查结果**，在 VS Code 主题的网格中，带有分页和每行结构化详情视图。
- **将配置与项目保存在一起**，在注释友好的 `.tuplebase.json` 文件中，拒绝嵌入机密。
- **本地存储凭证**，通过 VS Code 秘密存储，带有可选的连接时提示凭证和 SSH 隧道。
- **控制写入**，在语句到达数据库之前，在组或连接级别。
- **返回到以前的工作**，通过每个工作区的查询历史和单击重新运行。
- **连接 AI 代理**，通过捆绑的独立 MCP 服务器。
## 开始使用
1. 从 [VS Code 市场](https://marketplace.visualstudio.com/items?itemName=tuplebase.tuplebase) 或 [Open VSX](https://open-vsx.org/extension/tuplebase/tuplebase) 安装 TupleBase 预发布版本。
2. 在 VS Code 中打开一个文件夹，选择 TupleBase 活动栏图标，然后选择 **创建配置**。
3. 从资源管理器添加 PostgreSQL 连接。TupleBase 将其非机密设置写入 `.tuplebase.json` 文件，并在您首次连接时提示输入密码。
4. 打开一个 `.sql` 文件，并使用 **运行** CodeLens 或 `cmd+enter` / `ctrl+enter`。TupleBase 记住为该文件选择的连接。
最小配置如下所示：
```jsonc
{
"version": 1,
"groups": {
"development": {
"readonly": true,
"app-db": {
"adapter": "postgres",
"host": "localhost",
"port": 5432,
"database": "app",
"user": "developer"
}
}
}
}
```
密码和私钥不应出现在该文件中。TupleBase 通过 VS Code 秘密存储保存凭证，并支持 `${env:VARIABLE}` 引用用于非机密配置值。
## 支持的引擎
**在 `0.1.0` 中可用：** PostgreSQL。**在下一个版本中：** MySQL 和 MariaDB。
SQLite、SQL Server、ClickHouse、Cassandra、Neo4j、MongoDB、Elasticsearch 和 OpenSearch、Kafka、Redis 和 DynamoDB 的适配器正在开发中。请参阅 [数据库支持矩阵](docs/DATABASES.md) 以获取其当前状态。
## 用于 AI 代理的 MCP
TupleBase 捆绑了一个独立的 [模型上下文协议](https://modelcontextprotocol.io/) 服务器，该服务器使用与扩展程序相同的连接和适配器。它为兼容的代理提供了三个工具：
- `list_connections` 列出已配置的连接及其安全设置。
- `inspect_schema` 在不发出临时发现查询的情况下探索数据库对象。
- `run_query` 执行语句并返回结构化行、列、时间计时和警告。
默认情况下，代理访问是只读的。允许写入需要 MCP 服务器选择加入和可写的目标连接。运行 **TupleBase：显示 MCP 服务器配置** 以生成客户端配置，并参阅 [MCP 指南](docs/MCP.md) 以获取设置和安全详细信息。
## 安全、隐私和支持
TupleBase 不收集遥测数据或将使用情况数据发送到 TupleBase。它仅连接到您配置的数据库和 SSH 端点。
- 通过 [GitHub 问题](https://github.com/TupleBase/tuplebase-vscode/issues) 报告错误和请求功能。
- 根据 [安全策略](SECURITY.md) 私下报告漏洞。
- 对于其他问题，请联系 [hello@tuplebase.app](mailto:hello@tuplebase.app)。
## 许可证
[MIT](LICENSE)。第三方组件及其许可证列在 [第三方通知](THIRD-PARTY-NOTICES) 中。数据库徽标来自 [devicon](https://github.com/devicons/devicon)（MIT）；数据库名称和徽标是其各自所有者的商标，用于指示兼容性。
