SQL Chat 是一个基于聊天的 SQL 客户端,使用自然语言与数据库以沟通的方式,实现对数据库的查询、修改、新增、删除等操作。
随着我们进入 开发者工具 2.0 时代,使用基于聊天的界面重建现有工具的机会非常大。SQL Client 也不例外。与在许多 UI 控件之间导航不同,基于聊天的界面更加直观。当然,前提是那可行,而我们的目标就是提供这种体验。
SQL Chat 是由 Next.js 构建的,它支持以下数据库,并将随着时间的推移支持更多:
- MySQL
- PostgreSQL
- MSSQL
- TiDB Cloud
-
所有数据库连接配置都本地存储在浏览器中,您也可以访问设置到清除数据。
-
只有数据库模式提供给 OpenAI API,表数据不会提供给 OpenAI API。
-
如果使用 sqlchat.ai, 它会记录下这些匿名对话。
如果使用 sqlchat.ai 连接数据库,则需要在数据库白名单 I P 中添加 0.0.0.0(允许所有连接)。因为 sqlchat.ai 托管在 Vercel 上 使用动态 IP。如果这是一个问题,请考虑下面的自主机选项。
docker run --name sqlchat --platform linux/amd64 -env NEXTAUTH_SECRET=xxx -p 3000:3000 sqlchat/sqlchat
NEXT_PUBLIC_ALLOW_SELF_OPENAI_KEY
: 设置为true
如果你允许用户提供自己的 OpenAI API key.OPENAI_API_KEY
: OpenAI API Key,通过这里申请。OPENAI_API_ENDPOINT
: OpenAI API 端点,默认为https://api.openai.com
。
NEXT_PUBLIC_DATABASE_LESS
: 设置为true
如果你想让 SQL Chat 运行时不需要数据库。这个会关闭如下功能:- 账户系统。
- 用户额度控制。
- 支付。
- 使用数据收集。
DATABASE_URL
: 只有在 NEXT_PUBLIC_DATABASE_LESS 为 true 时有效。Postgres 数据库连接串 e.g.postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat
.
docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET=xxx --env OPENAI_API_KEY=yyy --env OPENAI_API_ENDPOINT=zzz -p 3000:3000 sqlchat/sqlchat
-
安装依赖项
pnpm i
-
复制示例环境变量文件;
cp .env.example .env
-
生成
prisma
客户端pnpm prisma generate
-
将您的 API 密钥 和
OpenAI API
端点(可选)添加到新创建的.env
文件;
-
启动 Postgres 实例。对于 mac,您可以使用 StackbBricks, DBngin 或者 Postgres.app。
-
创建一个数据库:
CREATE DATABASE sqlchat;
在
.env
文件中, 将连接字符串分配给环境变量DATABASE_URL
和DATABASE_DIRECT_URL
。至于需要两个 URL 的原因见此. -
设置数据库 schema
pnpm prisma migrate dev
- 初始化数据(可选)
pnpm prisma db seed
本项目使用 BSL 许可证。请参阅 LICENSE 文件以获取完整的许可文本。
如何自托管 SQL Chat?
如何使用我的 OpenAI API 密钥?
-
您可以在环境变量中设置
OPENAI_API_KEY
。docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx -p 3000:3000 sqlchat/sqlchat
-
您可以在设置对话框中设置
OPENAI_API_KEY
。
它总是说我有网络连接问题?
请确保您有一个稳定的网络连接,可以访问 OpenAI API 端点。
ping api.openai.com
如果您无法访问 OpenAI API 端点,您可以尝试在 UI 或环境变量中设置 OPENAI_API_ENDPOINT
。
You exceeded your current quota, please check your plan and billing details
这个表示你自己提供的 OpenAI Key 的 Quota 没有了。请查看自己的 OpenAI 账号。