9.8.1 Supported Template Markers

The following table shows the supported markers. These markers can be used in any template, including custom templates.

Using the table

The table shows which variables are defined in which sections. The variable should be used in its correct section or its value will not be displayed. If a variable type is a variable, then the table describes its data dictionary, and a parent dictionary if type is a section. Also remember that the data dictionaries used to perform variable lookups form a hierarchical tree, so it is possible to use a variable in a child section that is defined in a parent section.

Table 9.2 Supported Template Markers

Marker textTypeData Dictionary or Parent DictionaryCorresponding data
TITLEVariableMAINTitle of the report
GENERATEDVariableMAINDate and time when the report was generated
STYLE_NAMEVariableMAINThe 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_COUNTVariableMAINThe number of schemata in the model
PROJECT_TITLEVariableMAINProject title as set for the model in Document Properties
PROJECT_NAMEVariableMAINProject name as set for the model in Document Properties
PROJECT_AUTHORVariableMAINProject author as set for the model in Document Properties
PROJECT_VERSIONVariableMAINProject version as set for the model in Document Properties
PROJECT_DESCRIPTIONVariableMAINProject description as set for the model in Document Properties
PROJECT_CREATEDVariableMAINAutomatically set for the model project, but as displayed in Document Properties
PROJECT_CHANGEDVariableMAINAutomatically set for the model project, but as displayed in Document Properties
TOTAL_TABLE_COUNTVariableMAINThe number of tables in all schemata in the model
TOTAL_COLUMN_COUNTVariableMAINThe number of columns in all tables in all schemata in the model
TOTAL_INDEX_COUNTVariableMAINThe number of indexes in the model
TOTAL_FK_COUNTVariableMAINThe number of foreign keys in the model
SCHEMATASectionMAINUsed to mark the start and end of a SCHEMATA section; the SCHEMATA data dictionary becomes active in this section
SCHEMA_NAMEVariableSCHEMATAThe schema name
SCHEMA_IDVariableSCHEMATAThe schema ID
TABLE_COUNTVariableSCHEMATAThe number of tables in the current schema
COLUMN_COUNTVariableSCHEMATAThe number of columns in the current schema
INDICES_COUNTVariableSCHEMATAThe number of indexes in the current schema
FOREIGN_KEYS_COUNTVariableSCHEMATAThe number of foreign keys in the current schema
TABLESSectionSCHEMATAMarks the start and end of a TABLES section; the TABLES data dictionary becomes active in this section
TABLE_NAMEVariableTABLESThe table name
TABLE_IDVariableTABLESThe table ID
COLUMNS_LISTINGSectionTABLESMarks the start and end of a COLUMNS_LISTING section; the COLUMNS_LISTING data dictionary becomes active in this section
COLUMNSSectionCOLUMNS_LISTINGMarks the start and end of a COLUMNS section; the COLUMNS data dictionary becomes active in this section
COLUMN_KEYVariableCOLUMNSWhether the column is a primary key
COLUMN_NAMEVariableCOLUMNSThe column name
COLUMN_DATATYPEVariableCOLUMNSThe column data type
COLUMN_NOTNULLVariableCOLUMNSWhether the column permits NULL values
COLUMN_DEFAULTVALUEVariableCOLUMNSThe column default value
COLUMN_COMMENTVariableCOLUMNSThe column comment
COLUMN_IDVariableCOLUMNSThe column ID
COLUMN_KEY_PARTVariableCOLUMNS (if detailed)The column key type
COLUMN_NULLABLEVariableCOLUMNS (if detailed)Can the column contain NULL values
COLUMN_AUTO_INCVariableCOLUMNS (if detailed)Does the column auto-increment
COLUMN_CHARSETVariableCOLUMNS (if detailed)The column character set
COLUMN_COLLATIONVariableCOLUMNS (if detailed)The column collation
COLUMN_IS_USERTYPEVariableCOLUMNS (if detailed)Whether the column is a user type
INDICES_LISTINGSectionTABLESMarks the start and end of an INDICES_LISTING section; the INDICES_LISTING data dictionary becomes active in this section
INDICESSectionINDICES_LISTINGMarks the start and end of an INDICES section; the INDICES data dictionary becomes active in this section
INDEX_NAMEVariableINDICESThe index name
INDEX_PRIMARYVariableINDICESWhether this is a primary key
INDEX_UNIQUEVariableINDICESWhether this is a unique index
INDEX_TYPEVariableINDICESThe index type; for example, PRIMARY
INDEX_KINDVariableINDICESThe index kind
INDEX_COMMENTVariableINDICESThe index comment
INDEX_IDVariableINDICESThe index ID
INDEX_COLUMNSSectionINDICESMarks the start and end of an INDEX_COLUMNS section; the INDEX_COLUMNS data dictionary becomes active in this section
INDEX_COLUMN_NAMEVariableINDEX_COLUMNSThe index column name
INDEX_COLUMN_ORDERVariableINDEX_COLUMNSThe index column order; for example, ascending, descending
INDEX_COLUMN_COMMENTVariableINDEX_COLUMNSThe index comment
INDEX_KEY_BLOCK_SIZEVariableINDEX_COLUMNS (if detailed)The index key-block size
REL_LISTINGSectionTABLESMarks the start and end of a REL_LISTING section; the REL_LISTING data dictionary becomes active in this section
RELSectionREL_LISTINGMarks the start and end of a REL section; the REL data dictionary becomes active in this section
REL_NAMEVariableREL, FOREIGN_KEYSThe relationship name
REL_TYPEVariableREL, FOREIGN_KEYSThe relationship type
REL_PARENTTABLEVariableREL, FOREIGN_KEYSThe relationship parent table
REL_CHILDTABLEVariableREL, FOREIGN_KEYSThe relationship child table
REL_CARDVariableREL, FOREIGN_KEYSThe relationship cardinality
FOREIGN_KEY_IDVariableRELForeign key ID
FOREIGN_KEYSSectionSCHEMATAMarks the start and end of a FOREIGN_KEYS section; the FOREIGN_KEYS data dictionary becomes active in this section
FK_DELETE_RULEVariableFOREIGN_KEYSThe foreign key delete rule
FK_UPDATE_RULEVariableFOREIGN_KEYSThe foreign key update rule
FK_MANDATORYVariableFOREIGN_KEYSWhether the foreign key is mandatory
TABLE_COMMENT_LISTINGSectionTABLESMarks the start and end of a TABLE_COMMENT_LISTING section; the TABLE_COMMENT_LISTING data dictionary becomes active in this section
TABLE_COMMENTVariableTABLE_COMMENT_LISTINGThe table comment
DDL_LISTINGSectionTABLESMarks the start and end of a DDL_LISTING section; the DDL_LISTING data dictionary becomes active in this section
DDL_SCRIPTVariableDDL_LISTINGDisplay the DDL script of the currently active entity; for example, SCHEMATA, TABLES