org.apache.ddlutils.task

Class WriteSchemaSqlToFileCommand

java.lang.Object

org.apache.ddlutils.task.Command

org.apache.ddlutils.task.DatabaseCommand

org.apache.ddlutils.task.DatabaseCommandWithCreationParameters

org.apache.ddlutils.task.WriteSchemaSqlToFileCommand

public class WriteSchemaSqlToFileCommand
extends DatabaseCommandWithCreationParameters

Parses the schema XML files specified in the enclosing task, and writes the SQL statements necessary to create this schema in the database, to a file. Note that this SQL is database specific and hence this subtask requires that for the enclosing task, either a data source is specified (via the database sub element) or the databaseType attribute is used to specify the database type.

Field Summary

Fields inherited from class org.apache.ddlutils.task.DatabaseCommand

_addIdentityUsingAlterTable, _isolationLevel, _platformConf

Fields inherited from class org.apache.ddlutils.task.Command

_log

Constructor Summary

Constructors

Constructor and Description
WriteSchemaSqlToFileCommand()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfiguredDatabase(org.apache.commons.dbcp.BasicDataSource dataSource) Adds the data source to use for accessing the database.
void	execute(DatabaseTaskBase task, Database model) Executes this command.
protected boolean	isAlterDatabase() Determines whether to alter the database if it already exists, or re-set it.
protected boolean	isDoDrops() Determines whether SQL is generated to drop tables and the associated constraints if necessary.
boolean	isExportAll() Return true if all database object have to be exported directly by the target platform database (only for GemFireXD).
boolean	isExportDDLs() Return true if DDLs have to be exported directly by the target platform database (only for GemFireXD).
boolean	isShutdownDatabase() Determines whether the database shall be shut down after the task has finished.
boolean	isSortForeignKeys() Determines whether a table's foreign keys read from a live database shall be sorted alphabetically.
boolean	isUseDelimitedSqlIdentifiers() Determines whether delimited SQL identifiers shall be used (the default).
void	setAlterDatabase(boolean alterTheDb) Specifies whether DdlUtils shall generate SQL to alter an existing database rather than SQL for clearing it and creating it new.
void	setCatalogPattern(String catalogPattern) Specifies a pattern that defines which database catalogs to use.
void	setDatabaseType(String type) Specifies the database type.
void	setDoDrops(boolean doDrops) Specifies whether SQL for dropping tables, external constraints, etc.
void	setExportAll(boolean exportAll) Set the flag for isExportAll().
void	setExportDDLs(boolean exportDDLs) Set the flag for isExportDDLs().
void	setOutputFile(File outputFile) Specifies the name of the file to write the SQL commands to.
protected void	setPlatformConfiguration(PlatformConfiguration platformConf) Sets the platform configuration.
void	setSchemaPattern(String schemaPattern) Specifies a pattern that defines which database schemas to use.
void	setShutdownDatabase(boolean shutdownDatabase) Specifies whether DdlUtils shall shut down the database after the task has finished.
void	setSortForeignKeys(boolean sortForeignKeys) Specifies whether DdlUtils shall sort the foreign keys of a table read from a live database or leave them in the order in which they are returned by the database/JDBC driver.
void	setUseDelimitedSqlIdentifiers(boolean useDelimitedSqlIdentifiers) Specifies whether DdlUtils shall use delimited (quoted) identifiers (such as table and column names).

Methods inherited from class org.apache.ddlutils.task.DatabaseCommandWithCreationParameters

addConfiguredParameter, getFilteredParameters

Methods inherited from class org.apache.ddlutils.task.DatabaseCommand

getCatalogPattern, getDatabaseType, getDataSource, getIsolationLevel, getPlatform, getSchemaPattern, isAddIdentityUsingAlterTable, isRequiringModel, setAddIdentityUsingAlterTable, setIsolationLevel

Methods inherited from class org.apache.ddlutils.task.Command

handleException, isFailOnError, setFailOnError

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteSchemaSqlToFileCommand

public WriteSchemaSqlToFileCommand()

Method Detail

setOutputFile

public void setOutputFile(File outputFile)

Specifies the name of the file to write the SQL commands to.

Parameters:

outputFile - The output file

isAlterDatabase

protected boolean isAlterDatabase()

Determines whether to alter the database if it already exists, or re-set it.

Returns:

true if to alter the database

setAlterDatabase

public void setAlterDatabase(boolean alterTheDb)

Specifies whether DdlUtils shall generate SQL to alter an existing database rather than SQL for clearing it and creating it new.

Parameters:

alterTheDb - true if SQL to alter the database shall be created

isDoDrops

protected boolean isDoDrops()

Determines whether SQL is generated to drop tables and the associated constraints if necessary.

Returns:

true if drops SQL shall be generated if necessary

setDoDrops

public void setDoDrops(boolean doDrops)

Specifies whether SQL for dropping tables, external constraints, etc. is created if necessary. Note that this is only relevant when alterDatabase is false.

Parameters:

doDrops - true if drops shall be performed if necessary

execute

public void execute(DatabaseTaskBase task,
           Database model)
             throws org.apache.tools.ant.BuildException

Executes this command.

Specified by:

execute in class Command

Parameters:

task - The executing task

model - The database model

Throws:

org.apache.tools.ant.BuildException

isExportDDLs

public boolean isExportDDLs()

Return true if DDLs have to be exported directly by the target platform database (only for GemFireXD).

isExportAll

public boolean isExportAll()

Return true if all database object have to be exported directly by the target platform database (only for GemFireXD).

setExportDDLs

public void setExportDDLs(boolean exportDDLs)

Set the flag for isExportDDLs().

setExportAll

public void setExportAll(boolean exportAll)

Set the flag for isExportAll().

setPlatformConfiguration

protected void setPlatformConfiguration(PlatformConfiguration platformConf)

Sets the platform configuration.

Overrides:

setPlatformConfiguration in class DatabaseCommand

Parameters:

platformConf - The platform configuration

setDatabaseType

public void setDatabaseType(String type)

Specifies the database type. You should only need to set this if DdlUtils is not able to derive the setting from the name of the used jdbc driver or the jdbc connection url. If you have to specify this, please post your jdbc driver and connection url combo to the user mailing list so that DdlUtils can be enhanced to support this combo.
Valid values are currently:
axion, cloudscape, db2, derby, firebird, hsqldb, interbase, maxdb, mckoi, mssql, mysql, mysql5, oracle, oracle9, oracle10, oracle11, postgresql, sapdb, gemfirexd, sybase

Parameters:

type - The database type

addConfiguredDatabase

public void addConfiguredDatabase(org.apache.commons.dbcp.BasicDataSource dataSource)

Adds the data source to use for accessing the database.

Parameters:

dataSource - The data source

setCatalogPattern

public void setCatalogPattern(String catalogPattern)

Specifies a pattern that defines which database catalogs to use. For some more info on catalog patterns and JDBC, see java.sql.DatabaseMetaData.

Parameters:

catalogPattern - The catalog pattern

setSchemaPattern

public void setSchemaPattern(String schemaPattern)

Specifies a pattern that defines which database schemas to use. For some more info on schema patterns and JDBC, see java.sql.DatabaseMetaData.

Parameters:

schemaPattern - The schema pattern

isUseDelimitedSqlIdentifiers

public boolean isUseDelimitedSqlIdentifiers()

Determines whether delimited SQL identifiers shall be used (the default).

Returns:

true if delimited SQL identifiers shall be used

setUseDelimitedSqlIdentifiers

public void setUseDelimitedSqlIdentifiers(boolean useDelimitedSqlIdentifiers)

Specifies whether DdlUtils shall use delimited (quoted) identifiers (such as table and column names). Most databases convert undelimited identifiers to uppercase and ignore the case of identifiers when performing any SQL command. Undelimited identifiers also cannot be reserved words and can only contain alphanumerical characters and the underscore.
These limitations do not exist for delimited identifiers where identifiers have to be enclosed in double quotes. Delimited identifiers can contain unicode characters, and even reserved words can be used as identifiers. Please be aware though, that they always have to enclosed in double quotes, and that the case of the identifier will be important in every SQL command executed against the database.

Parameters:

useDelimitedSqlIdentifiers - true if delimited SQL identifiers shall be used

isSortForeignKeys

public boolean isSortForeignKeys()

Determines whether a table's foreign keys read from a live database shall be sorted alphabetically. Is false by default.

Returns:

true if the foreign keys shall be sorted

setSortForeignKeys

public void setSortForeignKeys(boolean sortForeignKeys)

Specifies whether DdlUtils shall sort the foreign keys of a table read from a live database or leave them in the order in which they are returned by the database/JDBC driver. Note that the sort is case sensitive only if delimited identifier mode is on (useDelimitedSqlIdentifiers is set to true).

Parameters:

sortForeignKeys - true if the foreign keys shall be sorted

isShutdownDatabase

public boolean isShutdownDatabase()

Determines whether the database shall be shut down after the task has finished.

Returns:

true if the database shall be shut down

setShutdownDatabase

public void setShutdownDatabase(boolean shutdownDatabase)

Specifies whether DdlUtils shall shut down the database after the task has finished. This is mostly useful for embedded databases.

Parameters:

shutdownDatabase - true if the database shall be shut down