org.hibernate.tool.hbm2ddl

Class SchemaExport

java.lang.Object

org.hibernate.tool.hbm2ddl.SchemaExport

public class SchemaExport
extends Object

Commandline tool to export table schema to the database. This class may also be called from inside an application.

Author:

Daniel Bradby, Gavin King, Steve Ebersole

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaExport.Type

Constructor Summary

Constructors

Constructor and Description
SchemaExport(Configuration configuration) Deprecated. Use one of the forms accepting MetadataImplementor, rather than Configuration, instead.
SchemaExport(Configuration configuration, Connection connection) Deprecated. Use one of the forms accepting MetadataImplementor, rather than Configuration, instead.
SchemaExport(ConnectionHelper connectionHelper, MetadataImplementor metadata) Intended for testing use
SchemaExport(ConnectionHelper connectionHelper, String[] dropSql, String[] createSql)
SchemaExport(MetadataImplementor metadata) Builds a SchemaExport object.
SchemaExport(MetadataImplementor metadata, boolean createNamespaces) Builds a SchemaExport object.
SchemaExport(MetadataImplementor metadata, Connection connection) Create a SchemaExport for the given Metadata, using the supplied connection for connectivity.
SchemaExport(ServiceRegistry serviceRegistry, Configuration configuration) Deprecated. Use one of the forms accepting MetadataImplementor, rather than Configuration, instead.
SchemaExport(ServiceRegistry serviceRegistry, MetadataImplementor metadata) Builds a SchemaExport object.
SchemaExport(ServiceRegistry serviceRegistry, MetadataImplementor metadata, boolean createNamespaces) Builds a SchemaExport object.

Method Summary

Modifier and Type	Method and Description
static MetadataImplementor	buildMetadataFromMainArgs(String[] args) Intended for test usage only.
void	create(boolean script, boolean export) Run the schema creation script; drop script is automatically executed before running the creation script.
void	create(Target output) Run the schema creation script; drop script is automatically executed before running the creation script.
void	drop(boolean script, boolean export) Run the drop schema script.
void	drop(Target output)
void	execute(boolean script, boolean export, boolean justDrop, boolean justCreate)
void	execute(Target output, SchemaExport.Type type)
List	getExceptions() Returns a List of all Exceptions which occured during the export.
static void	main(String[] args)
SchemaExport	setDelimiter(String delimiter) Set the end of statement delimiter
SchemaExport	setFormat(boolean format) Should we format the sql strings?
SchemaExport	setHaltOnError(boolean haltOnError) Should we stop once an error occurs?
SchemaExport	setImportSqlCommandExtractor(ImportSqlCommandExtractor importSqlCommandExtractor) Set import.sql command extractor.
SchemaExport	setOutputFile(String filename) For generating a export script file, this is the file which will be written.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaExport

public SchemaExport(MetadataImplementor metadata)

Builds a SchemaExport object.

Parameters:

metadata - The metadata object holding the mapping info to be exported

SchemaExport

public SchemaExport(MetadataImplementor metadata,
                    boolean createNamespaces)

Builds a SchemaExport object.

Parameters:

metadata - The metadata object holding the mapping info to be exported

SchemaExport

public SchemaExport(ServiceRegistry serviceRegistry,
                    MetadataImplementor metadata)

Builds a SchemaExport object.

Parameters:

serviceRegistry - The registry of services available for use. Should, at a minimum, contain the JdbcServices service.

metadata - The metadata object holding the mapping info to be exported

SchemaExport

public SchemaExport(ServiceRegistry serviceRegistry,
                    MetadataImplementor metadata,
                    boolean createNamespaces)

Builds a SchemaExport object.

Parameters:

serviceRegistry - The registry of services available for use. Should, at a minimum, contain the JdbcServices service.

metadata - The metadata object holding the mapping info to be exported

SchemaExport

public SchemaExport(ConnectionHelper connectionHelper,
                    MetadataImplementor metadata)

Intended for testing use

Parameters:

connectionHelper - Access to the JDBC Connection

metadata - The metadata object holding the mapping info to be exported

SchemaExport

public SchemaExport(MetadataImplementor metadata,
                    Connection connection)
             throws HibernateException

Create a SchemaExport for the given Metadata, using the supplied connection for connectivity.

Parameters:

metadata - The metadata object holding the mapping info to be exported

connection - The JDBC connection to use.

Throws:

HibernateException - Indicates problem preparing for schema export.

SchemaExport

@Deprecated
public SchemaExport(ServiceRegistry serviceRegistry,
                                Configuration configuration)

Deprecated. Use one of the forms accepting MetadataImplementor, rather than Configuration, instead.

SchemaExport

@Deprecated
public SchemaExport(Configuration configuration)

Deprecated. Use one of the forms accepting MetadataImplementor, rather than Configuration, instead.

SchemaExport

@Deprecated
public SchemaExport(Configuration configuration,
                                Connection connection)
                         throws HibernateException

Deprecated. Use one of the forms accepting MetadataImplementor, rather than Configuration, instead.

Throws:

HibernateException

SchemaExport

public SchemaExport(ConnectionHelper connectionHelper,
                    String[] dropSql,
                    String[] createSql)

Method Detail

setOutputFile

public SchemaExport setOutputFile(String filename)

For generating a export script file, this is the file which will be written.

Parameters:

filename - The name of the file to which to write the export script.

Returns:

this

setDelimiter

public SchemaExport setDelimiter(String delimiter)

Set the end of statement delimiter

Parameters:

delimiter - The delimiter

Returns:

this

setFormat

public SchemaExport setFormat(boolean format)

Should we format the sql strings?

Parameters:

format - Should we format SQL strings

Returns:

this

setImportSqlCommandExtractor

public SchemaExport setImportSqlCommandExtractor(ImportSqlCommandExtractor importSqlCommandExtractor)

Set import.sql command extractor. By default SingleLineSqlCommandExtractor is used.

Parameters:

importSqlCommandExtractor - import.sql command extractor.

Returns:

this

setHaltOnError

public SchemaExport setHaltOnError(boolean haltOnError)

Should we stop once an error occurs?

Parameters:

haltOnError - True if export should stop after error.

Returns:

this

create

public void create(boolean script,
                   boolean export)

Run the schema creation script; drop script is automatically executed before running the creation script.

Parameters:

script - print the DDL to the console

export - export the script to the database

create

public void create(Target output)

Run the schema creation script; drop script is automatically executed before running the creation script.

Parameters:

output - the target of the script.

drop

public void drop(boolean script,
                 boolean export)

Run the drop schema script.

Parameters:

script - print the DDL to the console

export - export the script to the database

drop

public void drop(Target output)

execute

public void execute(boolean script,
                    boolean export,
                    boolean justDrop,
                    boolean justCreate)

execute

public void execute(Target output,
                    SchemaExport.Type type)

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

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