Skip to content

TableInfo

The TableInfo object contains all information about a database table.

Properties

PropertyTypeDescription
nameStringobject name to be generated (underscore to lower camel case)
obj.nameStringtable name
preNameStringTable name prefix
commentStringTable comment
templateGroupNameStringTemplate group name
fullColumnList<ColumnInfo>All columns in the table
pkColumnList<ColumnInfo>Primary key columns
otherColumnList<ColumnInfo>Non-primary key columns
savePackageNameStringPackage name for generated code
savePathStringSave path for generated files
saveModelNameStringModel name for saving
extMap<String, Object>Extended data
escapedTableNameStringEscaped table name
ext1StringExtended field 1
ext2StringExtended field 2
ext3StringExtended field 3
ext4StringExtended field 4

Methods

MethodReturn TypeDescription
getOnePkColumn()ColumnInfoGet the first primary key column (if only one exists)

Example Usage

velocity
## Table Information
Table Name: ${tableInfo.name}
Comment: ${tableInfo.comment}
Package: ${tableInfo.savePackageName}

## Primary Key
#if($tableInfo.getOnePkColumn())
Primary Key: ${tableInfo.getOnePkColumn().name}
Type: ${tableInfo.getOnePkColumn().shortType}
#end

## All Columns
#foreach($column in $tableInfo.fullColumn)
- ${column.name}: ${column.shortType} (${column.comment})
#end