Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sqlchat/sqlchat
Chat-based SQL Client and Editor for the next decade
https://github.com/sqlchat/sqlchat
chatgpt clickhouse cockroachdb gpt mongodb mssql mysql openai oracle postgres redis snowflake sql sqlclient sqleditor sqlite sqlserver text-to-sql text2sql tidb
Last synced: 4 days ago
JSON representation
Chat-based SQL Client and Editor for the next decade
- Host: GitHub
- URL: https://github.com/sqlchat/sqlchat
- Owner: sqlchat
- License: other
- Created: 2023-03-16T03:19:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T15:00:58.000Z (5 months ago)
- Last Synced: 2024-12-31T12:06:30.225Z (11 days ago)
- Topics: chatgpt, clickhouse, cockroachdb, gpt, mongodb, mssql, mysql, openai, oracle, postgres, redis, snowflake, sql, sqlclient, sqleditor, sqlite, sqlserver, text-to-sql, text2sql, tidb
- Language: TypeScript
- Homepage: https://sqlchat.ai
- Size: 1.85 MB
- Stars: 4,739
- Watchers: 30
- Forks: 415
- Open Issues: 14
-
Metadata Files:
- Readme: README.es-ES.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- Awesome-ChatGPT - sqlchat
- awesome-open-gpt - sqlchat
- awesome-ChatGPT-repositories - sqlchat - Chat-based SQL Client and Editor for the next decade (CLIs)
- awesome-clickhouse - sqlchat/sqlchat - SQL Chat is a chat-based SQL client that allows users to interact with databases using natural language commands. (UIs / CHUI(Chat-based User Interface) or CHUBACA(Chat-Based Client:))
- StarryDivineSky - sqlchat/sqlchat
- awesome-chatgpt - sqlchat/sqlchat - SQL Chat is a browser extension that serves as a chat-based SQL client and editor, providing a natural language interface for querying and modifying databases. (ChatGPT-based applications / Other sdk/libraries)
- Awesome-LLM-RAG-Application - SQLChat
- awesome-genai - SQLChat - Chat-based SQL Client and Editor for the next decade. [](https://github.com/sqlchat/sqlchat/network/members) [](https://github.com/sqlchat/sqlchat/stargazers) (Tools & Frameworks / Text2SQL)
- awesome-genai - SQLChat - Chat-based SQL Client and Editor for the next decade. [](https://github.com/sqlchat/sqlchat/network/members) [](https://github.com/sqlchat/sqlchat/stargazers) (Tools & Frameworks / Text2SQL)
README
## ¿Que es?
SQL Chat es un cliente SQL basado en chat, que utiliza lenguaje natural para comunicarse con la base de datos y realizar operaciones como consultas, modificaciones, adiciones y eliminaciones de datos en la base de datos.
## ¿Por que?
A medida que entramos en la [Era de las Herramientas de Desarrollo 2.0](https://www.sequoiacap.com/article/ai-powered-developer-tools/),
existe una gran oportunidad para reconstruir las herramientas existentes utilizando una interfaz basada en chat. El cliente SQL
no es una excepción. En lugar de navegar a través de varias interfaces de usuario, una interfaz basada en chat es
más intuitiva. Por supuesto, solo si funciona, y nuestro objetivo es ofrecer esa experiencia.
## ¿Como?
SQL Chat esta construido en [Next.js](https://nextjs.org/), admite las siguientes bases de datos y agregará más con el tiempo:
- MySQL
- PostgreSQL
- MSSQL
- TiDB Cloud
## Privacidad de la Data
Vea la [Política de Privacidad de SQL Chat](https://sqlchat.ai/privacy).
## IP Whitelisting
Si usas [sqlchat.ai](https://sqlchat.ai) para conectarte a tu base de datos, debes agregar 0.0.0.0 (permitir todas las conexiones) a la IP de la lista blanca de la base de datos. Porque sqlchat.AI está alojado en
[Vercel](https://vercel.com/) el cual [usa IP dinámica](https://vercel.com/guides/how-to-allowlist-deployment-ip-address). Si esto le preocupa, considere la opción de hospedaje propio a continuación.
## Hospedaje propio con Docker
```bash
docker run --name sqlchat --platform linux/amd64 -env NEXTAUTH_SECRET=xxx -p 3000:3000 sqlchat/sqlchat
```
### Variables relacionadas con OpenAI:
- `NEXT_PUBLIC_ALLOW_SELF_OPENAI_KEY`: Establezca en "verdadero" para permitir a los usuarios traer su propia clave API de OpenAI.
- `OPENAI_API_KEY`: Clave API de OpenAI. Puedes conseguir una [aquí](https://beta.openai.com/docs/developer-quickstart/api-keys).
- `OPENAI_API_ENDPOINT`: Endpoint de la API de OpenAI. El predeterminado es `https://api.openai.com`.
### Variables relacionadas con la base de datos:
- `NEXT_PUBLIC_USE_DATABASE`: Establézcalo en `false` para iniciar SQL Chat en modo sin base de datos. Esto
desactivara las siguientes funciones:
1. Sistema de cuentas.
2. Ejecución de Cuota por Usuario.
3. Pago.
4. Recopilación de datos de uso.
- `DATABASE_URL`: Aplicable si `NEXT_PUBLIC_USE_DATABASE` es `true`. Cadena de conexión de Postgres para almacenar datos. ej. `postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat`.
```bash
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
```
## Desarrollo Local
1. Instala las dependencias
```bash
pnpm i
```
1. Haga una copia del archivo de variables de entorno de ejemplo:
```bash
cp .env.usedb .env
```
1. Generar el cliente prisma a partir del modelo.
```bash
pnpm prisma generate
```
1. Añade tu [clave de API](https://platform.openai.com/account/api-keys) y el endpoint del API de OpenAI(opcional) al recién creado archivo `.env`.
### Configura la base de datos
**Puede omitir esta sección con `NEXT_PUBLIC_USE_DATABASE=false` si no crea funciones que requieren una base de datos**
1. Inicie una instancia de Postgres. Para mac, puedes usar [StackbBricks](https://stackbricks.app/), [DBngin](https://dbngin.com/) o [Postgres.app](https://postgresapp.com/).
1. Crea una base de datos:
```sql
CREATE DATABASE sqlchat;
```
En el archivo `.env`, asigna la cadena de conexión a la variable de entorno `DATABASE_URL` y `DATABASE_DIRECT_URL`. [Este articulo](https://www.prisma.io/docs/data-platform/data-proxy/prisma-cli-with-data-proxy#set-a-direct-database-connection-url-in-your-prisma-schema) explica por qué necesitamos dos URL.
1. Migrar esquema
```bash
pnpm prisma migrate dev
```
1. (Opcional) Seed data
```bash
pnpm prisma db seed
```
## Historial de Estrellas
[](https://star-history.com/#sqlchat/sqlchat&Date)
## Comunidad
[](https://discord.gg/z6kakemDjm)
[](https://twitter.com/Bytebase)
## Patrocinadores
## Licencia
Este proyecto está bajo la Licencia BSL. Consulte el archivo [LICENSE](LICENSE) para obtener el texto completo de la licencia.
## FAQ
¿Cómo Hospedar mi propio SQL Chat?
- Puede implementar SQL Chat en Vercel con un solo clic
- Puede implementar su SQL Chat con docker en segundos
```bash
docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat
```
¿Cómo usar mi clave API de OpenAI?
- Puede configurar la `OPENAI_API_KEY` como una variable de entorno.
```bash
docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx -p 3000:3000 sqlchat/sqlchat
```
- Puede configurar la `OPENAI_API_KEY` en el cuadro de diálogo de la configuración.
¿Siempre dice que tengo un problema de conexión de red?
Asegúrese de tener una conexión de red estable que pueda acceder al endpoint de la API de OpenAI.
```bash
ping api.openai.com
```
Si no puede acceder al endpoint de la API de OpenAI, puede intentar configurar el `OPENAI_API_ENDPOINT` en la UI o como una variable de entorno.
You exceeded your current quota, please check your plan and billing details
Su clave OpenAI se ha quedado sin cuota. Por favor revise su [cuenta de OpenAI ](https://platform.openai.com/account/api-keys).