Package org.hibernate.tool.hbm2ddl
Class SchemaExport
- java.lang.Object
-
- org.hibernate.tool.hbm2ddl.SchemaExport
-
public class SchemaExport extends Object
Command-line tool for exporting (create and/or drop) a database schema. The export can be sent directly to the database, written to script or both.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SchemaExport.Action
static class
SchemaExport.Type
-
Constructor Summary
Constructors Constructor Description SchemaExport()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MetadataImplementor
buildMetadataFromMainArgs(String[] args)
Intended for test usage only.static TargetDescriptor
buildTargetDescriptor(EnumSet<TargetType> targetTypes, String outputFile, ServiceRegistry serviceRegistry)
void
create(EnumSet<TargetType> targetTypes, Metadata metadata)
void
createOnly(EnumSet<TargetType> targetTypes, Metadata metadata)
void
doExecution(SchemaExport.Action action, boolean needsJdbc, Metadata metadata, ServiceRegistry serviceRegistry, TargetDescriptor targetDescriptor)
void
drop(EnumSet<TargetType> targetTypes, Metadata metadata)
void
execute(EnumSet<TargetType> targetTypes, SchemaExport.Action action, Metadata metadata)
void
execute(EnumSet<TargetType> targetTypes, SchemaExport.Action action, Metadata metadata, ServiceRegistry serviceRegistry)
static void
execute(org.hibernate.tool.hbm2ddl.SchemaExport.CommandLineArgs commandLineArgs)
List
getExceptions()
Returns a List of all Exceptions which occurred during the export.static void
main(String[] args)
void
perform(SchemaExport.Action action, Metadata metadata, ScriptTargetOutput target)
For testing useSchemaExport
setDelimiter(String delimiter)
Set the end of statement delimiterSchemaExport
setFormat(boolean format)
Should we format the sql strings?SchemaExport
setHaltOnError(boolean haltOnError)
Should we stop once an error occurs?SchemaExport
setImportFiles(String importFiles)
Comma-separated list of resource names to use for database init commands on create.SchemaExport
setManageNamespaces(boolean manageNamespaces)
SchemaExport
setOutputFile(String filename)
For generating a export script file, this is the file which will be written.
-
-
-
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
-
setImportFiles
public SchemaExport setImportFiles(String importFiles)
Comma-separated list of resource names to use for database init commands on create.- Parameters:
importFiles
- The comma-separated list of init file resources names- 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
-
setHaltOnError
public SchemaExport setHaltOnError(boolean haltOnError)
Should we stop once an error occurs?- Parameters:
haltOnError
- True if export should stop after error.- Returns:
- this
-
setManageNamespaces
public SchemaExport setManageNamespaces(boolean manageNamespaces)
-
drop
public void drop(EnumSet<TargetType> targetTypes, Metadata metadata)
-
create
public void create(EnumSet<TargetType> targetTypes, Metadata metadata)
-
createOnly
public void createOnly(EnumSet<TargetType> targetTypes, Metadata metadata)
-
execute
public void execute(EnumSet<TargetType> targetTypes, SchemaExport.Action action, Metadata metadata)
-
execute
public void execute(EnumSet<TargetType> targetTypes, SchemaExport.Action action, Metadata metadata, ServiceRegistry serviceRegistry)
-
doExecution
public void doExecution(SchemaExport.Action action, boolean needsJdbc, Metadata metadata, ServiceRegistry serviceRegistry, TargetDescriptor targetDescriptor)
-
buildTargetDescriptor
public static TargetDescriptor buildTargetDescriptor(EnumSet<TargetType> targetTypes, String outputFile, ServiceRegistry serviceRegistry)
-
perform
public void perform(SchemaExport.Action action, Metadata metadata, ScriptTargetOutput target)
For testing use
-
main
public static void main(String[] args)
-
execute
public static void execute(org.hibernate.tool.hbm2ddl.SchemaExport.CommandLineArgs commandLineArgs) throws Exception
- Throws:
Exception
-
buildMetadataFromMainArgs
public static MetadataImplementor buildMetadataFromMainArgs(String[] args) throws Exception
Intended for test usage only. Builds a Metadata using the same algorithm asmain(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 occurred during the export.- Returns:
- A List containing the Exceptions occurred during the export
-
-