文档主页
MySQL Workbench 手册
相关文档 下载本手册
PDF (US Ltr) - 17.0Mb
PDF (A4) - 17.0Mb


9.7.1 支持的模板标记

下表显示了支持的标记。这些标记可以在任何模板中使用,包括自定义模板。

使用表格

该表显示了在哪些部分定义了哪些变量。变量应该在其正确的部分使用,否则其值将不会显示。如果变量 type 是一个变量,则该表描述其数据字典,如果 type 是一个部分,则描述其父字典。还要记住,用于执行变量查找的数据字典形成一个层次结构树,因此可以在子部分中使用在父部分中定义的变量。

表 9.3 支持的模板标记

标记文本 类型 数据字典或父字典 对应数据
TITLE 变量 MAIN 报告标题
GENERATED 变量 MAIN 报告生成日期和时间
STYLE_NAME 变量 MAIN 在 MySQL Workbench 中选择的样式名称,通常用于加载相应的 CSS 文件,具体取决于在 MySQL Workbench 中选择的样式名称
SCHEMA_COUNT 变量 MAIN 模型中的模式数量
PROJECT_TITLE 变量 MAIN 文档属性 中为模型设置的项目标题
PROJECT_NAME 变量 MAIN 文档属性 中为模型设置的项目名称
PROJECT_AUTHOR 变量 MAIN 文档属性 中为模型设置的项目作者
PROJECT_VERSION 变量 MAIN 文档属性 中为模型设置的项目版本
PROJECT_DESCRIPTION 变量 MAIN 文档属性 中为模型设置的项目描述
PROJECT_CREATED 变量 MAIN 自动为模型项目设置,但在 文档属性 中显示
PROJECT_CHANGED 变量 MAIN 自动为模型项目设置,但在 文档属性 中显示
TOTAL_TABLE_COUNT 变量 MAIN 模型中所有模式中的表总数
TOTAL_COLUMN_COUNT 变量 MAIN 模型中所有模式中所有表的列总数
TOTAL_INDEX_COUNT 变量 MAIN 模型中的索引数量
TOTAL_FK_COUNT 变量 MAIN 模型中的外键数量
SCHEMATA 部分 MAIN 用于标记 SCHEMATA 部分的开始和结束;SCHEMATA 数据字典在此部分中激活
SCHEMA_NAME 变量 SCHEMATA 模式名称
SCHEMA_ID 变量 SCHEMATA 模式 ID
TABLE_COUNT 变量 SCHEMATA 当前模式中的表数量
COLUMN_COUNT 变量 SCHEMATA 当前模式中的列数量
INDICES_COUNT 变量 SCHEMATA 当前模式中的索引数量
FOREIGN_KEYS_COUNT 变量 SCHEMATA 当前模式中的外键数量
TABLES 部分 SCHEMATA 标记 TABLES 部分的开始和结束;TABLES 数据字典在此部分中激活
TABLE_NAME 变量 TABLES 表名
TABLE_ID 变量 TABLES 表 ID
COLUMNS_LISTING 部分 TABLES 标记 COLUMNS_LISTING 部分的开始和结束;COLUMNS_LISTING 数据字典在此部分中激活
COLUMNS 部分 COLUMNS_LISTING 标记 COLUMNS 部分的开始和结束;COLUMNS 数据字典在此部分中激活
COLUMN_KEY 变量 COLUMNS 列是否是主键
COLUMN_NAME 变量 COLUMNS 列名
COLUMN_DATATYPE 变量 COLUMNS 列数据类型
COLUMN_NOTNULL 变量 COLUMNS 列是否允许 NULL
COLUMN_DEFAULTVALUE 变量 COLUMNS 列默认值
COLUMN_COMMENT 变量 COLUMNS 列注释
COLUMN_ID 变量 COLUMNS 列 ID
COLUMN_KEY_PART 变量 COLUMNS(如果详细) 列键类型
COLUMN_NULLABLE 变量 COLUMNS(如果详细) 列是否可以包含 NULL
COLUMN_AUTO_INC 变量 COLUMNS(如果详细) 列是否自动递增
COLUMN_CHARSET 变量 COLUMNS(如果详细) 列字符集
COLUMN_COLLATION 变量 COLUMNS(如果详细) 列排序规则
COLUMN_IS_USERTYPE 变量 COLUMNS(如果详细) 列是否是用户类型
INDICES_LISTING 部分 TABLES 标记 INDICES_LISTING 部分的开始和结束;INDICES_LISTING 数据字典在此部分中激活
INDICES 部分 INDICES_LISTING 标记 INDICES 部分的开始和结束;INDICES 数据字典在此部分中激活
INDEX_NAME 变量 INDICES 索引名称
INDEX_PRIMARY 变量 INDICES 这是否是主键
INDEX_UNIQUE 变量 INDICES 这是否是唯一索引
INDEX_TYPE 变量 INDICES 索引类型;例如,PRIMARY
INDEX_KIND 变量 INDICES 索引种类
INDEX_COMMENT 变量 INDICES 索引注释
INDEX_ID 变量 INDICES 索引 ID
INDEX_COLUMNS 部分 INDICES 标记 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 部分 TABLES 标记 REL_LISTING 部分的开始和结束;REL_LISTING 数据字典在此部分中激活
REL 部分 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 变量 REL 外键 ID
FOREIGN_KEYS 部分 SCHEMATA 标记 FOREIGN_KEYS 部分的开始和结束;FOREIGN_KEYS 数据字典在此部分中激活
FK_DELETE_RULE 变量 FOREIGN_KEYS 外键删除规则
FK_UPDATE_RULE 变量 FOREIGN_KEYS 外键更新规则
FK_MANDATORY 变量 FOREIGN_KEYS 外键是否为强制性
TABLE_COMMENT_LISTING 部分 TABLES 标记 TABLE_COMMENT_LISTING 部分的开始和结束;TABLE_COMMENT_LISTING 数据字典在此部分中激活
TABLE_COMMENT 变量 TABLE_COMMENT_LISTING 表注释
DDL_LISTING 部分 TABLES 标记 DDL_LISTING 部分的开始和结束;DDL_LISTING 数据字典在此部分中激活
DDL_SCRIPT 变量 DDL_LISTING 显示当前活动实体的 DDL 脚本;例如,SCHEMATA、TABLES