mql

MQL

MQL（我的查询语言）是将自然语言查询转换为可执行的SQL查询的强大工具。很酷的是，即使不知道如何编码，任何人都可以使用它。只需通过将模式连接或上传架构连接到MQL来添加您的数据库，询问您的语言查询并获取SQL。

mql_query_demo.mp4

入门

mql_getstarted.mp4

使用Docker在本地运行该工具。

• 确保已安装了Docker。

• 首先，克隆这个git存储库：

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

• 使用您的OPENAI_API_KEY键更新服务器/DockerFile：

   ENV OPENAI_API_KEY YOUR_TOKEN_HERE
  

• 根据以下规则更新服务器/.env文件中的数据库_url：

  • 如果您使用Docker运行MQL，则可以将“ Postgres”用作主机名。
  • 如果您不使用Docker运行MQL，则可以将“ Localhost”用作主机名。

• 导航到存储库文件夹并运行以下命令：

   make install
  

  安装完成后，您可以在以下位置访问MQL仪表板：http：// localhost：3000

---

如果需要，您还可以重新启动以反映本地更改（如果有），请使用：

 make restart

另外，您可以使用以下方式终止本地设置

 make down

另外，您可以使用以下方式启动所有容器：

 make up

使用默认电子邮件/密码登录测试MQL

使用Docker运行工具时，为登录目的创建默认用户。

• 电子邮件 - [email protected]
• 密码 - 管理员

想生产MQL吗？

如果您想实现它，请注意以下步骤

• 删除默认用户：要删除默认用户（[email protected]），您需要与MQL数据库（MQL-POSTGRES）连接，然后从用户表中删除它。
• 创建新用户：
  • 转到项目的根目录
  • 在后端docker容器中执行：docker-compose exec后端 /bin /bash
  • 运行create_user脚本：python3脚本/create_user.py
  • 输入电子邮件，密码和名称以创建自己的用户

支持的数据库

截至当前版本，MQL旨在专门与PostgreSQL合作。

---

您也可以在没有Docker的情况下在本地运行该工具。

• 先决条件

  这些是需要安装在本地运行该项目的所需软件包。

1. Python

2. psycopg2

3. 节点

4. Postgresql 15

5. PGVECTOR扩展PostgreSQL -PGVECTOR

• 数据库设置

  在您的PostgreSQL命令行客户端中运行这些命令

1. 创建PostgreSQL角色

   使用Superuser权限创建PostgreSQL角色并登录功能：

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

2. 创建数据库

   创建两个数据库， mql和mql_test ，并具有shuru角色：

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

3. 创建扩展名

   创建vector扩展：

• 使用以下方式与数据库连接：

  c < databse_name >

• 创建向量扩展：

  CREATE EXTENSION vector;

• 更新您的Env

  在服务器/.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

安装完成后，您可以在以下位置访问MQL仪表板：http：// localhost：3000

精度测试得分

我们的测试过程涉及通过MQL平台运行50个自然语言查询，并具有elearning_schema文件之类的资源，以及位于我们的test_data文件夹中的查询映射的CSV。 MQL达到了约85％的成功率，在50个查询中准确地翻译了43个。但是，当考虑翻译的精度时，完美执行了查询中约74％（37个）的查询，并正确解释了6个查询，但最后缺少半彩色。这给我们留下了7个查询，导致错误。我们正在积极进行增强功能，以提高SQL语法生成的准确性和完整性，并欢迎捐款以帮助完善我们的平台。

• 我们已经从此处拍摄了数据库，以进行测试目的。
• 您可以在检查后删除test_data文件夹。

下一步/功能

我们计划在初次发布后继续建造，并期待社区的反馈。截至目前，我们有以下针对接下来发行的功能。

• 执行查询执行
• 改进直接连接的DB和SQL查询结果
• 支持MySQL数据库
• 查询准确性的提高
• 显示自然语言响应和数据可视化。
• 用户可以集成Slack或类似的应用程序，以获取NL查询结果。
• 测试重新提供查询。

贡献指南

我们重视每个开发人员的贡献，并鼓励您与我们分享您的想法，改进和修复。为了确保协作流程，请遵循以下准则。

开始之前：

• 确保您有一个github帐户。
• 通过阅读读数，探索问题并了解工具的体系结构和编码标准来熟悉该项目。

如何贡献

报告错误

在报告错误之前，请：

• 检查问题跟踪器，以确保尚未报告该错误。
• 如果该问题未报告，请创建一个新问题，提供：
  • 明确的标题和描述。
  • 复制错误的步骤。
  • 预期的行为以及实际发生的事情。
  • 任何相关的错误消息或屏幕截图。

建议提高我们喜欢收到增强建议的建议！请：

• 首先，检查是否已经提出了增强。
• 如果没有，请打开一个新问题，描述增强以及为什么它会有益。

拉动请求准备贡献代码？请按照以下步骤：

1. 叉子存储库 - 创建自己的项目叉。
2. 为您的更改创建一个新的分支 - 保持分支集中在单个功能或错误修复上。
3. 提交您的更改 - 写出清晰，简洁的提交消息来解释您的更改。
4. 遵循编码标准 - 确保您的代码遵守整个项目中使用的编码标准。
5. 编写测试 - 如果可能的话，请编写测试以涵盖新功能或错误修复。
6. 提交拉动请求 - 清楚地说明问题和解决方案。如果适用，请包括相关的问题编号。

行为我们致力于为所有人提供一个热情而鼓舞人心的社区。通过参加该项目，您应该维护我们的行为准则，从而促进尊重和协作。