下表显示了支持的标记。这些标记可用于任何模板,包括自定义模板。
使用表格
该表显示了在哪些部分中定义了哪些变量。该变量应在其正确的部分中使用,否则将不会显示其值。如果一个变量type
是一个变量,那么这个表描述了它的数据字典,如果type
是一个节则一个父字典。还请记住,用于执行变量查找的数据字典形成了层次结构树,因此可以在父节中定义的子节中使用变量。
表 9.3 支持的模板标记
标记文字 | 类型 | 数据字典或父字典 | 对应数据 |
---|---|---|---|
标题 | 多变的 | 主要的 | 报告标题 |
生成的 | 多变的 | 主要的 | 生成报告的日期和时间 |
STYLE_NAME | 多变的 | 主要的 | MySQL Workbench中选择的样式名称,这个一般用于加载对应的CSS文件,具体取决于MySQL Workbench中选择的样式名称 |
SCHEMA_COUNT 个 | 多变的 | 主要的 | 模型中的模式数 |
项目名称 | 多变的 | 主要的 | 在文档属性中为模型设置的项目标题 |
项目名称 | 多变的 | 主要的 | 在文档属性中为模型设置的项目名称 |
项目作者 | 多变的 | 主要的 | 在文档属性中为模型设置的项目作者 |
项目版本 | 多变的 | 主要的 | 在文档属性中为模型设置的项目版本 |
项目描述 | 多变的 | 主要的 | 在文档属性中为模型设置的项目描述 |
PROJECT_CREATED | 多变的 | 主要的 | 为模型项目自动设置,但显示在 文档属性中 |
PROJECT_CHANGED | 多变的 | 主要的 | 为模型项目自动设置,但显示在 文档属性中 |
TOTAL_TABLE_COUNT 个 | 多变的 | 主要的 | 模型中所有模式中的表数 |
TOTAL_COLUMN_COUNT 个 | 多变的 | 主要的 | 模型中所有模式的所有表中的列数 |
TOTAL_INDEX_COUNT 个 | 多变的 | 主要的 | 模型中的索引数 |
TOTAL_FK_COUNT 个 | 多变的 | 主要的 | 模型中外键的数量 |
图式 | 部分 | 主要的 | 用于标记 SCHEMATA 部分的开始和结束;SCHEMATA 数据字典在此部分中变为活动状态 |
SCHEMA_NAME | 多变的 | 图式 | 架构名称 |
SCHEMA_ID | 多变的 | 图式 | 架构 ID |
TABLE_COUNT 个 | 多变的 | 图式 | 当前模式中的表数 |
COLUMN_COUNT 个 | 多变的 | 图式 | 当前架构中的列数 |
INDICES_COUNT 个 | 多变的 | 图式 | 当前模式中的索引数 |
FOREIGN_KEYS_COUNT 个 | 多变的 | 图式 | 当前模式中的外键数 |
桌子 | 部分 | 图式 | 标记 TABLES 部分的开始和结束;TABLES 数据字典在此部分中变为活动状态 |
TABLE_NAME | 多变的 | 桌子 | 表名 |
表号 | 多变的 | 桌子 | 表格编号 |
COLUMNS_LISTING 列 | 部分 | 桌子 | 标记 COLUMNS_LISTING 部分的开始和结束;COLUMNS_LISTING 数据字典在此部分中变为活动状态 |
列 | 部分 | COLUMNS_LISTING 列 | 标记 COLUMNS 部分的开始和结束;COLUMNS 数据字典在此部分中变为活动状态 |
COLUMN_KEY | 多变的 | 列 | 该列是否为主键 |
COLUMN_NAME | 多变的 | 列 | 列名 |
COLUMN_DATATYPE | 多变的 | 列 | 列数据类型 |
COLUMN_NOTNULL | 多变的 | 列 | 列是否允许NULL 值 |
COLUMN_DEFAULTVALUE | 多变的 | 列 | 列默认值 |
COLUMN_COMMENT 栏目 | 多变的 | 列 | 专栏评论 |
COLUMN_ID | 多变的 | 列 | 列号 |
COLUMN_KEY_PART 栏目 | 多变的 | 专栏(如果详细) | 列键类型 |
COLUMN_NULLABLE | 多变的 | 专栏(如果详细) | 列是否可以包含NULL 值 |
COLUMN_AUTO_INC | 多变的 | 专栏(如果详细) | 列是否自增 |
COLUMN_CHARSET | 多变的 | 专栏(如果详细) | 列字符集 |
COLUMN_COLLATION 列 | 多变的 | 专栏(如果详细) | 列整理 |
COLUMN_IS_USERTYPE | 多变的 | 专栏(如果详细) | 该列是否为用户类型 |
INDICES_LISTING | 部分 | 桌子 | 标记 INDICES_LISTING 部分的开始和结束;INDICES_LISTING 数据字典在此部分中变为活动状态 |
指数 | 部分 | INDICES_LISTING | 标记 INDICES 部分的开始和结束;INDICES 数据字典在此部分中变为活动状态 |
INDEX_NAME | 多变的 | 指数 | 索引名称 |
INDEX_PRIMARY | 多变的 | 指数 | 这是否是主键 |
INDEX_UNIQUE | 多变的 | 指数 | 这是否是唯一索引 |
INDEX_TYPE | 多变的 | 指数 | 索引类型;例如,主要 |
INDEX_KIND | 多变的 | 指数 | 指标种类 |
INDEX_COMMENT | 多变的 | 指数 | 索引评论 |
INDEX_ID | 多变的 | 指数 | 索引号 |
INDEX_COLUMNS | 部分 | 指数 | 标记 INDEX_COLUMNS 部分的开始和结束;INDEX_COLUMNS 数据字典在此部分中变为活动状态 |
INDEX_COLUMN_NAME | 多变的 | INDEX_COLUMNS | 索引列名 |
INDEX_COLUMN_ORDER | 多变的 | INDEX_COLUMNS | 索引列顺序;例如,升序、降序 |
INDEX_COLUMN_COMMENT | 多变的 | INDEX_COLUMNS | 索引评论 |
INDEX_KEY_BLOCK_SIZE | 多变的 | INDEX_COLUMNS(如果详细) | 索引键块大小 |
REL_LISTING | 部分 | 桌子 | 标记 REL_LISTING 部分的开始和结束;REL_LISTING 数据字典在此部分中变为活动状态 |
相对值 | 部分 | REL_LISTING | 标记 REL 部分的开始和结束;REL 数据字典在此部分中变为活动状态 |
REL_NAME | 多变的 | REL,FOREIGN_KEYS | 关系名称 |
REL_TYPE | 多变的 | REL,FOREIGN_KEYS | 关系类型 |
REL_PARENTTABLE | 多变的 | REL,FOREIGN_KEYS | 关系父表 |
REL_CHILDTABLE | 多变的 | REL,FOREIGN_KEYS | 关系子表 |
REL_CARD | 多变的 | REL,FOREIGN_KEYS | 关系基数 |
FOREIGN_KEY_ID | 多变的 | 相对值 | 外键 ID |
FOREIGN_KEYS | 部分 | 图式 | 标记 FOREIGN_KEYS 部分的开始和结束;FOREIGN_KEYS 数据字典在此部分中变为活动状态 |
FK_DELETE_RULE | 多变的 | FOREIGN_KEYS | 外键删除规则 |
FK_UPDATE_RULE | 多变的 | FOREIGN_KEYS | 外键更新规则 |
FK_MANDATORY | 多变的 | FOREIGN_KEYS | 外键是否必填 |
TABLE_COMMENT_LISTING | 部分 | 桌子 | 标记 TABLE_COMMENT_LISTING 部分的开始和结束;TABLE_COMMENT_LISTING 数据字典在此部分中变为活动状态 |
TABLE_COMMENT | 多变的 | TABLE_COMMENT_LISTING | 表格注释 |
DDL_LISTING | 部分 | 桌子 | 标记 DDL_LISTING 部分的开始和结束;DDL_LISTING 数据字典在此部分中变为活动状态 |
DDL_脚本 | 多变的 | DDL_LISTING | 显示当前活动实体的DDL脚本;例如,模式、表格 |