9.2.2 DBDoc 模型报告

通过打开一个模型,从菜单中选择模型,然后 选择DBDoc - 模型报告,可以找到 DBDoc - 模型报告对话框。

笔记

此功能仅在 MySQL Workbench 商业版中可用。

使用 DBDoc-Model Reporting 对话框设置用于创建数据库模型文档的选项。例如下图是HTML Detailed Frames选中了模板样式设置为 的对话框Vibrant

图 9.19 DBDoc 模型报告选项

内容在周围的文字中描述。

您可以从四个可用模板中进行选择以生成报告:

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

  • HTML Basic Single Page: 单页 HTML 文档,不使用框架。

  • HTML Detailed Frames: 详细的 HTML 文档,使用框架。

  • Text Basic: 文本文件文档。

单击模板时,预览图像会显示在页面右侧。对于HTML Basic Frames 模板,您可以选择样式列表中的ColorfulRestrained Colors选项 。该模板仅提供 样式。该模板提供了风格,也提供了更柔和的 风格。该 模板仅提供样式。 HTML Basic Single PageColorfulHTML Detailed FramesVibrantCoatedText BasicFixed Size Font

基本选项框架中选择报告标题和报告文件的输出目录。

以下变量可用于配置输出路径:

  • ~: 用户的主目录。仅适用于 Linux 和 macOS 版本。

  • %desktopfolder%:用户的桌面。

  • %documentsfolder%:用户的文档文件夹。下表显示了常见平台的典型值。

    平台 典型的默认文档文件夹
    视窗 C:\Users\user_name\My Documents
    Linux ~/Documents
    苹果系统 Users/user_name/Documents
  • %date%:格式为 YYYY-MM-DD 的日期。

  • %time%: 格式为 HHMM 的时间。

  • %year%: YYYY 格式的年份。

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

  • %monthname%: 月份的名称,而不是数字。

  • %day%: 格式为 DD 的天数。例如,第 12 个将是 12。

还可以选择内容选项:

  • 输出表列:显示所有列。

  • 输出表索引:显示所有索引。

  • Output Foreign Keys : 显示所有的外键。

  • Output References from Foreign Keys:显示外键引用的表。

  • 包含对象的 DDL 代码:生成 DDL 代码。

单击生成按钮创建在输出目录文本框中定义的目录。如果您选择创建HTML Basic Frames,您将在此目录中找到以下文件:

  • basic.css:页面的样式表 overview.html

  • index.html: 主页。

  • overview.html:模型概览,侧边栏中显示的导航链接。

  • restrained.css:选择样式选项时使用的 CSS 文件 Restrained Colors

  • table_details.html:模型报表的主框架。

选择该HTML Basic Single Page选项会创建一个样式表和一个index.html文件。

选择该HTML Detailed Frames选项会创建以下文件:

  • basic.css:页面的样式表 overview.html。如果 vibrant选择了样式,则使用它。

  • coated.css:选择样式选项时使用的 CSS 文件 Coated

  • 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以查看报告。 下图显示了架构 HTML Detailed Frames报告的输出示例。world

图 9.20 DBDoc 模型报告

显示模式概览、DDL 脚本、表、列等的模型报告。

有关创建自定义模板的更多信息,请参阅 第 9.7 节,“自定义 DBDoc 模型报告模板”