# AzureSQLChatGPTDemo

**Repository Path**: teo-ma/AzureSQLChatGPTDemo

## Basic Information

- **Project Name**: AzureSQLChatGPTDemo
- **Description**: SQL Chat 是一个基于聊天的 SQL 客户端，通过openai赋能，可以使用自然语言询问数据库问题和查询数据库. 
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-04-17
- **Last Updated**: 2023-04-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AzureSQLChatGPTDemo
SQL Chat 是一个基于聊天的 SQL 客户端，可以使用自然语言询问数据库问题和查询数据库. 本Demo
基于源repo https://github.com/bytebase/sqlchat,更新了如下：
* 处于测试目的，关闭了SSL
* 将大部分页面翻译成中文
* 添加示例 mysql 数据库（Azure MySQL 灵活服务器）连接
* 加载mysql官方示例数据 [employees](https://dev.mysql.com/doc/employee/en/)
* 本Demo使用Azure Openai Service

## 如何在你的本地运行
1. 克隆这个repo：https://gitee.com/teo-ma/AzureSQLChatGPTDemo.git
2. 拷贝 .env.example并重命名为 .env，并将里面的openai相关的环境变量替换为你自己的
```bash
    cp .env.example .env

```
3. 安装 pnpm

**On Windows:**
```powershell
iwr https://get.pnpm.io/install.ps1 -useb | iex
```

**On Linux:**
```bash
# bash
wget -qO- https://get.pnpm.io/install.sh | ENV="$HOME/.bashrc" SHELL="$(which bash)" bash -
# sh
wget -qO- https://get.pnpm.io/install.sh | ENV="$HOME/.shrc" SHELL="$(which sh)" sh -
# dash
wget -qO- https://get.pnpm.io/install.sh | ENV="$HOME/.dashrc" SHELL="$(which dash)" dash -
```

4.命令行输入 ```pnpm dev``` 启动本地demo服务
5.打开浏览器，输入 http://localhost:3000/ ，在页面上点击“+”图标，提供了默认的demo数据库连接，也可以添加你自己的数据库连接信息，然后点击“连接”按钮，如果连接成功，就可以开始聊天了。
![Alt text](./media/sql2.png)
![Alt text](./media/sql1.png)


## 在 Azure App Service 中部署

1. 创建Azure App Service ,Runtime选择NodeJS 18 LTS
2. 最好使用本地测试使用VS Code，VS Code 安装Azure插件和Azure App Service插件。
3. 测试通过后通过插件部署到Azure App Service。
   ![Alt text](./media/sql2.png)
4. 成功运行后，在页面上点击“+”图标，提供了默认的demo数据库连接，也可以添加你自己的数据库连接信息，然后点击“连接”按钮，如果连接成功，就可以开始聊天了。
   
## 其他运行选择：如果在Docker中运行
1. 在本地安装[Docker](https://www.docker.com/)，然后在命令行中运行如下命令打包容器镜像和运行容器：


```bash
docker build -t azure-sql-chat-demo:v1.0 -f ./Dockerfile .
docker run -p 127.0.0.1:3001:3000/tcp azure-sql-chat-demo:v1.0 --env <see .env.example file for environment variables> 
```   
2. 成功启动容器后，通过浏览输入 http://localhost:3001/ ，在页面上点击“+”图标，提供了默认的demo数据库连接，也可以添加你自己的数据库连接信息，然后点击“连接”按钮，如果连接成功，就可以开始聊天了。
   
3. 本地运行通过，可以将镜像推送到Azure Container Registry，然后在Azure Container Instance，Azure Container Apps或Azure App Service（容器runtiem）中部署。