doc.tables.table.ftl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-tools

Hibernate Tools

There is a newer version: 5.6.15.Final

<#import "/doc/common.ftl" as common>




	
		Hibernate Mappings - Table Info
		
	
	

		<@common.header/>

		Schema ${dochelper.getQualifiedSchemaName(table)}
		Table ${table.name}

		<#if table.comment?exists>
			${table.comment}
		

		
				<#foreach column in table.columnIterator>
					
			
				
					
						Column Summary
					
				
				
					
						Name
					
					
						SqlType
					
					
						Length
					
					
						Precision
					
					
						Scale
					
					
						Nullable
					
					
						Unique
					
				
			
			
						
							
								${column.name}
							
						
						
							${dochelper.getSQLTypeName(column)}
						
						
							${column.length}
						
						
							${column.precision}
						
						
							${column.scale}
						
						
							${column.nullable?string}
						
						
							${column.unique?string}
						
					
				
			
		

		<#-- SHOW THE PRIMARY KEY -->
		
				<#if table.hasPrimaryKey()>
					
				<#else>
					
			
				
					
						Primary Key
					
				
				
					
						Name
					
					
						Columns
					
				
			
			
						
							<#if table.primaryKey.name?has_content>
								${table.primaryKey.name}
							<#else>
								Name not specified
							
						
						
							<#list table.primaryKey.columnIterator() as column>
								
									${column.name}
								
							
						
					

						
							No Primary Key
						
					
				
			
		

		<#-- SHOW THE FOREIGN KEYS -->
		<#if table.foreignKeyIterator.hasNext()>
			
					<#foreach foreignKey in table.foreignKeyIterator>
						
				
					
						
							Foreign Keys
						
					
					
						
							Name
						
						
							Referenced Table
						
						
							Columns
						
					
				
				
							
								${foreignKey.name?default("Name not specified")}
							
							
								
									${foreignKey.referencedTable.name}
								
							
							
								<#foreach column in foreignKey.getColumnIterator()>
									
										${column.name}
									
								
							
						
					
				
			
		
			
		<#-- SHOW THE UNIQUE KEYS -->
		<#if table.uniqueKeyIterator.hasNext()>
			
					<#foreach uniqueKey in table.getUniqueKeyIterator()>
						
				
					
						
							Unique Keys
						
					
					
						
							Name
						
						
							Columns
						
					
				
				
							
								${uniqueKey.name?default("Name not specified")}
							
							
								<#foreach column in uniqueKey.getColumnIterator()>
									
										${column.name}
									
								
							
						
					
				
			
		
		
		<#-- SHOW THE TABLE INDEXES -->
		<#if table.indexIterator.hasNext()>
			
					<#foreach index in table.indexIterator>
						
				
					
						
							Indexes
						
					
					
						
							Name
						
						
							Columns
						
					
				
				
							
								${index.name?default("Name not specificed")}
							
							
								<#foreach column in index.columnIterator>
									
										${column.name}
									
								
							
						
					
				
			
		
		
		<#if table.columnIterator.hasNext()>
			
				Column Detail
			
				
			<#foreach column in table.columnIterator>
				${column.name}
				
				
					
						Type: ${dochelper.getSQLTypeName(column)}
					
					
						Length: ${column.length}
					
					
						Precision: ${column.precision}
					
					
						Scale: ${column.scale}
					
					
						Nullable: ${column.nullable?string}
					
					
						Unique: ${column.unique?string}
					
					
						Comment: ${column.comment?if_exists}
					
				

				<#--
					Mappings:

					#foreach($property in $dochelper.getProperties($table, $column))
						$property.persistentClass.className - $property.name
					#end
				-->

Column Summary
Name	SqlType	Length	Precision	Scale	Nullable	Unique
${column.name}	${dochelper.getSQLTypeName(column)}	${column.length}	${column.precision}	${column.scale}	${column.nullable?string}	${column.unique?string}

Primary Key
Name	Columns
<#if table.primaryKey.name?has_content> ${table.primaryKey.name} <#else> Name not specified	<#list table.primaryKey.columnIterator() as column> ${column.name}
No Primary Key

Foreign Keys
Name	Referenced Table	Columns
${foreignKey.name?default("Name not specified")}	${foreignKey.referencedTable.name}	<#foreach column in foreignKey.getColumnIterator()> ${column.name}

Unique Keys
Name	Columns
${uniqueKey.name?default("Name not specified")}	<#foreach column in uniqueKey.getColumnIterator()> ${column.name}

Indexes
Name	Columns
${index.name?default("Name not specificed")}	<#foreach column in index.columnIterator> ${column.name}