综合介绍
SQL Chat 是一个开源的 SQL 查询和管理工具,旨在通过自然语言与数据库进行交互。用户可以通过聊天界面执行查询、修改、添加和删除等数据库操作。该工具支持多种数据库,包括 MySQL、PostgreSQL、MSSQL 和 TiDB,提供直观便捷的数据库管理体验。
功能列表
- 自然语言查询:通过聊天界面使用自然语言进行数据库查询和操作。
- 多数据库支持:兼容 MySQL、PostgreSQL、MSSQL 和 TiDB 等多种数据库。
- 自托管选项:支持通过 Docker 自托管,确保数据隐私和安全。
- 开源项目:代码开源,社区贡献活跃,持续更新和优化。
- 直观界面:简洁易用的用户界面,降低学习成本,提高工作效率。
使用帮助
安装流程
- Docker 安装:
- 确保已安装 Docker。
- 运行以下命令启动 SQL Chat:
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
- 如果需要连接到本地主机的数据库,请使用
host.docker.internal
作为数据库连接设置中的主机。
- 环境变量配置:
NEXTAUTH_SECRET
:任意字符串,用于身份验证。OPENAI_API_KEY
:从 OpenAI 获取的 API 密钥。
使用流程
- 启动应用:
- 访问
http://localhost:3000
打开 SQL Chat 界面。 - 登录后即可开始使用自然语言与数据库进行交互。
- 访问
- 执行查询:
- 在聊天框中输入自然语言查询,例如“查询所有用户数据”。
- SQL Chat 会自动将自然语言转换为 SQL 语句并执行查询,返回结果。
- 数据操作:
- 支持通过自然语言进行数据的添加、修改和删除操作。
- 例如,输入“添加一个新用户,名字为张三,年龄为30”,SQL Chat 会生成相应的 SQL 语句并执行。
- 自定义配置:
- 用户可以根据需要自定义 SQL Chat 的配置,例如更改数据库连接设置或调整界面显示选项。
数据隐私
- SQL Chat 支持自托管,用户可以选择将应用部署在自己的服务器上,确保数据隐私和安全。
- 使用 sqlchat.ai 连接数据库时,需要将
0.0.0.0
添加到数据库白名单 IP 中,以允许所有连接。