dbunit:export-dtd

Full name:

org.dbunit:dbunit-maven-plugin:1.3.1-SNAPSHOT:export-dtd

Description:

Execute DbUnit Export DTD operation. Exports a flat DTD schema from the connected database, with tables ordered by foreign key constraints. The generated DTD can be used to validate flat XML dataset files and to enable IDE auto-completion.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 1.2.2.

Required Parameters

Name Type Since Description
<driver> String 1.0 The class name of the JDBC driver to be used.
User Property: dbunit.driver
<url> String 1.0 The JDBC URL for the database to access, e.g. jdbc:db2:SAMPLE.
User Property: dbunit.url

Optional Parameters

Name Type Since Description
<caseSensitiveTableNames> boolean -
Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Be case sensitive when handling tables.
See also: http://dbunit.sourceforge.net/properties.html#casesensitivetablenames
Default: false
User Property: dbunit.caseSensitiveTableNames
<dataTypeFactoryName> String -
Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Set the DataType factory to add support for non-standard database vendor data types.
Default: org.dbunit.dataset.datatype.DefaultDataTypeFactory
User Property: dbunit.dataTypeFactoryName
<datatypeWarning> boolean -
Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Enable or disable the warning message displayed when DbUnit encounter an unsupported data type.
Default: false
User Property: dbunit.datatypeWarning
<dbconfig> Properties 1.0 DB configuration child element to configure org.dbunit.database.DatabaseConfig properties in a generic way. This makes the many attributes/properties in this class obsolete and sets the value directly where it should go into which is the org.dbunit.database.DatabaseConfig.
User Property: dbunit.dbconfig
<dest> File 1.2.2 Location of the exported DTD file.
Default: ${project.build.directory}/dbunit/export.dtd
User Property: dbunit.dest
<encoding> String 1.2.2 Encoding of the exported DTD file.
Default: ${project.build.sourceEncoding}
User Property: dbunit.encoding
<escapePattern> String -
Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

escapePattern.
User Property: dbunit.escapePattern
<metadataHandlerName> String 1.0-beta-3
Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Class name of metadata handler.
Default: org.dbunit.database.DefaultMetadataHandler
User Property: dbunit.metadataHandlerName
<password> String 1.0 Database password. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
User Property: dbunit.password
<schema> String 1.0 The schema name that tables can be found under.
User Property: dbunit.schema
<settingsKey> String 1.0 Server's id in settings.xml to look up username and password. Default to ${url} if not given.
User Property: dbunit.settingsKey
<skip> boolean 1.0 Skip the execution when true, very handy when using together with maven.test.skip.
Default: false
User Property: dbunit.skip
<skipOracleRecycleBinTables> boolean 1.0-beta-2
Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

skipOracleRecycleBinTables.
Default: false
User Property: dbunit.skipOracleRecycleBinTables
<supportBatchStatement> boolean -
Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Enable or disable usage of JDBC batched statement by DbUnit.
Default: false
User Property: dbunit.supportBatchStatement
<useQualifiedTableNames> boolean -
Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Enable or disable multiple schemas support by prefixing table names with the schema name.
Default: false
User Property: dbunit.useQualifiedTableNames
<username> String 1.0 Database username. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
User Property: dbunit.username

Parameter Details

<caseSensitiveTableNames>

Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Be case sensitive when handling tables.
See also: http://dbunit.sourceforge.net/properties.html#casesensitivetablenames
  • Type: boolean
  • Required: No
  • User Property: dbunit.caseSensitiveTableNames
  • Default: false

<dataTypeFactoryName>

Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Set the DataType factory to add support for non-standard database vendor data types.
  • Type: java.lang.String
  • Required: No
  • User Property: dbunit.dataTypeFactoryName
  • Default: org.dbunit.dataset.datatype.DefaultDataTypeFactory

<datatypeWarning>

Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Enable or disable the warning message displayed when DbUnit encounter an unsupported data type.
  • Type: boolean
  • Required: No
  • User Property: dbunit.datatypeWarning
  • Default: false

<dbconfig>

DB configuration child element to configure org.dbunit.database.DatabaseConfig properties in a generic way. This makes the many attributes/properties in this class obsolete and sets the value directly where it should go into which is the org.dbunit.database.DatabaseConfig.
  • Type: java.util.Properties
  • Since: 1.0
  • Required: No
  • User Property: dbunit.dbconfig

<dest>

Location of the exported DTD file.
  • Type: java.io.File
  • Since: 1.2.2
  • Required: No
  • User Property: dbunit.dest
  • Default: ${project.build.directory}/dbunit/export.dtd

<driver>

The class name of the JDBC driver to be used.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • User Property: dbunit.driver

<encoding>

Encoding of the exported DTD file.
  • Type: java.lang.String
  • Since: 1.2.2
  • Required: No
  • User Property: dbunit.encoding
  • Default: ${project.build.sourceEncoding}

<escapePattern>

Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

escapePattern.
  • Type: java.lang.String
  • Required: No
  • User Property: dbunit.escapePattern

<metadataHandlerName>

Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Class name of metadata handler.
  • Type: java.lang.String
  • Since: 1.0-beta-3
  • Required: No
  • User Property: dbunit.metadataHandlerName
  • Default: org.dbunit.database.DefaultMetadataHandler

<password>

Database password. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: dbunit.password

<schema>

The schema name that tables can be found under.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: dbunit.schema

<settingsKey>

Server's id in settings.xml to look up username and password. Default to ${url} if not given.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: dbunit.settingsKey

<skip>

Skip the execution when true, very handy when using together with maven.test.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: dbunit.skip
  • Default: false

<skipOracleRecycleBinTables>

Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

skipOracleRecycleBinTables.
  • Type: boolean
  • Since: 1.0-beta-2
  • Required: No
  • User Property: dbunit.skipOracleRecycleBinTables
  • Default: false

<supportBatchStatement>

Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Enable or disable usage of JDBC batched statement by DbUnit.
  • Type: boolean
  • Required: No
  • User Property: dbunit.supportBatchStatement
  • Default: false

<url>

The JDBC URL for the database to access, e.g. jdbc:db2:SAMPLE.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • User Property: dbunit.url

<useQualifiedTableNames>

Deprecated.
since 1.0 - use the dbconfig attribute and the nested elements for this

Enable or disable multiple schemas support by prefixing table names with the schema name.
  • Type: boolean
  • Required: No
  • User Property: dbunit.useQualifiedTableNames
  • Default: false

<username>

Database username. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: dbunit.username