SchemaExporter

之前撰寫了好幾個版本的工具，用於從資料庫結構中生成 Schema，但因為認為可能用不到而沒有保留，結果後來又需要使用，所以現在重新撰寫了一個版本來做備份。

目前這個版本整理成共用 Core、Blazor Hybrid 桌面程式和獨立的 CLI 執行檔。平常手動匯出可以用桌面版，要做排程、自動化、AI Agent 呼叫或 snapshot / diff 時就用 CLI。使用者設定會存放在 %LocalAppData%\SchemaExporter\appsettings.json，避免更新時覆蓋連線與匯出設定。

專案組成

• src\SchemaExporter.Core：核心函式庫，包含 provider、匯出流程、snapshot / diff、comment SQL、redaction 與診斷邏輯
• src\SchemaExporter.Infrastructure：Desktop 與 CLI 共用的使用者設定存取、出廠設定範本與開啟資料夾服務
• src\SchemaExporter.Desktop：桌面程式 CloudyWing.SchemaExporter.exe，WPF Host 加 BlazorWebView（WebView2）與 Razor Components
• src\SchemaExporter.Cli：命令列程式 CloudyWing.SchemaExporter.Cli.exe，不依賴 WPF 與 WebView2
• tests\SchemaExporter.Core.Tests：Core 的 NUnit 測試
• tests\SchemaExporter.Core.IntegrationTests：Provider integration tests，透過 Testcontainers 啟動資料庫 fixture
• tests\SchemaExporter.Infrastructure.Tests：設定讀寫與相容性測試
• tests\SchemaExporter.Cli.Tests：CLI 參數、命令與子處理程序層級的 EXE 測試
• tests\SchemaExporter.Desktop.Tests：Desktop 狀態類別的測試，以及以 bUnit 驗證 Razor 元件繪製與互動的測試
• tests\SchemaExporter.Desktop.UITests：以 FlaUI 操作實際 Desktop 視窗、WebView2 內容、WebView 內提示與原生檔案選擇對話框的冒煙測試
• tests\SchemaExporter.ProviderFixtures：Provider integration tests 使用的 schema fixture scripts

主要功能

資料庫支援

• 支援 Microsoft SQL Server 與 Oracle Database。
• 透過 provider abstraction 切換資料來源，各 provider 的 metadata 支援範圍詳見 Provider Capability Matrix。

匯出產物

• 主要輸出為 Excel 活頁簿。
• 可額外產生 manifest、JSON sidecar、Markdown sidecar、Schema Summary 等 artifact。
• 可產生 schema snapshot，並與任一份既有 snapshot 進行 diff，輸出 JSON 或 Markdown 報告。

設定與安全

• 使用者設定存放於 %LocalAppData%\SchemaExporter\appsettings.json，避免應用程式更新時覆蓋連線與匯出設定。
• 透過 export profile 控制 schema / object 篩選與是否包含 view。
• 可啟用 redaction 規則，於輸出前遮罩描述、預設值與 routine 定義等敏感 metadata。
• 匯出過程會收集 diagnostics，提供資訊、警告、錯誤與 provider 支援層級。

工作流概觀

資料庫 ──► export ──► Excel + artifacts (manifest / sidecar / snapshot)
                              │
                              ▼
              snapshot ──► diff ──► JSON / Markdown 差異報告

匯出時可同時產生 snapshot；後續搭配 baseline snapshot 與 diff 命令，即可在 CI 中偵測 schema drift。

文件

入門與操作

• 快速入門
• Desktop 版操作說明
• CLI 版操作說明
• 設定檔說明

輸出格式契約

• 輸出產物定位
• Manifest 格式
• Snapshot 格式
• Diff 格式
• 註解 SQL 產生
• Schema Summary 格式

進階主題

• CI 使用範例
• Provider Fixture 資料庫
• Provider Capability Matrix
• 診斷資訊說明
• 技術棧說明

建置與測試

建置整個解決方案：

dotnet build .\SchemaExporter.slnx -v minimal

執行測試（一般測試不需要資料庫 fixture）：

dotnet test .\SchemaExporter.slnx -v minimal --no-build

從原始碼直接執行 CLI 與 Desktop：

dotnet run --project .\src\SchemaExporter.Cli\SchemaExporter.Cli.csproj -- export --connection <name>

dotnet run --project .\src\SchemaExporter.Desktop\SchemaExporter.Desktop.csproj

安裝版的 CLI 位於安裝目錄的 tools\CloudyWing.SchemaExporter.Cli.exe，Release 也另外提供 CLI 專用 ZIP。

Desktop UI 冒煙測試需要 Windows 桌面 session 與 WebView2 Runtime，預設不執行，需指定分類：

dotnet build .\SchemaExporter.slnx -c Release
dotnet test .\tests\SchemaExporter.Desktop.UITests\SchemaExporter.Desktop.UITests.csproj -c Release --no-build --filter "TestCategory=DesktopUi"

測試會以暫時的 LOCALAPPDATA 啟動 CloudyWing.SchemaExporter.exe，不影響使用者設定；失敗時會附上螢幕截圖。要測試其他位置的執行檔時，以 SCHEMAEXPORTER_DESKTOP_EXE 環境變數指定路徑。

若要驗證 provider 對實體資料庫的查詢行為，請執行 Provider Fixture 資料庫 說明的 integration test 指令。Integration tests 會透過 Testcontainers 啟動資料庫 fixture。

授權

本專案採用 MIT 授權，詳見 LICENSE.md。