内容
# 我的数据库伴侣
[English](README.en.md) | 越南语
**与您的数据库聊天。** 用自然语言提问,根据真实的SQL获得答案,无需手动编写查询。

---
## 为什么我创建了这个产品
这个产品是为DevOps/DBA管理的生产环境中的大型数据库而设计的,他们每天都会收到来自业务、产品、财务部门的临时数据请求。现有的仪表盘通常不够灵活,无法提供所需的数据切片。每次手动编写SQL查询又非常耗时,尤其是在系统包含多个表格且业务逻辑复杂的情况下。
问题不在于将问题转换为SQL。当前的LLM(大型语言模型)已经能够很好地完成这项工作。问题在于为AI提供正确的上下文,以确保生成的SQL查询准确无误。例如,“usr_stat_cd”代表什么,“活跃客户”映射到哪个数据库结构?这些约定可能只存在于DBA的脑海中,并未在数据库模式中体现。LLM可以猜测常见的缩写,但无法理解专有的枚举代码或特定系统的知识。因此,用户需要逐渐积累和补充这些知识。
因此,我的数据库伴侣并不依赖于文本到SQL的转换。相反,它依赖于用户随着时间积累的上下文层(词汇表、模式注释、已验证查询),以便AI更好地理解您的系统。
由于这是一个生产环境的数据库,安全性是必不可少的条件,而不仅仅是一个附加功能:多层只读访问、所有查询通过审核点、凭证加密、所有运行都有审计日志。
---
## 开始使用
| 您是… | 请阅读以下内容 |
|---|---|
| **用户**,希望自行安装和使用 | [使用指南(中文)](docs/user-guide.md) |
| **请求AI代理安装**(“阅读此文件后安装并指导我”) | [`docs/agent-setup.md`](docs/agent-setup.md) |
| 希望查看**功能 + 技术栈 + 安全模型** | [功能和技术参考](docs/features.md) |
快速安装(需要Docker):
```bash
./setup.sh # 创建.env文件,生成加密密钥,询问OpenRouter密钥
docker compose --profile full up # 应用程序 + 数据库 + 自动迁移 → http://localhost:3000
```
---
## 许可
根据 **[PolyForm Noncommercial License 1.0.0](LICENSE.md)** 发布 - 免费用于 **非商业** (个人、教育、研究、非营利组织)目的。
**用于商业目的需要单独的许可证 - 请联系作者 phucnt0@gmail.com.**
版权所有 © 2026 重量级福克([phuc-nt](https://github.com/phuc-nt))。