Package org.hibernate.tool.hbm2ddl

Class SchemaUpdate

java.lang.Object

org.hibernate.tool.hbm2ddl.SchemaUpdate

public class SchemaUpdate
extends Object

A commandline tool to update a database schema. May also be called from inside an application.

Constructor Summary

Constructors

Constructor	Description
SchemaUpdate()

Method Summary

Modifier and Type	Method	Description
static MetadataImplementor	buildMetadataFromMainArgs(String[] args)	Intended for test usage only.
void	execute(EnumSet<TargetType> targetTypes, Metadata metadata)
void	execute(EnumSet<TargetType> targetTypes, Metadata metadata, ServiceRegistry serviceRegistry)
List	getExceptions()	Returns a List of all Exceptions which occurred during the export.
static void	main(String[] args)
SchemaUpdate	setDelimiter(String delimiter)	Set the end of statement delimiter
SchemaUpdate	setFormat(boolean format)
SchemaUpdate	setHaltOnError(boolean haltOnError)
SchemaUpdate	setOutputFile(String outputFile)
SchemaUpdate	setOverrideOutputFileContent()	For generating a export script file, by default the content will be appended at the begin or end of the file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaUpdate

public SchemaUpdate()

Method Detail

execute

public void execute(EnumSet<TargetType> targetTypes,
                    Metadata metadata)

execute

public void execute(EnumSet<TargetType> targetTypes,
                    Metadata metadata,
                    ServiceRegistry serviceRegistry)

getExceptions

public List getExceptions()

Returns a List of all Exceptions which occurred during the export.

Returns:

A List containing the Exceptions occurred during the export

setHaltOnError

public SchemaUpdate setHaltOnError(boolean haltOnError)

setFormat

public SchemaUpdate setFormat(boolean format)

setOutputFile

public SchemaUpdate setOutputFile(String outputFile)

setOverrideOutputFileContent

public SchemaUpdate setOverrideOutputFileContent()

For generating a export script file, by default the content will be appended at the begin or end of the file. The sql will be written at the beginning of the file rather append to the end.

Returns:

this

setDelimiter

public SchemaUpdate setDelimiter(String delimiter)

Set the end of statement delimiter

Parameters:

delimiter - The delimiter

main

public static void main(String[] args)

buildMetadataFromMainArgs

public static MetadataImplementor buildMetadataFromMainArgs(String[] args)
                                                     throws Exception

Intended for test usage only. Builds a Metadata using the same algorithm as main(java.lang.String[])

Parameters:

args - The "command line args"

Returns:

The built Metadata

Throws:

Exception - Problems building the Metadata