Doris MCP Server

🚀 Doris

Dorisは、データのクエリと分析に特化した強力な自然言語処理（NLP）ツールです。複雑な自然言語クエリを効率的なSQLに変換し、専門的なデータ分析サービスを提供します。

🚀 クイックスタート

Dorisは、データのクエリと分析に特化した強力な自然言語処理（NLP）ツールです。このツールを使用することで、ユーザーは自然言語でデータベースにクエリを投げることができ、DorisがそれをSQLに変換して分析結果を返します。

✨ 主な機能

• 多表結合のサポート：複数のデータベーステーブル間の複雑な関係を簡単に処理できます。
• コンテキストの理解：過去のクエリと業務背景に基づいて結果を最適化します。
• 解釈可能な出力：非技術者でも理解しやすい結果の説明を提供します。
• リアルタイムデータ分析：ユーザーのクエリに迅速に応答し、分析結果を生成します。

📦 インストール

環境要件

• オペレーティングシステム：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 ファイルを参照してください。

📄 ライセンス

このプロジェクトは 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("過去1年間の注文総数を表示")
print(result)

Dorisのご利用ありがとうございます！ご質問やご相談があれば、いつでもメンテナンスチームまでお問い合わせください。