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. 提交拉動請求 - 清楚地說明問題和解決方案。如果適用，請包括相關的問題編號。

行為我們致力於為所有人提供一個熱情而鼓舞人心的社區。通過參加該項目，您應該維護我們的行為準則，從而促進尊重和協作。