+0
Daily
5,856
stars
505
forks
35
watchers
107
prs
85
issues
0
releases
README
!SQL Chat banner
SQL Chat
English | 中文 | Español
What
SQL Chat is a chat-based SQL client, which uses natural language to communicate with the database to implement operations such as query, modification, addition, and deletion of the database.
!Screenshot
!Screenshot
!Screenshot
Why
As we enter the Developer Tools 2.0 era,
there is a massive opportunity to rebuild the existing tools using the chat-based interface. SQL Client
is no exception. Instead of navigating across many UI controls, a chat-based interface is much
more intuitive. Of course, only if that works, and our goal is to deliver that experience.
How
SQL Chat is built by Next.js, it supports the following databases and will add more over time:
- MySQL
- PostgreSQL
- MSSQL
- TiDB Cloud
- OceanBase
sqlchat.ai
IP Whitelisting
If you use sqlchat.ai to connect to your database, you need to add 0.0.0.0 (allow all connections)
to the database whitelist IP. Because sqlchat.AI is hosted on Vercel which uses dynamic IP. If this is a concern, please consider the self-host option below.
Data Privacy
See SQL Chat Privacy Policy.
Self-host
Docker
If you just want to run for your own use, supply the following options:
- NEXTAUTH_SECRET
- OPENAI_API_KEY
bash
docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET="$(openssl rand -hex 5)" --env OPENAI_API_KEY= -p 3000:3000 --hostname localhost sqlchat/sqlchat
- Pass an arbitrary string to NEXTAUTH_SECRET otherwise next-auth will complain.
- If you chat to the database on the same host, you need to use host.docker.internal as the host in
the database connection setting.
Startup options
TL;DR
- If you just want to use for yourself, then run without database. Check .env.nodb.
- If you want to offer a similar service as sqlchat.ai, then run with database, check .env.usedb. The database is used to store account, usage info.
OpenAI related
- OPENAI_API_KEY: OpenAI API key. You can get one from here.
- OPENAI_API_ENDPOINT: OpenAI API endpoint. Defaults to https://api.openai.com. Use Ollama to set up self-host AI model and set the endpoint to it.
- NEXT_PUBLIC_ALLOW_SELF_OPENAI_KEY: Set to true to allow users to bring their own OpenAI API key.
Database related
- NEXT_PUBLIC_USE_DATABASE: Set to true to start SQL Chat with database. This will
enable following features:
1. Account system.
1. Per-user quota enforcement.
1. Payment.
1. Usage data collection.
- DATABASE_URL: Applicable if NEXT_PUBLIC_USE_DATABASE is true. Postgres connection string to store data. e.g. postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat.
Local Development
1. Install dependencies
bash
pnpm i
1. Generate prisma client
bash
pnpm prisma generate
1. Make a copy of the example environment variables file:
bash
cp .env.usedb .env
1. Add your API key and OpenAI API Endpoint(optional) to the newly created .env file.
Setup database
You can Top issues
#135Support azure openai API5 comments · 2023-07-12#164Can not visit localhost:3000 after deployment using docker4 comments · 2024-09-24#150How to set the list of models that can be used4 comments · 2024-02-14#94Support on-premise deployment and connect to self-hosted AI model3 comments · 2023-05-18#155Can the prompt include column comment? 2 comments · 2024-05-20#187Keep non-English locales in sync with en.json — happy to help1 comments · 2026-05-27#163Can SQL Chat configure knowledge base?1 comments · 2024-09-11#162how solve this issues in local installation in ubuntu 221 comments · 2024-07-27