DBDoc - 模型报告对话框可以通过打开模型,从菜单中选择
,然后选择 来找到。此功能仅在 MySQL Workbench 商业版中可用。
使用 DBDoc- 模型报告对话框可以设置创建数据库模型文档的选项。例如,下图显示了选择 HTML 详细框架
且模板样式设置为 活力
的对话框。
您可以从四个可用模板中选择一个来生成报告
HTML 基本框架
:使用框架的 HTML 格式的模型文档。HTML 基本单页
:不使用框架的单页 HTML 文档。HTML 详细框架
:使用框架的详细 HTML 文档。文本基本
:文本文件文档。
单击模板时,页面右侧会显示预览图像。对于 HTML 基本框架
模板,您可以从 样式 列表中选择 彩色
或 内敛颜色
选项。HTML 基本单页
模板仅提供 彩色
样式。HTML 详细框架
模板提供 活力
样式,以及更柔和的 涂层
样式。文本基本
模板仅提供 固定大小字体
样式。
从 基本选项 框架中选择报告标题和报告文件的输出目录。
以下变量可用于配置输出路径
~
:用户的 home 目录。仅适用于 Linux 和 macOS 版本。%desktopfolder%
:用户的桌面。-
%documentsfolder%
:用户的文档文件夹。下表显示了常见平台的典型值。平台 典型的默认文档文件夹 Windows C:\Users\
用户名
\我的文档Linux ~/Documents
macOS Users/
用户名
/Documents %date%
:日期,格式为 YYYY-MM-DD。%time%
:时间,格式为 HHMM。%year%
:年份,格式为 YYYY。%month%
:月份,格式为 MM。1 月为 01,12 月为 12。%monthname%
:月份的名称,而不是数字。%day%
:日期,格式为 DD。例如,12 日为 12。
还可以选择内容选项
输出表列:显示所有列。
输出表索引:显示所有索引。
输出外键:显示所有外键。
输出外键的引用:显示外键引用的表。
包含对象的 DDL 代码:生成 DDL 代码。
单击 输出目录 文本框中定义的目录。如果您选择创建 HTML 基本框架
,您将在该目录中找到以下文件
basic.css
:overview.html
页面的样式表。index.html
:主页。overview.html
:模型概述,侧边栏中显示的导航链接。restrained.css
:如果选择内敛颜色
样式选项,则使用的 CSS 文件。table_details.html
:模型报告的主框架。
选择 HTML 基本单页
选项将创建一个样式表和一个 index.html
文件。
选择 HTML 详细框架
选项将创建以下文件
basic.css
:overview.html
页面的样式表。如果选择活力
样式,则使用此样式表。coated.css
:如果选择涂层
样式选项,则使用的 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
:模式的所有列和索引的列表。
选择 文本基本
选项将创建一个包含一个文本文件的目录。
您可以单击 index.html
查看报告。下图显示了 world
模式的 HTML 详细框架
报告的输出示例。
有关创建自定义模板的更多信息,请参阅 第 9.7 节“自定义 DBDoc 模型报告模板”。