Modifier and Type	Class and Description
public static enum	SchemaExport.Action
private static class	SchemaExport.CommandLineArgs
private static class	SchemaExport.TargetDescriptorImpl
public static enum	SchemaExport.Type

Modifier and Type	Field and Description
pack-priv boolean	append
pack-priv String	delimiter
private final List<Exception>	exceptions
pack-priv boolean	format
pack-priv boolean	haltOnError
private String	importFiles
private static final CoreMessageLogger	LOG
pack-priv boolean	manageNamespaces
pack-priv String	outputFile

Access	Constructor and Description
public	SchemaExport()

Method Summary

Modifier and Type	Method and Description
private static MetadataImplementor	buildMetadata(SchemaExport.CommandLineArgs parsedArgs, StandardServiceRegistry serviceRegistry)
public static MetadataImplementor	Returns: The built Metadata buildMetadataFromMainArgs(String[] The "command line args" args) Intended for test usage only.
private static StandardServiceRegistry	buildStandardServiceRegistry(SchemaExport.CommandLineArgs commandLineArgs)
public static TargetDescriptor	buildTargetDescriptor(EnumSet<TargetType> targetTypes, String outputFile, ServiceRegistry serviceRegistry)
public static TargetDescriptor	buildTargetDescriptor(EnumSet<TargetType> targetTypes, String outputFile, boolean append, ServiceRegistry serviceRegistry)
public void	create(EnumSet<TargetType> targetTypes, Metadata metadata)
public void	createOnly(EnumSet<TargetType> targetTypes, Metadata metadata)
public void	doExecution(SchemaExport.Action action, boolean needsJdbc, Metadata metadata, ServiceRegistry serviceRegistry, TargetDescriptor targetDescriptor)
public void	drop(EnumSet<TargetType> targetTypes, Metadata metadata)
public void	execute(EnumSet<TargetType> targetTypes, SchemaExport.Action action, Metadata metadata)
public void	execute(EnumSet<TargetType> targetTypes, SchemaExport.Action action, Metadata metadata, ServiceRegistry serviceRegistry)
public static void	execute(SchemaExport.CommandLineArgs commandLineArgs)
public List<E>	Returns: A List containing the Exceptions occurred during the export getExceptions() Returns a List of all Exceptions which occurred during the export.
public static void	main(String[] args)
private boolean	needsJdbcConnection(EnumSet<TargetType> targetTypes)
public void	perform(SchemaExport.Action action, Metadata metadata, ScriptTargetOutput target) For testing use
public SchemaExport	Returns: this setDelimiter(String The delimiter delimiter) Set the end of statement delimiter
public SchemaExport	Returns: this setFormat(boolean Should we format SQL strings format) Should we format the sql strings?
public SchemaExport	Returns: this setHaltOnError(boolean True if export should stop after error. haltOnError) Should we stop once an error occurs?
public SchemaExport	Returns: this setImportFiles(String The comma-separated list of init file resources names importFiles) Comma-separated list of resource names to use for database init commands on create.
public SchemaExport	setManageNamespaces(boolean manageNamespaces)
public SchemaExport	Returns: this setOutputFile(String The name of the file to which to write the export script. filename) For generating a export script file, this is the file which will be written.
public SchemaExport	Returns: this setOverrideOutputFileContent() For generating a export script file, by default the content will be appended at the begin or end of the file.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

append	back to summary
pack-priv boolean append

delimiter	back to summary
pack-priv String delimiter

exceptions	back to summary
private final List<Exception> exceptions

format	back to summary
pack-priv boolean format

haltOnError	back to summary
pack-priv boolean haltOnError

importFiles	back to summary
private String importFiles

LOG	back to summary
private static final CoreMessageLogger LOG

manageNamespaces	back to summary
pack-priv boolean manageNamespaces

outputFile	back to summary
pack-priv String outputFile

Constructor Detail

SchemaExport	back to summary
public SchemaExport()

Method Detail

buildMetadata	back to summary
private static MetadataImplementor buildMetadata(SchemaExport.CommandLineArgs parsedArgs, StandardServiceRegistry serviceRegistry) throws Exception

buildMetadataFromMainArgs back to summary

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

Intended for test usage only. Builds a Metadata using the same algorithm as main

Parameters

args:String[]: The "command line args"

Returns:MetadataImplementor

The built Metadata

Exceptions

Exception:: Problems building the Metadata

buildStandardServiceRegistry	back to summary
private static StandardServiceRegistry buildStandardServiceRegistry(SchemaExport.CommandLineArgs commandLineArgs) throws Exception

buildTargetDescriptor	back to summary
public static TargetDescriptor buildTargetDescriptor(EnumSet<TargetType> targetTypes, String outputFile, ServiceRegistry serviceRegistry)

buildTargetDescriptor	back to summary
public static TargetDescriptor buildTargetDescriptor(EnumSet<TargetType> targetTypes, String outputFile, boolean append, ServiceRegistry serviceRegistry)

create	back to summary
public void create(EnumSet<TargetType> targetTypes, Metadata metadata)

createOnly	back to summary
public void createOnly(EnumSet<TargetType> targetTypes, Metadata metadata)

doExecution	back to summary
public void doExecution(SchemaExport.Action action, boolean needsJdbc, Metadata metadata, ServiceRegistry serviceRegistry, TargetDescriptor targetDescriptor)

drop	back to summary
public void drop(EnumSet<TargetType> targetTypes, Metadata metadata)

execute	back to summary
public void execute(EnumSet<TargetType> targetTypes, SchemaExport.Action action, Metadata metadata)

execute	back to summary
public void execute(EnumSet<TargetType> targetTypes, SchemaExport.Action action, Metadata metadata, ServiceRegistry serviceRegistry) Annotations @SuppressWarnings:unchecked

execute	back to summary
public static void execute(SchemaExport.CommandLineArgs commandLineArgs) throws Exception

getExceptions	back to summary
public List<E> getExceptions() Returns a List of all Exceptions which occurred during the export. Returns:List<E> A List containing the Exceptions occurred during the export

getExceptions

back to summary

public List<E> getExceptions()

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

Returns:List<E>: A List containing the Exceptions occurred during the export

main	back to summary
public static void main(String[] args)

needsJdbcConnection	back to summary
private boolean needsJdbcConnection(EnumSet<TargetType> targetTypes)

perform	back to summary
public void perform(SchemaExport.Action action, Metadata metadata, ScriptTargetOutput target) For testing use

setDelimiter	back to summary
public SchemaExport setDelimiter(String delimiter) Set the end of statement delimiter Parameters delimiter:String The delimiter Returns:SchemaExport this

setDelimiter

back to summary

public SchemaExport setDelimiter(String delimiter)

Set the end of statement delimiter

Parameters

delimiter:String: The delimiter

Returns:SchemaExport

this

setFormat	back to summary
public SchemaExport setFormat(boolean format) Should we format the sql strings? Parameters format:boolean Should we format SQL strings Returns:SchemaExport this

setFormat

back to summary

public SchemaExport setFormat(boolean format)

Should we format the sql strings?

Parameters

format:boolean: Should we format SQL strings

Returns:SchemaExport

this

setHaltOnError	back to summary
public SchemaExport setHaltOnError(boolean haltOnError) Should we stop once an error occurs? Parameters haltOnError:boolean True if export should stop after error. Returns:SchemaExport this

setHaltOnError

back to summary

public SchemaExport setHaltOnError(boolean haltOnError)

Should we stop once an error occurs?

Parameters

haltOnError:boolean: True if export should stop after error.

Returns:SchemaExport

this

setImportFiles	back to summary
public SchemaExport setImportFiles(String importFiles) Comma-separated list of resource names to use for database init commands on create. Parameters importFiles:String The comma-separated list of init file resources names Returns:SchemaExport this

setImportFiles

back to summary

public SchemaExport setImportFiles(String importFiles)

Comma-separated list of resource names to use for database init commands on create.

Parameters

importFiles:String: The comma-separated list of init file resources names

Returns:SchemaExport

this

setManageNamespaces	back to summary
public SchemaExport setManageNamespaces(boolean manageNamespaces)

setOutputFile	back to summary
public SchemaExport setOutputFile(String filename) For generating a export script file, this is the file which will be written. Parameters filename:String The name of the file to which to write the export script. Returns:SchemaExport this

setOutputFile

back to summary

public SchemaExport setOutputFile(String filename)

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

Parameters

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

Returns:SchemaExport

this

setOverrideOutputFileContent	back to summary
public SchemaExport 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:SchemaExport this

setOverrideOutputFileContent

back to summary

public SchemaExport 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:SchemaExport: this

org.hibernate.tool.hbm2ddl back to summary

public final Enum SchemaExport.Action

Class Inheritance

extends Enum<SchemaExport.Action>

java.lang.Object
java.lang.Enum
org.hibernate.tool.hbm2ddl.SchemaExport.Action

Field Summary

Modifier and Type	Field and Description
public static final SchemaExport.Action	BOTH Drop and then create
public static final SchemaExport.Action	CREATE Create only
public static final SchemaExport.Action	DROP Drop only
public static final SchemaExport.Action	NONE None - duh :P

Constructor Summary

Access	Constructor and Description
private	Action()

Method Summary

Modifier and Type	Method and Description
public boolean	doCreate()
public boolean	doDrop()
private static SchemaExport.Action	interpret(boolean justDrop, boolean justCreate)
public static SchemaExport.Action	parseCommandLineOption(String actionText)
public static SchemaExport.Action	valueOf(String name)
public static SchemaExport.Action[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BOTH	back to summary
public static final SchemaExport.Action BOTH Drop and then create

CREATE	back to summary
public static final SchemaExport.Action CREATE Create only

DROP	back to summary
public static final SchemaExport.Action DROP Drop only

NONE	back to summary
public static final SchemaExport.Action NONE None - duh :P

Constructor Detail

Action	back to summary
private Action()

Method Detail

doCreate	back to summary
public boolean doCreate()

doDrop	back to summary
public boolean doDrop()

interpret	back to summary
private static SchemaExport.Action interpret(boolean justDrop, boolean justCreate)

parseCommandLineOption	back to summary
public static SchemaExport.Action parseCommandLineOption(String actionText)

valueOf	back to summary
public static SchemaExport.Action valueOf(String name)

values	back to summary
public static SchemaExport.Action[] values()

org.hibernate.tool.hbm2ddl back to summary

private Class SchemaExport.CommandLineArgs

Class Inheritance

extends Object

java.lang.Object
org.hibernate.tool.hbm2ddl.SchemaExport.CommandLineArgs

Field Summary

Modifier and Type	Field and Description
pack-priv SchemaExport.Action	action
pack-priv String	cfgXmlFile
pack-priv String	delimiter
pack-priv boolean	format
pack-priv boolean	halt
pack-priv List<String>	hbmXmlFiles
pack-priv String	implicitNamingStrategyImplName
pack-priv String	importFile
pack-priv List<String>	jarFiles
pack-priv boolean	manageNamespaces
pack-priv String	outputFile
pack-priv String	physicalNamingStrategyImplName
pack-priv String	propertiesFile
pack-priv EnumSet<TargetType>	targetTypes

Constructor Summary

Access	Constructor and Description
private	CommandLineArgs()

Method Summary

Modifier and Type	Method and Description
public static SchemaExport.CommandLineArgs	parseCommandLineArgs(String[] args)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

action	back to summary
pack-priv SchemaExport.Action action

cfgXmlFile	back to summary
pack-priv String cfgXmlFile

delimiter	back to summary
pack-priv String delimiter

format	back to summary
pack-priv boolean format

halt	back to summary
pack-priv boolean halt

hbmXmlFiles	back to summary
pack-priv List<String> hbmXmlFiles

implicitNamingStrategyImplName	back to summary
pack-priv String implicitNamingStrategyImplName

importFile	back to summary
pack-priv String importFile

jarFiles	back to summary
pack-priv List<String> jarFiles

manageNamespaces	back to summary
pack-priv boolean manageNamespaces

outputFile	back to summary
pack-priv String outputFile

physicalNamingStrategyImplName	back to summary
pack-priv String physicalNamingStrategyImplName

propertiesFile	back to summary
pack-priv String propertiesFile

targetTypes	back to summary
pack-priv EnumSet<TargetType> targetTypes

Constructor Detail

CommandLineArgs	back to summary
private CommandLineArgs()

Method Detail

parseCommandLineArgs	back to summary
public static SchemaExport.CommandLineArgs parseCommandLineArgs(String[] args)

org.hibernate.tool.hbm2ddl back to summary

private Class SchemaExport.TargetDescriptorImpl

Class Inheritance

extends Object
implements TargetDescriptor

java.lang.Object
org.hibernate.tool.hbm2ddl.SchemaExport.TargetDescriptorImpl

All Implemented Interfaces

org.hibernate.tool.schema.spi.TargetDescriptor

Field Summary

Modifier and Type	Field and Description
private final ScriptTargetOutput	scriptTarget
private final EnumSet<TargetType>	targetTypes

Constructor Summary

Access	Constructor and Description
public	TargetDescriptorImpl(EnumSet<TargetType> targetTypes, ScriptTargetOutput scriptTarget)

Method Summary

Modifier and Type	Method and Description
public ScriptTargetOutput	getScriptTargetOutput() Implements org.hibernate.tool.schema.spi.TargetDescriptor.getScriptTargetOutput. If `getTargetTypes()` includes scripts, return a representation of the script file to write to.
public EnumSet<TargetType>	getTargetTypes() Implements org.hibernate.tool.schema.spi.TargetDescriptor.getTargetTypes. The target type described here.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

scriptTarget	back to summary
private final ScriptTargetOutput scriptTarget

targetTypes	back to summary
private final EnumSet<TargetType> targetTypes

Constructor Detail

TargetDescriptorImpl	back to summary
public TargetDescriptorImpl(EnumSet<TargetType> targetTypes, ScriptTargetOutput scriptTarget)

Method Detail

getScriptTargetOutput back to summary

public ScriptTargetOutput getScriptTargetOutput()

Implements org.hibernate.tool.schema.spi.TargetDescriptor.getScriptTargetOutput.

Doc from org.hibernate.tool.schema.spi.TargetDescriptor.getScriptTargetOutput.

If getTargetTypes() includes scripts, return a representation of the script file to write to. Otherwise, returns null.

While it is ultimately up to the actual tooling provider, it is generally an error for getTargetTypes() to indicate that scripts are a target and for this method to return null.

Returns:ScriptTargetOutput

The script output target

Annotations

@Override

getTargetTypes

back to summary

public EnumSet<TargetType> getTargetTypes()

Implements org.hibernate.tool.schema.spi.TargetDescriptor.getTargetTypes.

Doc from org.hibernate.tool.schema.spi.TargetDescriptor.getTargetTypes.

The target type described here.

Returns:EnumSet<TargetType>

The target type.

Annotations

@Override

org.hibernate.tool.hbm2ddl back to summary

public final Enum SchemaExport.Type

Class Inheritance

extends Enum<SchemaExport.Type>

java.lang.Object
java.lang.Enum
org.hibernate.tool.hbm2ddl.SchemaExport.Type

Field Summary

Modifier and Type	Field and Description
private final SchemaExport.Action	actionReplacement
public static final SchemaExport.Type	BOTH
public static final SchemaExport.Type	CREATE
public static final SchemaExport.Type	DROP
public static final SchemaExport.Type	NONE

Constructor Summary

Access	Constructor and Description
private	Type(SchemaExport.Action actionReplacement)

Method Summary

Modifier and Type	Method and Description
public boolean	doCreate()
public boolean	doDrop()
public static SchemaExport.Type	valueOf(String name)
public static SchemaExport.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

actionReplacement	back to summary
private final SchemaExport.Action actionReplacement

BOTH	back to summary
public static final SchemaExport.Type BOTH

CREATE	back to summary
public static final SchemaExport.Type CREATE

DROP	back to summary
public static final SchemaExport.Type DROP

NONE	back to summary
public static final SchemaExport.Type NONE

Constructor Detail

Type	back to summary
private Type(SchemaExport.Action actionReplacement)

Method Detail

doCreate	back to summary
public boolean doCreate()

doDrop	back to summary
public boolean doDrop()

valueOf	back to summary
public static SchemaExport.Type valueOf(String name)

values	back to summary
public static SchemaExport.Type[] values()

public Class SchemaExport

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SchemaExport.Action

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SchemaExport.CommandLineArgs

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SchemaExport.TargetDescriptorImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SchemaExport.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail