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 and Description
SchemaUpdate(MetadataImplementor metadata) Creates a SchemaUpdate object.
SchemaUpdate(ServiceRegistry serviceRegistry, MetadataImplementor metadata) Creates a SchemaUpdate object.

Method Summary

Modifier and Type	Method and Description
static MetadataImplementor	buildMetadataFromMainArgs(String[] args) Intended for test usage only.
void	execute(boolean script, boolean doUpdate) Execute the schema updates
void	execute(Target target)
List	getExceptions() Returns a List of all Exceptions which occured during the export.
static void	main(String[] args)
void	setDelimiter(String delimiter) Set the end of statement delimiter
void	setFormat(boolean format)
void	setHaltOnError(boolean haltOnError)
void	setOutputFile(String outputFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaUpdate

public SchemaUpdate(MetadataImplementor metadata)

Creates a SchemaUpdate object. This form is intended for use from tooling

Parameters:

metadata - The metadata defining the schema as it should be after update

Throws:

HibernateException

SchemaUpdate

public SchemaUpdate(ServiceRegistry serviceRegistry,
                    MetadataImplementor metadata)
             throws HibernateException

Creates a SchemaUpdate object. This form is intended for use from hibernate.hbm2ddl.auto handling, generally from within the SessionFactory ctor.

Note that the passed ServiceRegistry is expected to be of type SessionFactoryServiceRegistry, although any ServiceRegistry type will work as long as it has access to the JdbcServices service.

Parameters:

serviceRegistry - The ServiceRegistry to use.

metadata - The metadata defining the schema as it should be after update

Throws:

HibernateException

Method Detail

execute

public void execute(boolean script,
                    boolean doUpdate)

Execute the schema updates

Parameters:

script - print all DDL to the console

execute

public void execute(Target target)

getExceptions

public List getExceptions()

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

Returns:

A List containig the Exceptions occured during the export

setHaltOnError

public void setHaltOnError(boolean haltOnError)

setFormat

public void setFormat(boolean format)

setOutputFile

public void setOutputFile(String outputFile)

setDelimiter

public void 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