-
-
-
- {messageList.length === 0 ? (
-
-
-
- SQL Chat
+ +
+
+
+
+
+## Patrocinadores
+
+
+
+ 
+
+
+
+- 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
+ ```
+
+
+ +- 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. + +
++ +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. + +
++ + + +Su clave OpenAI se ha quedado sin cuota. Por favor revise su [cuenta de OpenAI ](https://platform.openai.com/account/api-keys). + +
+
+
+## Startup options
-## Data Privacy
+## TL;DR
-- All database conenction configs are stored locally in your browser. You can also visit settings to
- clear the data.
+- If you just want to use for yourself, then run without database. Check [.env.nodb](https://github.com/sqlchat/sqlchat/blob/main/.env.nodb).
+- If you want to offer a similar service as [sqlchat.ai](https://sqlchat.ai), then run with database, check [.env.usedb](https://github.com/sqlchat/sqlchat/blob/main/.env.usedb). The database is used to store account, usage info.
-- Only the database schema will be sent to the OpenAI API. No table data will be sent to there.
+### OpenAI related
+
+- `OPENAI_API_KEY`: OpenAI API key. You can get one from [here](https://platform.openai.com/api-keys).
+
+- `OPENAI_API_ENDPOINT`: OpenAI API endpoint. Defaults to `https://api.openai.com`. Use [Ollama](https://github.com/ollama/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. Make a copy of the example environment variables file;
+1. Install dependencies
```bash
- cp .env.example .env
+ pnpm i
```
-2. Add your [API key](https://platform.openai.com/account/api-keys) and OpenAI API Endpoint(optional) to the newly created `.env` file;
+1. Generate prisma client
-3. Install dependencies and start the dev server;
+ ```bash
+ pnpm prisma generate
+ ```
+
+1. Make a copy of the example environment variables file:
```bash
- pnpm i && pnpm dev
+ cp .env.usedb .env
+ ```
+
+1. Add your [API key](https://platform.openai.com/account/api-keys) and OpenAI API Endpoint(optional) to the newly created `.env` file.
+
+### Setup database
+
+**You can skip this section with `NEXT_PUBLIC_USE_DATABASE=false` if you don't build features requiring database**
+
+1. Start a Postgres instance. For mac, you can use [StackbBricks](https://stackbricks.app/), [DBngin](https://dbngin.com/) or [Postgres.app](https://postgresapp.com/).
+
+1. Create a database:
+
+ ```sql
+ CREATE DATABASE sqlchat;
+ ```
+
+ In `.env` file, assign the connection string to environment variable `DATABASE_URL` and `DATABASE_DIRECT_URL`. [This article](https://www.prisma.io/docs/data-platform/data-proxy/prisma-cli-with-data-proxy#set-a-direct-database-connection-url-in-your-prisma-schema) explains why we need two URLs.
+
+1. Set up database schema
+
+ ```bash
+ pnpm prisma migrate dev
+ ```
+
+1. (Optional) Seed data
+
+ ```bash
+ pnpm prisma db seed
```
## Star History
@@ -56,8 +145,6 @@ SQL Chat is built by Next.js, it supports following databases and will add more
## Community
-[](https://discord.gg/6R3qb32h)
-
[](https://twitter.com/Bytebase)
@@ -70,6 +157,38 @@ SQL Chat is built by Next.js, it supports following databases and will add more
-## License
+## Common Error Message
-This project is under the BSL License. See the [LICENSE](LICENSE) file for the full license text.
++ +See [this issue](https://github.com/sqlchat/sqlchat/issues/141). + +
++ + + +Your OpenAI Key has run out of quota. Please check your [OpenAI account](https://platform.openai.com/account/api-keys). + +
++ + + +Please make sure you have a stable network connection which can access the OpenAI API endpoint. + +```bash +ping api.openai.com +``` + +If you cannot access the OpenAI API endpoint, you can try to set the `OPENAI_API_ENDPOINT` in UI or environment variable. + +
+
+
+## 启动参数
+
+## TL;DR
+
+- 如果是自用，选择不需要数据库的配置，参阅 [.env.nodb](https://github.com/sqlchat/sqlchat/blob/main/.env.nodb).
+- 如果是希望提供类似于 [sqlchat.ai](https://sqlchat.ai) 的服务供多人使用, 那么需要数据库，参阅 [.env.usedb](https://github.com/sqlchat/sqlchat/blob/main/.env.usedb)。数据库用来保存用户以及使用信息。
+
+### OpenAI 相关
+
+- `OPENAI_API_KEY`: OpenAI API key. 您能从 [这里](https://beta.openai.com/docs/developer-quickstart/api-keys) 获得。
+
+- `OPENAI_API_ENDPOINT`: OpenAI API endpoint. 默认 `https://api.openai.com`。使用 [Ollama](https://github.com/ollama/ollama) 来启动 self-host AI 模型，并且把 endpoint 指向它.
+
+- `NEXT_PUBLIC_ALLOW_SELF_OPENAI_KEY`: 置为 `true` 以允许 SQL Chat 服务的用户使用自己的 key。
+
+### 数据库相关
+
+- `NEXT_PUBLIC_USE_DATABASE`: 置为 `true` 使得 SQL Chat 启动时使用数据库，这会开启如下功能：
+ 1. 账号系统。
+ 1. 用户额度。
+ 1. 支付。
+ 1. 使用数据收集。
+- `DATABASE_URL`: 当 `NEXT_PUBLIC_USE_DATABASE` 是 `true` 时有效。用于保存数据的 Postgres 连接串 e.g. `postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat`.
+
+## 本地开发环境
+
+1. 安装依赖项
+
+ ```bash
+ pnpm i
+ ```
+
+1. 生成 `prisma` 客户端
+
+ ```bash
+ pnpm prisma generate
+ ```
+
+1. 复制示例环境变量文件;
+
+ ```bash
+ cp .env.usedb .env
+ ```
+
+1. 将您的 [API 密钥](https://platform.openai.com/account/api-keys) 和 `OpenAI API` 端点（可选）添加到新创建的 `.env` 文件;
+
+### 配置数据库
+
+1. 启动 Postgres 实例。对于 mac，您可以使用 [StackbBricks](https://stackbricks.app/), [DBngin](https://dbngin.com/) 或者 [Postgres.app](https://postgresapp.com/)。
+
+1. 创建一个数据库:
+
+ ```sql
+ CREATE DATABASE sqlchat;
+ ```
+
+ 在 `.env` 文件中, 将连接字符串分配给环境变量 `DATABASE_URL` 和 `DATABASE_DIRECT_URL`。至于需要两个 URL 的原因[见此](https://www.prisma.io/docs/data-platform/data-proxy/prisma-cli-with-data-proxy#set-a-direct-database-connection-url-in-your-prisma-schema).
+
+1. 设置数据库 schema
+
+ ```bash
+ pnpm prisma migrate dev
+ ```
+
+1. 初始化数据（可选）
+
+ ```bash
+ pnpm prisma db seed
+ ```
+
+## Star 历史
+
+[](https://star-history.com/#sqlchat/sqlchat&Date)
+
+## 社区
+
+[](https://twitter.com/Bytebase)
+
+
+
+## 赞助商
+
+
+
+
+
+
+ +看这个 [issue](https://github.com/sqlchat/sqlchat/issues/141). + +
+
+
+- 您可以一键将 `SQL Chat` 部署到 `Vercel`
+
+
+
+- 您可以在几秒钟内使用 `Docker` 部署 `SQL Chat`
+
+ ```bash
+ docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat
+ ```
+
+
+ + + +这个表示你自己提供的 OpenAI Key 的 Quota 没有了。请查看自己的 [OpenAI 账号](https://platform.openai.com/account/api-keys)。 + +
++ + + +请确保您有一个稳定的网络连接，可以访问 OpenAI API 端点。 + +```bash +ping api.openai.com +``` + +如果您无法访问 OpenAI API 端点，您可以尝试在 UI 或环境变量中设置 `OPENAI_API_ENDPOINT`。 + +
+
- )}
- `{children}`;
- },
- }}
- >
- {message.content}
- Are you sure to clear the messages in current conversation?
+