Skip to content

Latest commit

 

History

History
156 lines (97 loc) · 4.95 KB

File metadata and controls

156 lines (97 loc) · 4.95 KB

SQL Chat banner

SQL Chat

vercel

English | 中文

介绍

SQLChat是一个基于聊天的SQL客户端,使用自然语言向数据库提问和查询数据库。

Screenshot

Screenshot

Why

随着我们进入 开发者工具2.0时代,使用基于聊天的界面重建现有工具的机会非常大。SQL Client也不例外。与在许多UI控件之间导航不同,基于聊天的界面更加直观。当然,前提是那可行,而我们的目标就是提供这种体验。

How

SQLChat是由 Next.js 构建的,它支持以下数据库,并将随着时间的推移支持更多:

  • MySQL
  • PostgreSQL
  • MSSQL

数据保密

  • 所有数据库连接配置都本地存储在浏览器中,您也可以访问设置到清除数据。

  • 只有数据库模式提供给OpenAI API,表数据不会提供给OpenAI API。

  • 如果使用 sqlchat.ai, 它会记录下这些匿名对话。

IP白名单

如果使用 sqlchat.ai 连接数据库,则需要在数据库白名单IP中添加0.0.0.0(允许所有连接)。因为sqlchat。AI托管在 Vercel使用动态IP。如果这是一个问题,请考虑下面的自主机选项。

使用Docker自托管

docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat

您可以设置以下环境变量来定制部署:

  • OPENAI_API_KEY: OpenAI API密钥,从 here 获取。
  • OPENAI_API_ENDPOINT: OpenAI API端点,默认为 https://api.openai.com
docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env OPENAI_API_ENDPOINT=yyy -p 3000:3000 sqlchat/sqlchat

本地开发环境

  1. 复制示例环境变量文件;

    cp .env.example .env
  2. 将您的 API密钥OpenAI API 端点(可选)添加到新创建的 .env 文件;

  3. 安装依赖项并启动开发服务器;

    pnpm i && pnpm dev

数据库安装

  1. 安装依赖

    pnpm i
  2. 从模型生成 prisma 客户端

    pnpm prisma generate
  3. 添加初始的数据

    pnpm prisma db seed

Star历史

Star History Chart

社区

Hang out on Discord

Follow us on Twitter

sqlchat

赞助商

许可

本项目使用BSL许可证。请参阅 LICENSE 文件以获取完整的许可文本。

常见问题

如何自托管SQL聊天?

  • 您可以一键将 SQLChat 部署到 Vercel

    vercel

  • 您可以在几秒钟内使用 Docker 部署 SQLChat

    docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat

如何使用我的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端点。如果您无法访问OpenAI API端点,您可以尝试在UI或环境变量中设置 OPENAI_API_ENDPOINT