org.apache.ddlutils.task

Class DatabaseToDdlTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.ddlutils.task.DatabaseTaskBase

org.apache.ddlutils.task.DatabaseToDdlTask

All Implemented Interfaces:

Cloneable

public class DatabaseToDdlTask
extends DatabaseTaskBase

Task for getting structural info and data from a live database. Eg. it has sub tasks for writing the schema of the live database or the data currently in it to an XML file, for creating the DTDs for these data files, and for generating SQL to creating a schema in the database to a file.
Example:

 <taskdef classname="org.apache.ddlutils.task.DatabaseToDdlTask"
          name="databaseToDdl"
          classpathref="project-classpath" />
 
 <databaseToDdl usedelimitedsqlidentifiers="true"
                modelname="example">
   <database driverclassname="org.apache.derby.jdbc.ClientDriver"
             url="jdbc:derby://localhost/ddlutils"
             username="ddlutils"
             password="ddlutils"/> 
 
   <writeschematofile outputfile="schema.xml"/> 
   <writedatatofile outputfile="data.xml"
                    encoding="ISO-8859-1"/> 
 </databaseToDdl> 
 

This reads the schema and data from the database and writes them to XML files.

Field Summary

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

_isolationLevel, _log

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
DatabaseToDdlTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDropTables(DropTablesCommand command) Adds the "drop tables"-command.
void	addWriteDataToDatabase(WriteDataToDatabaseCommand command) Adds the "write data into database"-command.
void	addWriteDataToFile(WriteDataToFileCommand command) Adds the "write data into file"-command.
void	addWriteDtdToFile(WriteDtdToFileCommand command) Adds the "create dtd"-command.
void	addWriteSchemaSqlToFile(WriteSchemaSqlToFileCommand command) Adds the "write schema sql to file"-command.
void	addWriteSchemaToFile(WriteSchemaToFileCommand command) Adds the "write schema to file"-command.
protected Database	readModel() Reads the database model on which the commands will work.
void	setExcludeTableFilter(String tableNameRegExp) Sets the regular expression matching the names of the tables that shall be ignored.
void	setExcludeTables(String tableNameList) Sets the names of the tables that shall be ignored, as a comma-separated list.
void	setIncludeTableFilter(String tableNameRegExp) Sets the regular expression matching the names of the tables that shall be read.
void	setIncludeTables(String tableNameList) Sets the names of the tables that shall be read, as a comma-separated list.
void	setModelName(String modelName) Specifies the name of the model that is read from the database.
void	setTableTypes(String tableTypes) Specifies the table types to be processed.

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

addCommand, addConfiguredDatabase, execute, executeCommands, getCommands, getDatabaseType, getDataSource, getIsolationLevel, getPlatform, getPlatformConfiguration, hasCommands, isShutdownDatabase, isSortForeignKeys, isUseDelimitedSqlIdentifiers, setCatalogPattern, setDatabaseType, setIsolationLevel, setSchemaPattern, setShutdownDatabase, setSimpleLogging, setSortForeignKeys, setUseDelimitedSqlIdentifiers, setVerbosity

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseToDdlTask

public DatabaseToDdlTask()

Method Detail

setTableTypes

public void setTableTypes(String tableTypes)

Specifies the table types to be processed. More precisely, all tables that are of a type not in this list, will be ignored by the task and its sub tasks. For details and typical table types see java.sql.DatabaseMetaData#getTables.

Parameters:

tableTypes - The table types as a comma-separated list

setModelName

public void setModelName(String modelName)

Specifies the name of the model that is read from the database. This is mostly useful for the the writeSchemaToFile sub-task as it ensures that the generated XML defines a valid model.

Parameters:

modelName - The model name. Use null or an empty string for the default name

setIncludeTables

public void setIncludeTables(String tableNameList)

Sets the names of the tables that shall be read, as a comma-separated list. Escape a comma via '\,' if it is part of the table name. Please note that table names are not trimmed which means that whitespace characters should only be present in this string if they are actually part of the table name (i.e. in delimited identifer mode). If delimited identifer mode is activated, do NOT use the FULL table name like [SCHEMA].[TABLENAME]; [TABLENAME] is sufficient

Parameters:

tableNameList - The comma-separated list of table names

setIncludeTableFilter

public void setIncludeTableFilter(String tableNameRegExp)

Sets the regular expression matching the names of the tables that shall be read. For case insensitive matching, an uppercase name can be assumed.

Parameters:

tableNameRegExp - The regular expression; see Pattern for details

setExcludeTables

public void setExcludeTables(String tableNameList)

Sets the names of the tables that shall be ignored, as a comma-separated list. Escape a comma via '\,' if it is part of the table name. Please note that table names are not trimmed which means that whitespace characters should only be present in this string if they are actually part of the table name (i.e. in delimited identifer mode).

Parameters:

tableNameList - The comma-separated list of table names

setExcludeTableFilter

public void setExcludeTableFilter(String tableNameRegExp)

Sets the regular expression matching the names of the tables that shall be ignored. For case insensitive matching, an uppercase name can be assumed.

Parameters:

tableNameRegExp - The regular expression; see Pattern for details

addWriteDtdToFile

public void addWriteDtdToFile(WriteDtdToFileCommand command)

Adds the "create dtd"-command.

Parameters:

command - The command

addWriteSchemaToFile

public void addWriteSchemaToFile(WriteSchemaToFileCommand command)

Adds the "write schema to file"-command.

Parameters:

command - The command

addWriteSchemaSqlToFile

public void addWriteSchemaSqlToFile(WriteSchemaSqlToFileCommand command)

Adds the "write schema sql to file"-command.

Parameters:

command - The command

addWriteDataToDatabase

public void addWriteDataToDatabase(WriteDataToDatabaseCommand command)

Adds the "write data into database"-command.

Parameters:

command - The command

addWriteDataToFile

public void addWriteDataToFile(WriteDataToFileCommand command)

Adds the "write data into file"-command.

Parameters:

command - The command

addDropTables

public void addDropTables(DropTablesCommand command)

Adds the "drop tables"-command.

Parameters:

command - The command

readModel

protected Database readModel()

Reads the database model on which the commands will work.

Specified by:

readModel in class DatabaseTaskBase

Returns:

The database model