name: dbcheck description: 執行 MySQL、PostgreSQL、Oracle、SQL Server、DM8、TiDB、IvorySQL、GBase 8s、YashanDB、KingbaseES 資料庫健康巡檢，內建 130+ 條增強風險分析規則，一鍵生成專業 Word 巡檢報告。適用於 DBA 和運維人員快速掌握資料庫執行狀況、排查風險。專案地址：https://github.com/fiyo/DBCheck license: MIT metadata: { "openclaw": { "emoji": "🔍", }, }

DBCheck — 資料庫自動化巡檢工具（OpenClaw Skill）

安全宣告（必讀）

本 Skill 的資料流向完全可控，如下所示： 使用者憑據 → [本地 Python 指令碼] → 資料庫伺服器 → 巡檢結果 → [本地 Word 報告]

• ✅ 資料庫憑據：僅用於建立連線，不會寫入磁碟持久檔案，不會發送到任何第三方
• ✅ 本地檔案寫入：巡檢結果以 Word 報告形式儲存在本地 reports/ 目錄，所有檔案均在本地，不含敏感憑據
• ⚠️ 限制：本 Skill 僅用於合法授權的資料庫巡檢，請勿用於未授權訪問

核心能力

支援的資料庫

驅動說明： - ✅ GBase 8s JDBC 驅動已內建在 drivers/gbase/ 目錄，無需額外下載 - ⚠️ Oracle / YashanDB 需要使用者在機器上自行安裝客戶端，詳見下方「驅動配置」說明

觸發條件

當用戶請求以下任意一項時，載入本 Skill 並執行：

• 對資料庫做健康檢查 / 健康巡檢 / 體檢
• 檢查 MySQL / PostgreSQL / Oracle / SQL Server / DM8 / TiDB / IvorySQL / GBase 8s / YashanDB / KingbaseES 的執行狀態
• 生成資料庫巡檢報告 / 健康報告
• "幫我巡檢一下 XX 資料庫"
• "生成一份 XX 資料庫巡檢報告"

前置準備

必需資訊

開始巡檢前，必須向用戶收集以下資訊（缺少任何一項都要詢問，不要自行猜測）：

Oracle 專用引數

注意事項

• DM8：無需填寫 database 引數，連線使用者即 Schema
• GBase 8s：需要 drivers/gbase/*.jar 驅動檔案，工具會自動查詢
• KingbaseES：預設埠 54321（不是 PostgreSQL 的 5432）

驅動配置

部分資料庫需要本地安裝客戶端才能正常巡檢，請按以下說明配置。

GBase 8s

✅ 驅動已內建，無需額外操作。drivers/gbase/jdbc-3.5.1.jar 已隨 skill 打包。

Oracle

需要安裝 Oracle Instant Client 或完整 Oracle Client。

方式一：Oracle Instant Client（推薦，體積小）

1. 下載對應版本的 Instant Client：
2. Oracle 11g R2：https://www.oracle.com/database/technologies/instant-client/winx64-64-downloads.html
3. Oracle 19c / 21c：同上頁面選擇對應版本
4. 解壓到任意目錄，如 C:\oracle\instantclient_21_12\
5. 將目錄新增到系統 PATH 環境變數： powershell # Windows（管理員許可權執行）
6. 重啟終端使 PATH 生效

方式二：使用專案內建客戶端

如果本機已安裝 DBCheck 完整版，可直接使用 drivers/oracle_client/ 目錄：

# 將 DBCheck\drivers\oracle_client 加到 PATH
[Environment]::SetEnvironmentVariable("PATH", [Environment]::GetEnvironmentVariable("PATH", "Machine") + ";D:\DBCheck\drivers\oracle_client", "Machine")

YashanDB（崖山資料庫）

需要安裝 YashanDB 客戶端。

1. 從崖山官網或管理員獲取 YashanDB 客戶端安裝包
2. 安裝後，將客戶端的 bin 目錄（包含 ysql 等工具）新增到 PATH
3. 確認 yzplotlib Python 包已安裝： bash pip install yzplotlib

說明：YashanDB 客戶端較大（約 200M），未隨 skill 打包。請從 YashanDB 官方渠道獲取安裝包。

SQL Server

需要安裝 ODBC Driver 17 for SQL Server 或 ODBC Driver 18 for SQL Server。

下載地址：https://learn.microsoft.com/zh-cn/sql/connect/odbc/download-odbc-driver-for-sql-server

安裝後 pyodbc 可自動檢測到驅動。

執行巡檢

使用 execute_command 工具執行 Python 指令碼。

依賴檢查

先檢查依賴是否完整：

python -c "import pymysql, psycopg2, docxtpl, paramiko, psutil, openpyxl, docx" 2>&1

如有缺失，提示使用者安裝：

pip install pymysql psycopg2-binary paramiko openpyxl docxtpl python-docx pandas psutil flask oracledb dmpython pyodbc flask-socketio jaydebeapi

完整巡檢示例

MySQL 巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type mysql \
    --host <資料庫IP> \
    --port 3306 \
    --user <使用者名稱> \
    --password <密碼> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"
更多技能請訪問小蔥技能站7w4.net。

PostgreSQL 巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type pg \
    --host <資料庫IP> \
    --port 5432 \
    --user <使用者名稱> \
    --password <密碼> \
    --database <資料庫名，預設postgres> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"

Oracle 巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type oracle \
    --host <資料庫IP> \
    --port 1521 \
    --user <使用者名稱> \
    --password <密碼> \
    --service_name <服務名> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"

SQL Server 巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type sqlserver \
    --host <資料庫IP> \
    --port 1433 \
    --user <使用者名稱> \
    --password <密碼> \
    --database <資料庫名，預設master> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"

DM8（達夢）巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type dm \
    --host <資料庫IP> \
    --port 5236 \
    --user <使用者名稱> \
    --password <密碼> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"

TiDB 巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type tidb \
    --host <資料庫IP> \
    --port 4000 \
    --user <使用者名稱> \
    --password <密碼> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"

IvorySQL 巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type ivorysql \
    --host <資料庫IP> \
    --port 5432 \
    --user <使用者名稱> \
    --password <密碼> \
    --database <資料庫名，預設postgres> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"

GBase 8s 巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type gbase \
    --host <資料庫IP> \
    --port 5258 \
    --user <使用者名稱> \
    --password <密碼> \
    --database <資料庫名，預設gbase01> \
    --gbase-server-name <GBase 服務名，預設gbase01> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"

GBase 8s 注意：需要 drivers/gbase/*.jar 驅動檔案。工具會自動查詢該目錄下的 jar 檔案。

YashanDB 巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type yashandb \
    --host <資料庫IP> \
    --port 5432 \
    --user <使用者名稱> \
    --password <密碼> \
    --database <資料庫名> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"

KingbaseES 巡檢

cd <skill_scripts_dir>
python run_inspection.py \
    --type kingbase \
    --host <資料庫IP> \
    --port 54321 \
    --user <使用者名稱> \
    --password <密碼> \
    --database <資料庫名，預設kingbase> \
    --label "<資料庫標籤>" \
    --inspector "<巡檢人員姓名>"

完整引數參考

--type           資料庫型別: mysql / pg / oracle / sqlserver / dm / tidb / ivorysql / gbase / yashandb / kingbase（完整巡檢必需）
--host           資料庫主機 IP 或域名
--port           資料庫埠（預設: MySQL 3306, TiDB 4000, PG 5432, Oracle 1521, SQL Server 1433, DM8 5236, GBase 5258, KingbaseES 54321）
--user           資料庫使用者名稱
--password       資料庫密碼
--service_name   Oracle 服務名（Oracle 專用）
--sid            Oracle SID（Oracle 專用，與 service_name 二選一）
--database       資料庫名（PG/SQL Server/GBase/KingbaseES 專用，預設 postgres/master/gbase01/kingbase）
--gbase-server-name  GBase 8s 服務名（GBase 專用，預設 gbase01）
--label          資料庫標籤，用於報告命名
--inspector      巡檢人員姓名
--ssh-host       SSH 主機 IP（可選，採集系統資源）
--ssh-port       SSH 埠（預設 22）
--ssh-user       SSH 使用者名稱（可選）
--ssh-password   SSH 密碼（可選）
--ssh-key        SSH 私鑰檔案路徑（可選，與密碼二選一）

報告輸出

• 報告自動儲存在 <scripts_dir>/reports/ 目錄下
• 檔名格式：
• MySQL：MySQL巡檢報告_<標籤>_<時間戳>.docx
• PostgreSQL：PostgreSQL巡檢報告_<標籤>_<時間戳>.docx
• Oracle：Oracle巡檢報告_<標籤>_<時間戳>.docx
• SQL Server：SQLServer_<標籤>_<時間戳>.docx
• DM8：DM8巡檢報告_<標籤>_<時間戳>.docx
• TiDB：TiDB巡檢報告_<標籤>_<時間戳>.docx
• GBase 8s：GBase巡檢報告_<標籤>_<時間戳>.docx
• YashanDB：YashanDB巡檢報告_<標籤>_<時間戳>.docx
• KingbaseES：KingbaseES巡檢報告_<標籤>_<時間戳>.docx
• 報告可用 Microsoft Word / WPS 開啟（DOCX）

結果展示

巡檢完成後：

1. 告知使用者報告檔案完整路徑
2. 使用 open_result_view 工具開啟報告檔案供使用者檢視
3. 簡要彙報關鍵發現（如發現高風險項，單獨列出）
4. 提示使用者報告中風險建議僅供參考，需結合實際業務評估

常見錯誤處理

限制與注意事項

• 本 Skill 僅用於合法授權的資料庫巡檢，請勿用於未授權訪問
• SSH 採集依賴目標機器的 top、free、df、lscpu 命令（使用 AutoAddPolicy 接受主機金鑰）
• 報告生成依賴 python-docx 和 docxtpl 庫，務必確保已安裝
• Oracle 支援 11g R2 / 12c / 19c / 21c 及以上版本，部分高階檢視在不同版本間有差異，工具已做相容處理
• DM8 巡檢依賴 dmpython 驅動（pip install dmpython）
• SQL Server 巡檢依賴 pyodbc（pip install pyodbc）和 ODBC Driver 17 或 18（需單獨安裝）
• GBase 8s 巡檢依賴 jaydebeapi（pip install jaydebeapi）和 GBase 8s JDBC 驅動 jar 檔案
• KingbaseES 使用 PostgreSQL 協議（psycopg2），預設埠 54321
• 本地檔案寫入：巡檢會在 reports/ 生成 Word 報告、在當前目錄寫入 history.json（純數值指標）、autoDoc.log（執行日誌），均在本地機器上

這是一款質量優秀的資料庫巡檢工具，功能非常全面，支援幾乎所有主流資料庫。優點是操作簡單、自動生成專業報告、風險規則豐富、還能做趨勢分析和AI診斷，且資料完全本地處理安全可靠。不足是部分資料庫（如Oracle、YashanDB）需要額外安裝驅動，配置稍複雜；部分大檔案程式碼維護成本較高。總體而言，適合DBA和運維人員快速掌握資料庫健康狀況。