Sql Server Table Assistant

🚀 SQL Server 自然語言查詢工具使用文檔

本工具基於自然語言處理技術，旨在簡化 SQL Server 數據庫的操作。用戶只需通過中文提問，工具就能自動生成並執行相應的 SQL 查詢，極大地提升了數據庫操作的便捷性。

🚀 快速開始

本項目基於微軟的 Modal Context Protocol (MCP)，由 Aman Pachori 初始實現，藉助自然語言處理技術，讓用戶通過中文提問即可操作 SQL Server 數據庫。

✨ 主要特性

核心功能

• 自然語言查詢：用戶可通過中文提問，工具自動生成 SQL 查詢。
• 結果解釋：工具將提供結果的中文解釋，幫助用戶理解數據。
• 查詢歷史：記錄所有執行過的查詢，便於追溯和管理。

特殊命令

• /diagnose：執行全面的表訪問診斷
• /refresh_schema：刷新表結構信息
• /history：查看當前會話中的所有查詢記錄

📦 安裝指南

環境要求

• 操作系統：Windows 10 或更高版本
• .NET Framework：版本 4.7.2 或更高
• ODBC 驅動：必須安裝 Microsoft ODBC Driver for SQL Server

配置步驟

1. 下載並安裝 Microsoft ODBC Driver for SQL Server。
2. 創建配置文件 config.json，填寫以下信息：

   {
     "Server": "你的服務器地址",
     "Database": "你的數據庫名稱",
     "UID": "你的登錄名",
     "PWD": "你的密碼"
   }
   

3. 將 config.json 放置在工具的根目錄下。

💻 使用示例

基礎用法

> 顯示所有薪資超過50000的員工信息。
SQL 查詢生成: SELECT EmployeeName, Department, Salary FROM dbo.Employees WHERE Salary > 50000 ORDER BY Salary DESC;
執行成功，結果如下：
+----------------+-------------+------+
| 員工姓名       | 部門       | 工資  |
|----------------+------------+------|
| 張三          | 技術部     | 60000 |
| 李四          | 人力資源部 | 55000 |
| 王五          | 市場部     | 70000 |
+----------------+-------------+------+
結果解釋：以下是薪資超過50000的所有員工，按工資降序排列。王五是薪資最高的員工，達到70000元。

> 顯示每個部門的最高薪資。
SQL 查詢生成: SELECT Department, MAX(Salary) AS MaxSalary FROM dbo.Employees GROUP BY Department;
執行成功，結果如下：
+------------+-----------+
| 部門       | 最高薪資  |
|------------+-----------|
| 技術部     | 80000     |
| 人力資源部 | 65000     |
| 市場部     | 75000     |
+------------+-----------+
結果解釋：技術部的最高薪資為80000元，由張三獲得；市場部的最高薪資為75000元，由王五獲得。

📚 詳細文檔

安全注意事項

1. 單表訪問：查詢嚴格限制在配置的表內進行。
2. 查詢驗證：所有 SQL 查詢將在執行前展示給用戶，確保操作安全。
3. 事務安全性：更新、插入和刪除操作使用帶有回滾的事務，保障數據完整性。
4. 錯誤日誌：詳細記錄錯誤信息，便於排查問題而不洩露敏感信息。
5. 防止 SQL 注入：結構化的查詢生成機制降低了 SQL 注射的風險。

日誌與記錄

所有查詢及其結果均自動保存至 logs/queries/ 文件夾中，每個日誌文件包含：

• 原始自然語言查詢
• 所有 SQL 迭代版本及反饋
• 最終執行的 SQL 查詢
• 查詢結果
• 時間戳

故障排除

連接問題

1. 確認服務器地址或 IP 正確。
2. 檢查 SQL Server 是否運行且允許遠程連接。
3. 查看防火牆設置，確保 SQL 服務器端口開放。
4. 驗證 ODBC 驅動是否正確安裝並配置。

記憶限制問題

1. 等待重試：大多情況下，等待一段時間後重試可解決問題。