[工具] 取得 Oracle 資料庫資料結構表 (Markdown 版)

很久很久以前,我寫過一個取得 Microsoft SQL Server 資料結構表文件的 小工具。 那時候的需求很單純,把資料表的欄位資訊、約束條件、索引等等,全部匯出到一份 Excel 裡面,依照 Sheet 區分不同資料表,方便維護與交接。

時間快轉到 2025 年,我換了工作環境,也換了資料庫,從 SQL Server 變成了 Oracle,既然資料庫都換了,小工具當然也得進化,這次我不再使用 Excel,而是直接改成輸出 Markdown 格式。

這次改用 Markdown 格式,主要的原因是資料庫異動管控的考量(這裡水有點深😎), Oracle 資料庫不像 MSSQL 那樣有專用的「資料庫專案」功能,因此過去大家常用 Excel 等檔案來做管制(或者沒有管制 !?😤),但這種做法的缺點就是看不到異動歷程。

不同於 Excel,Markdown 的好處是,可以直接放進專案文件夾,搭配 Git 或其他版本控管系統,任何欄位變更、欄位刪減、索引調整,通通都能一目了然,但如果要人工維護表格可能就有點累了,因此這次才會再寫一個 Oracle 版的小工具方便自己管理,因此若你需要 MSSQL 版的工具請轉到這頁來下載。

本文的小工具會針對勾選的資料表欄位,依照每張資料表,在應用程式的執行目錄下自動建立一個 doc 資料夾,並且為每張表依名稱產生一份獨立的資料結構文件(Markdown 格式)。

在工具介面中有兩個輸入欄位需要先設定: 

  • 資料庫連線字串:用來指定要連線的 Oracle 資料庫,支援標準連線字串格式。 
  • 資料表名稱關鍵字(可使用 % 萬用字元):用來篩選需要產生文件的資料表,例如輸入 CUS% 就只會輸出名稱以 CUS 開頭的資料表。


產生的檔案結構與內容示例如下,可直接在 Markdown 檢視器


本文範例下載 : Github,使用 Visual Studio 2015 搭配 Net Framework 4.8.1,若需可攜式執行檔請至此處下載

留言