sqlchat

项目介绍：SQL Chat

项目概述

SQL Chat 是一款基于聊天的 SQL 客户端，允许用户通过自然语言与数据库进行交互，实现数据库的查询、修改、添加和删除等操作。利用这种自然语言交互界面，用户无需处理复杂的 UI 控件，只需通过聊天进行数据库操作，让数据库管理变得更加便捷和直观。

项目背景

随着开发者工具进入 2.0 时代，使用基于聊天的界面来重建现有工具成为了一种趋势。SQL Chat 正是在这样的背景下诞生的。相比传统的操作界面，聊天型界面更加符合用户习惯，提高了操作的直观性和使用体验。

技术实现

SQL Chat 基于 Next.js 构建，目前支持以下数据库类型，并将逐步支持更多数据库：

• MySQL
• PostgreSQL
• MSSQL
• TiDB Cloud

使用方式

1. 线上服务：sqlchat.ai 可以连接到用户的数据库。在使用时需要在数据库的白名单 IP 中加入 0.0.0.0 以允许所有连接。

2. 自托管：支持通过 Docker 进行自托管，只需配置必要的环境变量，如 NEXTAUTH_SECRET 和 OPENAI_API_KEY，即可运行。

docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET="$(openssl rand -hex 5)" --env OPENAI_API_KEY=<<YOUR OPENAI KEY>> -p 3000:3000 --hostname localhost sqlchat/sqlchat

3. 本地开发：开发人员可以在本地安装依赖并生成 Prisma 客户端，以便进行本地测试或开发。

数据隐私

SQL Chat 非常注重用户的数据隐私。更多信息可以查看 SQL Chat 隐私政策。

启动选项

• 如果只为个人使用，则无需数据库即可运行。
• 若希望提供类似于 sqlchat.ai 的服务，则需要使用数据库以储存账户和使用信息。

社区与支持

SQL Chat 还拥有活跃的社区支持，用户可以通过 Discord 与其他用户交流互动，也可以在 Twitter 上关注项目的最新更新。

许可证

该项目在 BSL 许可证下发布，详细信息请查看 LICENSE 文件。

常见错误及解决方案

1. 超出配额：如果 OpenAI 密钥的配额耗尽，请检查 OpenAI 账户的具体信息。
2. 请求失败：确保网络连接畅通，能够访问 OpenAI API 终端。

以上即为关于 SQL Chat 项目的详细介绍，期望能够帮助用户更好地理解和使用这一工具！