MySQL Workbench :: 7 Data Modeling :: 7.9 Customizing DBDoc Model Reporting Templates :: 7.9.1 Supported Template Markers
Section Navigation [Toggle]
- 7.9 Customizing DBDoc Model Reporting Templates
- 7.9.1 Supported Template Markers
- 7.9.2 Creating a custom template
A list of supported markers follows. These markers can be used in any template, including custom templates.
| Marker text | Type | Data Dictionary defined in (if variable) or parent dictionary (if section) | Corresponding data |
| TITLE | Variable | MAIN | Title of the report |
| GENERATED | Variable | MAIN | Date and time that the report was generated |
| STYLE_NAME | Variable | MAIN | The name of the style selected in MySQL Workbench. This is typically used to load the corresponding CSS file, depending on the name of the style selected in MySQL Workbench. |
| SCHEMA_COUNT | Variable | MAIN | The total number of schemata in the model |
| PROJECT_TITLE | Variable | MAIN | Project title as set for the model in Document Properties. |
| PROJECT_NAME | Variable | MAIN | Project name as set for the model in Document Properties. |
| PROJECT_AUTHOR | Variable | MAIN | Project author as set for the model in Document Properties. |
| PROJECT_VERSION | Variable | MAIN | Project version as set for the model in Document Properties. |
| PROJECT_DESCRIPTION | Variable | MAIN | Project description as set for the model in Document Properties. |
| PROJECT_CREATED | Variable | MAIN | Automatically set for the model project, but as displayed in Document Properties. |
| PROJECT_CHANGED | Variable | MAIN | Automatically set for the model project, but as displayed in Document Properties. |
| TOTAL_TABLE_COUNT | Variable | MAIN | Total number of tables in all schemata contained in the model. |
| TOTAL_COLUMN_COUNT | Variable | MAIN | Total number of columns in all tables in all schemata in the model. |
| TOTAL_INDEX_COUNT | Variable | MAIN | Total number of indexes in the model. |
| TOTAL_FK_COUNT | Variable | MAIN | Total number of foreign keys in the model. |
| SCHEMATA | Section | MAIN | Used to mark the start and end of a SCHEMATA section. The SCHEMATA data dictionary becomes active in this section. |
| SCHEMA_NAME | Variable | SCHEMATA | The name of a schema in the model |
| SCHEMA_ID | Variable | SCHEMATA | The ID of the schema |
| TABLE_COUNT | Variable | SCHEMATA | Total total number of tables in the current schema |
| COLUMN_COUNT | Variable | SCHEMATA | The total number of columns in the current schema |
| INDICES_COUNT | Variable | SCHEMATA | The total number of indexes in the current schema |
| FOREIGN_KEYS_COUNT | Variable | SCHEMATA | The total number of foreign keys in the current schema |
| TABLES | Section | SCHEMATA | Marks the start and end of a TABLES section. The TABLES data dictionary becomes active in this section. |
| TABLE_NAME | Variable | TABLES | The table name |
| TABLE_ID | Variable | TABLES | The table ID |
| COLUMNS_LISTING | Section | TABLES | Marks the start and end of a COLUMNS_LISTING section. The COLUMNS_LISTING data dictionary becomes active in this section. |
| COLUMNS | Section | COLUMNS_LISTING | Marks the start and end of a COLUMNS section. The COLUMNS data dictionary becomes active in this section. |
| COLUMN_KEY | Variable | COLUMNS | Whether the column is a primary key or not |
| COLUMN_NAME | Variable | COLUMNS | The name of the column |
| COLUMN_DATATYPE | Variable | COLUMNS | The data type of the column |
| COLUMN_NOTNULL | Variable | COLUMNS | Whether or not the column allows NULLs |
| COLUMN_DEFAULTVALUE | Variable | COLUMNS | The default value of entries in this column |
| COLUMN_COMMENT | Variable | COLUMNS | Any comment for this column |
| COLUMN_ID | Variable | COLUMNS | The ID of the column |
| COLUMN_KEY_PART | Variable | COLUMNS (if detailed) | The type of column key |
| COLUMN_NULLABLE | Variable | COLUMNS (if detailed) | Can the column contain NULLs |
| COLUMN_AUTO_INC | Variable | COLUMNS (if detailed) | Does the column auto-increment |
| COLUMN_CHARSET | Variable | COLUMNS (if detailed) | The character set used by the column |
| COLUMN_COLLATION | Variable | COLUMNS (if detailed) | The collation used by the column |
| COLUMN_IS_USERTYPE | Variable | COLUMNS (if detailed) | Whether or not the column is a user type |
| INDICES_LISTING | Section | TABLES | Marks the start and end of an INDICES_LISTING section. The INDICES_LISTING data dictionary becomes active in this section. |
| INDICES | Section | INDICES_LISTING | Marks the start and end of an INDICES section. The INDICES data dictionary becomes active in this section. |
| INDEX_NAME | Variable | INDICES | The name of the index |
| INDEX_PRIMARY | Variable | INDICES | Is this a primary index |
| INDEX_UNIQUE | Variable | INDICES | Is this a unique index |
| INDEX_TYPE | Variable | INDICES | The type of index e.g. PRIMARY |
| INDEX_KIND | Variable | INDICES | The kind of index |
| INDEX_COMMENT | Variable | INDICES | A comment for the index |
| INDEX_ID | Variable | INDICES | The ID of the index |
| INDEX_COLUMNS | Section | INDICES | Marks the start and end of an INDEX_COLUMNS section. The INDEX_COLUMNS data dictionary becomes active in this section. |
| INDEX_COLUMN_NAME | Variable | INDEX_COLUMNS | The index column name |
| INDEX_COLUMN_ORDER | Variable | INDEX_COLUMNS | The index column order e.g. ascending, descending |
| INDEX_COLUMN_COMMENT | Variable | INDEX_COLUMNS | A comment for the index column |
| INDEX_KEY_BLOCK_SIZE | Variable | INDEX_COLUMNS (if detailed) | Index key block size |
| REL_LISTING | Section | TABLES | Marks the start and end of a REL_LISTING section. The REL_LISTING data dictionary becomes active in this section. |
| REL | Section | REL_LISTING | Marks the start and end of a REL section. The REL data dictionary becomes active in this section. |
| REL_NAME | Variable | REL, FOREIGN_KEYS | Relationship name |
| REL_TYPE | Variable | REL, FOREIGN_KEYS | Relationship type |
| REL_PARENTTABLE | Variable | REL, FOREIGN_KEYS | Parent table of relationship |
| REL_CHILDTABLE | Variable | REL, FOREIGN_KEYS | Child table of relationship |
| REL_CARD | Variable | REL, FOREIGN_KEYS | Relationship card |
| FOREIGN_KEY_ID | Variable | REL | Foreign key ID |
| FOREIGN_KEYS | Section | SCHEMATA | Marks the start and end of a FOREIGN_KEYS section. The FOREIGN_KEYS data dictionary becomes active in this section. |
| FK_DELETE_RULE | Variable | FOREIGN_KEYS | Foreign key delete rule |
| FK_UPDATE_RULE | Variable | FOREIGN_KEYS | Foreign key update rule |
| FK_MANDATORY | Variable | FOREIGN_KEYS | Foreign key mandatory |
| TABLE_COMMENT_LISTING | Section | TABLES | Marks the start and end of a TABLE_COMMENT_LISTING section. The TABLE_COMMENT_LISTING data dictionary becomes active in this section. |
| TABLE_COMMENT | Variable | TABLE_COMMENT_LISTING | A comment for the table |
| DDL_LISTING | Section | TABLES | Marks the start and end of a DDL_LISTING section. The DDL_LISTING data dictionary becomes active in this section. |
| DDL_SCRIPT | Variable | DDL_LISTING | Display the DDL script of the currently active entity e..g. SCHEMATA, TABLES |
Using the table
The table shows which variables are defined in which sections. The variable should be used in its correct section, otherwise its value will not be displayed.
Note
It should be remembered though that the data dictionaries used to perform the lookup form a hierarchical tree, so it is possible to use a variable defined in a parent section, in a child section.
