{"id":13543361,"url":"https://github.com/sqlchat/sqlchat","last_synced_at":"2025-04-27T04:16:35.404Z","repository":{"id":148607866,"uuid":"614656648","full_name":"sqlchat/sqlchat","owner":"sqlchat","description":"Chat-based SQL Client and Editor for the next decade","archived":false,"fork":false,"pushed_at":"2025-04-11T02:52:09.000Z","size":1890,"stargazers_count":5133,"open_issues_count":19,"forks_count":442,"subscribers_count":32,"default_branch":"main","last_synced_at":"2025-04-27T04:16:27.312Z","etag":null,"topics":["chatgpt","clickhouse","cockroachdb","gpt","mongodb","mssql","mysql","openai","oracle","postgres","redis","snowflake","sql","sqlclient","sqleditor","sqlite","sqlserver","text-to-sql","text2sql","tidb"],"latest_commit_sha":null,"homepage":"https://sqlchat.ai","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sqlchat.png","metadata":{"files":{"readme":"README.es-ES.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-16T03:19:27.000Z","updated_at":"2025-04-27T01:30:29.000Z","dependencies_parsed_at":"2023-05-01T14:02:01.568Z","dependency_job_id":"ac08c65e-cf31-4d1d-be78-258742706510","html_url":"https://github.com/sqlchat/sqlchat","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlchat%2Fsqlchat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlchat%2Fsqlchat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlchat%2Fsqlchat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlchat%2Fsqlchat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sqlchat","download_url":"https://codeload.github.com/sqlchat/sqlchat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251085200,"owners_count":21533844,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatgpt","clickhouse","cockroachdb","gpt","mongodb","mssql","mysql","openai","oracle","postgres","redis","snowflake","sql","sqlclient","sqleditor","sqlite","sqlserver","text-to-sql","text2sql","tidb"],"created_at":"2024-08-01T11:00:30.678Z","updated_at":"2025-04-27T04:16:35.384Z","avatar_url":"https://github.com/sqlchat.png","language":"TypeScript","readme":"![SQL Chat banner](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/banner.webp)\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch3\u003eSQL Chat\u003c/h3\u003e\n  \u003ca href=\"https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsqlchat%2Fsqlchat\u0026env=OPENAI_API_KEY\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/deploy%20on-Vercel-brightgreen.svg?style=for-the-badge\u0026logo=vercel\" alt=\"vercel\"\u003e\n  \u003c/a\u003e\n  \u003cp\u003e\u003ca href=\"README.md\"\u003eEnglish\u003c/a\u003e | \u003ca href=\"README.zh-CN.md\"\u003e中文\u003c/a\u003e | Español\u003c/p\u003e\n\u003c/div\u003e\n\n## ¿Que es?\n\nSQL 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.\n\n![Screenshot](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/screenshot1.webp)\n\n![Screenshot](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/screenshot2.webp)\n\n![Screenshot](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/screenshot3.webp)\n\n## ¿Por que?\n\nA medida que entramos en la [Era de las Herramientas de Desarrollo 2.0](https://www.sequoiacap.com/article/ai-powered-developer-tools/),\nexiste una gran oportunidad para reconstruir las herramientas existentes utilizando una interfaz basada en chat. El cliente SQL\nno es una excepción. En lugar de navegar a través de varias interfaces de usuario, una interfaz basada en chat es\nmás intuitiva. Por supuesto, solo si funciona, y nuestro objetivo es ofrecer esa experiencia.\n\n## ¿Como?\n\nSQL Chat esta construido en [Next.js](https://nextjs.org/), admite las siguientes bases de datos y agregará más con el tiempo:\n\n- MySQL\n- PostgreSQL\n- MSSQL\n- TiDB Cloud\n\n## Privacidad de la Data\n\nVea la [Política de Privacidad de SQL Chat](https://sqlchat.ai/privacy).\n\n## IP Whitelisting\n\nSi 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\n[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.\n\n## Hospedaje propio con Docker\n\n```bash\ndocker run --name sqlchat --platform linux/amd64 -env NEXTAUTH_SECRET=xxx -p 3000:3000 sqlchat/sqlchat\n```\n\n### Variables relacionadas con OpenAI:\n\n- `NEXT_PUBLIC_ALLOW_SELF_OPENAI_KEY`: Establezca en \"verdadero\" para permitir a los usuarios traer su propia clave API de OpenAI.\n\n- `OPENAI_API_KEY`: Clave API de OpenAI. Puedes conseguir una [aquí](https://beta.openai.com/docs/developer-quickstart/api-keys).\n\n- `OPENAI_API_ENDPOINT`: Endpoint de la API de OpenAI. El predeterminado es `https://api.openai.com`.\n\n### Variables relacionadas con la base de datos:\n\n- `NEXT_PUBLIC_USE_DATABASE`: Establézcalo en `false` para iniciar SQL Chat en modo sin base de datos. Esto\n  desactivara las siguientes funciones:\n  1. Sistema de cuentas.\n  2. Ejecución de Cuota por Usuario.\n  3. Pago.\n  4. Recopilación de datos de uso.\n- `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`.\n\n```bash\ndocker 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\n```\n\n## Desarrollo Local\n\n1. Instala las dependencias\n\n   ```bash\n   pnpm i\n   ```\n\n1. Haga una copia del archivo de variables de entorno de ejemplo:\n\n   ```bash\n   cp .env.usedb .env\n   ```\n\n1. Generar el cliente prisma a partir del modelo.\n\n   ```bash\n   pnpm prisma generate\n   ```\n\n1. 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`.\n\n### Configura la base de datos\n\n**Puede omitir esta sección con `NEXT_PUBLIC_USE_DATABASE=false` si no crea funciones que requieren una base de datos**\n\n1. Inicie una instancia de Postgres. Para mac, puedes usar [StackbBricks](https://stackbricks.app/), [DBngin](https://dbngin.com/) o [Postgres.app](https://postgresapp.com/).\n\n1. Crea una base de datos:\n\n   ```sql\n   CREATE DATABASE sqlchat;\n   ```\n\n   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.\n\n1. Migrar esquema\n\n   ```bash\n   pnpm prisma migrate dev\n   ```\n\n1. (Opcional) Seed data\n\n   ```bash\n   pnpm prisma db seed\n   ```\n\n## Historial de Estrellas\n\n[![Gráfica Historial de Estrellas](https://api.star-history.com/svg?repos=sqlchat/sqlchat\u0026type=Date)](https://star-history.com/#sqlchat/sqlchat\u0026Date)\n\n## Comunidad\n\n[![Síguenos en Twitter](https://img.shields.io/badge/Follow%20us%20on%20Twitter-1DA1F2?style=for-the-badge\u0026logo=twitter\u0026labelColor=EEEEEE)](https://twitter.com/Bytebase)\n\n\u003cimg width=\"256\" src=\"https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/wechat-qrcode.webp\" alt=\"sqlchat\"\u003e\n\n## Patrocinadores\n\n\u003cp\u003e\n  \u003ca href=\"https://www.bytebase.com\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/bytebase.webp\" width=300\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Licencia\n\nEste proyecto está bajo la Licencia BSL. Consulte el archivo [LICENSE](LICENSE) para obtener el texto completo de la licencia.\n\n## FAQ\n\n\u003cdetails\u003e\u003csummary\u003e¿Cómo Hospedar mi propio SQL Chat?\u003c/summary\u003e\n\u003cp\u003e\n\n- Puede implementar SQL Chat en Vercel con un solo clic\n\n  \u003ca href=\"https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsqlchat%2Fsqlchat\u0026env=OPENAI_API_KEY\"\u003e\u003cimg src=\"https://img.shields.io/badge/deploy%20on-Vercel-brightgreen.svg?style=for-the-badge\u0026logo=vercel\" alt=\"vercel\"\u003e\u003c/a\u003e\n\n- Puede implementar su SQL Chat con docker en segundos\n\n  ```bash\n  docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat\n  ```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003e¿Cómo usar mi clave API de OpenAI?\u003c/summary\u003e\n\u003cp\u003e\n\n- Puede configurar la `OPENAI_API_KEY` como una variable de entorno.\n\n  ```bash\n  docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx -p 3000:3000 sqlchat/sqlchat\n  ```\n\n- Puede configurar la `OPENAI_API_KEY` en el cuadro de diálogo de la configuración.\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003e¿Siempre dice que tengo un problema de conexión de red?\u003c/summary\u003e\n\u003cp\u003e\n\nAsegúrese de tener una conexión de red estable que pueda acceder al endpoint de la API de OpenAI.\n\n```bash\nping api.openai.com\n```\n\nSi 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.\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eYou exceeded your current quota, please check your plan and billing details\u003c/summary\u003e\n\u003cp\u003e\n\n![openai quota](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/error-exceed-openai-quota.webp)\n\nSu clave OpenAI se ha quedado sin cuota. Por favor revise su [cuenta de OpenAI ](https://platform.openai.com/account/api-keys).\n\n\u003c/p\u003e\n\u003c/details\u003e\n","funding_links":[],"categories":["TypeScript","精选开源项目合集","CLIs","置顶","Sql Generation","\u003cimg src=\"./assets/satellite.svg\" width=\"16\" height=\"16\" style=\"vertical-align: middle;\"\u003e Satellites","A01_文本生成_文本对话","开源工具","Tools \u0026 Frameworks","chatgpt","数据管道","UIs","🗃️ SQL \u0026 Databases","📦 Projects"],"sub_categories":["GPT工具","1、AI应用生态","大语言对话模型及数据","SQL增强","Text2SQL","Web applications","Tools","CHUI(Chat-based User Interface) or CHUBACA(Chat-Based Client:)","Fine-tuning"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqlchat%2Fsqlchat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsqlchat%2Fsqlchat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqlchat%2Fsqlchat/lists"}