Doris MCP Server

🚀 Doris - 強大的自然語言處理數據查詢分析工具

Doris 是一款功能強大的自然語言處理 (NLP) 工具，專門為數據查詢和分析而設計。它能夠將複雜的自然語言查詢轉化為高效的 SQL 語句，同時還能提供專業的數據分析服務，極大地提升了數據處理的效率和便捷性。

🚀 快速開始

Doris 是一款專為數據查詢和分析打造的自然語言處理工具，能將自然語言查詢轉化為 SQL 並提供數據分析服務。以下是快速上手的步驟：

# 克隆倉庫
git clone https://github.com/your-repository.git
cd Doris

# 安裝依賴項
pip install -r requirements.txt

# 啟動服務
python start_server.py

✨ 主要特性

• 多表連接支持：輕鬆應對多個數據庫表之間的複雜關係，讓數據查詢更高效。
• 智能上下文理解：基於歷史查詢和業務背景，對查詢結果進行優化，提供更精準的分析。
• 可解釋性輸出：提供清晰易懂的結果說明，即使是非技術人員也能輕鬆理解。
• 即時數據分析：快速響應用戶查詢，並及時生成分析結果，滿足即時性需求。

📦 安裝指南

環境要求

• 操作系統：Linux、Windows 10 或更高版本
• 內存：至少 4GB RAM
• Python 版本：3.8 及以上版本

安裝步驟

# 克隆倉庫
git clone https://github.com/your-repository.git
cd Doris

# 安裝依賴項
pip install -r requirements.txt

# 啟動服務
python start_server.py

💻 使用示例

基礎用法

1. 初始化配置

# 配置數據庫連接信息
configuresettings --database-settings

2. 執行查詢

# 執行單表查詢
doristool query "顯示所有客戶的聯繫信息"

# 執行跨表聯合查詢
doristool join-query "計算每個銷售代表的季度銷售額"

3. 獲取結果 查詢結果將輸出到控制檯，並自動生成分析報告。

高級用法

多步驟查詢流程

1. 解析自然語言查詢

parse_query --query="顯示2022年每位銷售代表的總銷售額"

2. 獲取相似查詢示例

find_similar_examples --query="顯示2022年每位銷售代表的總銷售額"

3. 生成優化SQL

generate_sql --query="顯示2022年每位銷售代表的總銷售額"

4. 執行並分析結果

exec_query --sql="SELECT SUM(sales) AS total_sales, representative_id FROM sales GROUP BY representative_id;"
analyze_query_result --resultsetId=123

📚 詳細文檔

配置選項

數據庫配置

編輯 config/database_config.json 文件：

{
  "host": "localhost",
  "port": 3306,
  "user": "root",
  "password": "your_password",
  "databases": ["sales", "customer"]
}

日誌設置

編輯 config/logging_settings.json 文件：

{
  "log_level": "INFO",
  "log_file": "doris.log"
}

錯誤處理

常見錯誤及解決方案：

1. 數據庫連接失敗
   • 檢查數據庫服務是否運行
   • 確認憑據信息無誤
2. SQL執行超時
   • 優化查詢語句
   • 調整索引策略
3. 分析結果為空
   • 驗證查詢條件
   • 檢查數據完整性

貢獻指南

歡迎通過提交問題或拉取請求為項目貢獻力量。請參考 CONTRIBUTING.md 文件瞭解具體流程。

🔧 技術細節

配置選項

數據庫配置

編輯 config/database_config.json 文件，可對數據庫的連接信息進行配置，包括主機地址、端口、用戶名、密碼以及所使用的數據庫列表。

{
  "host": "localhost",
  "port": 3306,
  "user": "root",
  "password": "your_password",
  "databases": ["sales", "customer"]
}

日誌設置

編輯 config/logging_settings.json 文件，可對日誌的級別和存儲文件進行設置。

{
  "log_level": "INFO",
  "log_file": "doris.log"
}

錯誤處理

在使用 Doris 過程中，可能會遇到一些常見錯誤，以下是相應的解決方案：

1. 數據庫連接失敗
   • 檢查數據庫服務是否正常運行，可通過相關命令查看服務狀態。
   • 確認憑據信息是否無誤，包括用戶名、密碼等。
2. SQL執行超時
   • 對查詢語句進行優化，避免複雜的嵌套和冗餘操作。
   • 調整索引策略，提高查詢效率。
3. 分析結果為空
   • 驗證查詢條件是否合理，是否符合數據實際情況。
   • 檢查數據完整性，確保數據沒有缺失或損壞。

貢獻指南

歡迎廣大開發者為 Doris 項目貢獻力量，可通過提交問題或拉取請求的方式參與。具體流程請參考 CONTRIBUTING.md 文件。

📄 許可證

該項目遵循 MIT 許可證，具體內容如下：

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

附錄

Doris 使用說明

Doris 提供以下主要工具：

• parse_query：解析自然語言查詢
• find_similar_examples：獲取相似查詢示例
• generate_sql：生成優化 SQL 語句
• exec_query：執行 SQL 查詢
• analyze_query_result：分析查詢結果

工作流程圖

開始
    |
    v
接收自然語言查詢
    |
    v
parse_query
    |
    v
find_similar_examples（可選）
    |
    v
generate_sql
    |
    v
exec_query
    |
    v
analyze_query_result
    |
    v
輸出結果和分析報告

示例

1. 基礎查詢

doristool query "顯示所有客戶的聯繫信息"

2. 複雜查詢

doristool join-query "計算每個銷售代表的季度銷售額"

3. 自定義腳本

from doris import DorisClient

client = DorisClient()
result = client.query("顯示過去一年的訂單總量")
print(result)

感謝使用 Doris！如需幫助，請隨時聯繫維護團隊。