結構描述文件
功能性的產生資料庫結構描述的 Markdown 文件,可直接放進儲存庫或 Wiki。
產生 Markdown 一步完成資料庫結構描述的文件化:選擇動作、選擇儲存位置,完成。刻意不加任何設定——文件是從 SQLly 為 IntelliSense 載入的結構描述模型建出來的,因此不需要額外的伺服器往返,也精確反映應用程式所知的內容。
輸出是一個以連線和資料庫為標題的資料字典,分為 資料表, 檢視表, 程序, 函式,而且 其他物件。每個資料表都有欄位格線,含名稱、類型、是否允許 NULL、預設值和鍵註記(主鍵、識別, 外鍵 → 目標)——並附上外鍵清單;常式則附上參數簽章與傳回型別。非常大的結構描述會自動拆成一個索引檔加上每個結構描述各一個檔案,因此結果在儲存庫或維基中仍然易於瀏覽。


撰寫資料字典
- 連線後給架構模型一點載入時間(與提供自動完成的模型是同一個)。如果尚未載入,SQLly 會在狀態列上說明,且不會執行任何操作。
- 在物件總管中右鍵點擊資料庫,然後選擇 結構描述 › 產生結構描述文件 (Markdown)...,或執行 結構描述文件 (Markdown)... 來自 命令面板。從物件總管開啟它,會先把該資料庫設為使用中的資料庫。
- 會開啟一個儲存對話方塊,內容為
schema-docs.md會提供建議名稱。請挑選資料夾並命名。 - 狀態列會確認儲存的位置,以及分割結構描述時寫入了幾個檔案。
Markdown 的樣子
物件會先依區段排序,再依名稱排序。一個小型結構描述會產生如下內容:
# Data Dictionary — Shop / sales Generated by SQLLY from the loaded schema model. 2 objects. ## Tables ### dbo.Orders | Column | Type | Nullable | Default | Key | |---|---|---|---|---| | OrderId | int | no | | PK, identity | | CustomerId | int | no | | FK → dbo.Customers | | Total | decimal | yes | | | - Foreign key (CustomerId) → dbo.Customers (CustomerId) ## Procedures ### dbo.PlaceOrder | Parameter | Type | Mode | Default | |---|---|---|---| | @CustomerId | int | in | |
- 資料表 - 每個欄位一列。 允許空值 是
yes,no,或?當模型不知道時。該 鍵 儲存格合併了PK,FK → target,而且identity. - 檢視表 - 一個「欄位 / 類型」格線,或 在架構模型中未記錄的欄位 當模型只知道檢視的名稱時。
- 程序和函式 - 一個「參數 / 類型 / 模式 / 預設值」格線(模式為
in,out,或in/out), 無參數。 當沒有任何項目時,以及 傳回值: 行,函式則有專屬的一行。 - 其他物件 - 同義字會顯示目標;其餘的則列出名稱並附上 未記錄結構細節。
值中的管線符號會被跳脫、換行會被壓平,因此預設值和類型不會弄亂表格版面。
大型結構描述
最多 2,000 個物件會放進你命名的單一檔案。超過這個數量時,SQLly 會把該檔案寫成
索引 會列出每個結構描述及其物件數量和連結,並在旁邊為每個結構描述各產生一個檔案,以你的檔案來命名: schema-docs.sales.md,
schema-docs.audit.md,以此類推。Schema 名稱會被轉換為適合檔名使用的格式,若兩個 schema 名稱衝突,會加上數字後綴以避免覆蓋對方。沒有任何內容會被截斷。
注意事項
- 它適用於 SQLly 連線的所有引擎,因為它讀取的是 SQLly 自己的模型,而非特定引擎的資料目錄。
- 文件的完整性取決於已載入的模型。如果模型從未記錄某個檢視的欄位,文件會如實說明,而不會進行猜測。
- 儲存時會直接寫入檔案;同名的既有檔案會被覆蓋。
- 在瀏覽器預覽中無法儲存到檔案;請使用桌面應用程式。