文件首頁
MySQL Workbench 手冊
相關文件 下載本手冊
PDF (美式 Letter) - 17.0Mb
PDF (A4) - 17.0Mb


MySQL Workbench 手冊  /  ...  /  DBDoc 模型報告

9.2.2 DBDoc 模型報告

DBDoc - 模型報告對話方塊位於開啟模型後,從選單選取模型,然後選取DBDoc - 模型報告

注意

此功能僅適用於 MySQL Workbench 商業版。

使用 DBDoc - 模型報告對話方塊來設定建立資料庫模型文件的選項。例如,下圖顯示已選取 HTML Detailed Frames 且範本樣式設定為 Vibrant 的對話方塊。

圖 9.19 DBDoc 模型報告選項

Content is described in the surrounding text.

您可以從四種可用的範本中選擇來產生報表

  • HTML Basic Frames:使用框架的 HTML 格式模型文件。

  • HTML Basic Single Page:單頁 HTML 文件,不使用框架。

  • HTML Detailed Frames:使用框架的詳細 HTML 文件。

  • Text Basic:文字檔文件。

當您按一下範本時,預覽影像會顯示在頁面的右側。對於 HTML Basic Frames 範本,您可以從 樣式 清單中選取 ColorfulRestrained Colors 選項。HTML Basic Single Page 範本僅提供 Colorful 樣式。HTML Detailed Frames 範本提供 Vibrant 樣式,以及較為柔和的 Coated 樣式。Text Basic 範本僅提供 Fixed Size Font 樣式。

基本選項 框架中選擇報表標題和報表檔案的輸出目錄。

可以使用下列變數來設定輸出路徑

  • ~:使用者的主目錄。僅適用於 Linux 和 macOS 版本。

  • %desktopfolder%:使用者的桌面。

  • %documentsfolder%:使用者的「文件」資料夾。下表顯示常見平台的典型值。

    平台 預設「文件」資料夾
    Windows C:\Users\使用者名稱\My Documents
    Linux ~/Documents
    macOS Users/使用者名稱/Documents
  • %date%:日期,格式為 YYYY-MM-DD。

  • %time%:時間,格式為 HHMM。

  • %year%:年份,格式為 YYYY。

  • %month%:月份,格式為 MM。一月為 01,十二月為 12。

  • %monthname%:月份的名稱,而非數字。

  • %day%:日期,格式為 DD。例如,12 號會是 12。

也可以選取內容選項

  • 輸出資料表欄:顯示所有欄。

  • 輸出資料表索引:顯示所有索引。

  • 輸出外部鍵:顯示所有外部鍵。

  • 輸出外部鍵的參照:顯示外部鍵參照的資料表。

  • 包含物件的 DDL 程式碼:產生 DDL 程式碼。

按一下產生按鈕會建立在輸出目錄文字方塊中定義的目錄。如果您選擇建立 HTML Basic Frames,您會在此目錄中找到下列檔案

  • basic.cssoverview.html 頁面的樣式表。

  • index.html:主要頁面。

  • overview.html:模型概觀,側邊欄中顯示的導覽連結。

  • restrained.css:如果選擇 Restrained Colors 樣式選項,則會使用此 CSS 檔案。

  • table_details.html:模型報告的主要框架。

選擇 HTML Basic Single Page 選項會建立樣式表和 index.html 檔案。

選擇 HTML Detailed Frames 選項會建立下列檔案

  • basic.cssoverview.html 頁面的樣式表。如果選擇 vibrant 樣式,則會使用此檔案。

  • coated.css:如果選擇 Coated 樣式選項,則會使用此 CSS 檔案。

  • index.html:主要頁面。

  • overview.html:報表的概觀資訊,例如報表標題、專案名稱和作者。

  • overview_list.html:模型中綱要的摘要以及每個綱要中包含的資料表清單。

  • routine_details.html:綱要的所有常式清單。

  • table_details.html:主要報表詳細資料。

  • table_details_list.html:綱要概觀以及每個綱要的欄、索引和外部鍵詳細資料。

  • table_element_details.html:資料表每個元素的詳細資料。

  • top.html:報表的頂部框架。

  • view_details.html:綱要的所有欄和索引清單。

選擇 Text Basic 選項會建立一個包含一個文字檔的目錄。

您可以按一下 index.html 以檢視報表。下圖顯示 world 綱要的 HTML Detailed Frames 報表的輸出範例。

圖 9.20 DBDoc 模型報表

Model report showing schema overview, DDL script, tables, columns, and so on.

如需建立自訂範本的詳細資訊,請參閱第 9.7 節,「自訂 DBDoc 模型報告範本」