MQL项目使用教程

MQL项目使用教程

mql MQL tool is designed to generate SQL queries directly from natural language inputs. 项目地址: https://gitcode.com/gh_mirrors/mq/mql

1. 项目介绍

MQL（My Query Language）是一款强大的工具，能够将自然语言查询转换为可执行的SQL查询。其独特之处在于，用户无需了解任何编程知识即可使用。用户只需通过连接或上传模式到MQL，使用自然语言提问，即可获得对应的SQL语句。

2. 项目快速启动

环境准备

• 安装Docker。
• 安装PostgreSQL数据库。

克隆项目

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

配置项目

编辑server/Dockerfile文件，将你的OPENAI_API_KEY替换到相应位置：

ENV OPENAI_API_KEY YOUR_TOKEN_HERE

编辑server/.env文件，配置数据库URL：

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

将<role_name>、<password>和<host>替换为实际的数据库角色名、密码和主机名。

启动项目

导航到项目文件夹，并运行以下命令安装依赖：

make install

安装完成后，可以通过以下命令访问MQL控制台：

http://localhost:3000

如果需要重启服务以反映本地更改，可以使用：

make restart

关闭本地设置，可以使用：

make down

启动所有容器，可以使用：

make up

默认登录信息

使用以下默认信息登录以测试MQL：

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

3. 应用案例和最佳实践

• 案例一：用户可以通过MQL查询数据库中的用户信息，例如：“列出所有用户的姓名和邮箱”。
• 最佳实践：为了确保SQL查询的安全性，建议使用参数化查询，以避免SQL注入攻击。

4. 典型生态项目

目前MQL支持PostgreSQL数据库。未来的版本计划支持MySQL数据库，并且将增加查询执行的直接连接，提升SQL查询结果的准确性，同时提供自然语言响应和数据可视化等功能。

以上是MQL项目的使用教程，希望对您有所帮助。如果您有任何问题或建议，欢迎在项目仓库中提出。

mql MQL tool is designed to generate SQL queries directly from natural language inputs. 项目地址: https://gitcode.com/gh_mirrors/mq/mql