mql - 自然语言转SQL工具，兼容PostgreSQL

MQL 项目介绍

MQL（My Query Language）是一个功能强大的工具，可以将自然语言查询转换为可执行的SQL查询。即使你没有编程基础，也可以轻松使用它。只需在MQL中连接或上传你的数据库架构，随后用自然语言询问问题，即可获得相应的SQL查询结果。

🚀 如何开始使用

使用 Docker 本地运行工具

确保已安装 Docker。

克隆 Git 仓库：

git clone https://github.com/shurutech/mql

更新服务器/Dockerfile，添加你的 OPENAI_API_KEY 密钥：
```
ENV OPENAI_API_KEY YOUR_TOKEN_HERE
```
根据以下规则更新 server/.env 文件中的 DATABASE_URL：
- 使用 Docker 运行 MQL 时，可使用 "postgres" 作为主机名。
- 不使用 Docker 时，可以使用 "localhost" 作为主机名。
进入仓库文件夹并运行以下命令：
```
make install
```
完成安装后，可以在 http://localhost:3000 访问 MQL 仪表盘。

默认登录邮箱/密码测试 MQL

运行工具时，通过 Docker 创建的默认用户用于登录测试：

邮箱：admin@example.com
密码：admin

生产化 MQL 的步骤

如果希望将 MQL 上线，需要注意以下几点：

删除默认用户：连接 mql 数据库（mql-postgres），从用户表中删除默认用户（admin@example.com）。
创建新用户：
- 进入项目根目录
- 在后端 docker 容器中执行：docker-compose exec backend /bin/bash
- 运行创建用户脚本：python3 scripts/create_user.py
- 输入邮箱、密码和姓名创建新用户

支持的数据库

目前，MQL 仅设计与 PostgreSQL 配合使用。

本地不使用 Docker 运行工具

前提条件

本地运行项目所需的包包括：

Python
psycopg2
Node
PostgreSQL 15
PostgreSQL 的 pgvector 扩展

数据库设置

在 PostgreSQL 命令行客户端中运行以下命令：

创建 PostgreSQL 角色

创建具有超级用户权限和登录能力的角色：

CREATE ROLE <role_name> WITH superuser;
ALTER ROLE <role_name> WITH LOGIN PASSWORD 'password';

创建数据库

使用 <role_name> 创建 mql 和 mql_test 两个数据库：

CREATE DATABASE mql WITH OWNER <role_name>;
CREATE DATABASE mql_test WITH OWNER <role_name>;

创建扩展

连接数据库并创建 vector 扩展：
```
\c <databse_name>
CREATE EXTENSION vector;
```

更新服务器环境变量

在 server/.env 中更新以下值：

DATABASE_URL="postgresql://<role_name>:<password>@<host>:5432/mql"
TEST_DATABASE_URL="postgresql://<role_name>:<password>@<host>:5432/mql_test"
OPENAI_API_KEY="<key>"

若数据库在本地托管，主机名为 localhost。

运行脚本

导航至仓库文件夹并在终端运行命令：

chmod +x ./setup.sh && ./setup.sh

安装完成后，可在 http://localhost:3000 访问 MQL 仪表盘。

准确性测试得分

通过 MQL 平台运行了 50 个自然语言查询，使用 elearning_schema 文件和 CSV 查询映射测试其性能。MQL 成功翻译了 43 个查询，成功率约为 85%。但考虑翻译精度时，约有 74%（50 个查询中的 37 个）完全正确执行，有 6 个查询被正确解释但缺少分号。7 个查询出现错误。我们不断致力于提高 SQL 语法生成的准确性和完整性，并欢迎大家贡献以帮助改进平台。