dbunit:compare

Full name:

org.dbunit:dbunit-maven-plugin:1.3.1-SNAPSHOT:compare

Description:

Execute DbUnit Compare operation.

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.0.

Required Parameters

Name	Type	Since	Description
`<driver>`	`String`	`1.0`	The class name of the JDBC driver to be used. User Property: `dbunit.driver`
`<src>`	`File`	`1.0`	DataSet file. User Property: `dbunit.src`
`<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`
`<escapePattern>`	`String`	`-`	Deprecated. since 1.0 - use the `dbconfig` attribute and the nested elements for this escapePattern. User Property: `dbunit.escapePattern`
`<format>`	`String`	`1.0`	DataSet file format. Default: `xml` User Property: `dbunit.format`
`<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`
`<queries>`	`Query[]`	`1.0`	List of DbUnit's Query. See DbUnit's org.dbunit.ant.Query JavaDoc for details.
`<replacementDataSetClass>`	`String`	`1.3`	Fully-qualified class name of a `org.dbunit.dataset.ReplacementDataSet` subclass to wrap the expected dataset before comparison. The class must have a public constructor that accepts a single `org.dbunit.dataset.IDataSet` argument. Use this to apply token substitution (e.g. replacing `[NULL]` with SQL `NULL`) without any coupling to the plugin itself. Example: public class MyReplacements extends ReplacementDataSet { public MyReplacements(IDataSet wrapped) { super(wrapped); addReplacementObject("[NULL]", null); } } User Property: `dbunit.replacementDataSetClass`
`<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`
`<sort>`	`boolean`	`1.0`	sort. User Property: `dbunit.sort`
`<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`
`<tables>`	`Table[]`	`1.0`	List of DbUnit's Table. See DbUnit's org.dbunit.ant.Table JavaDoc for details.
`<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

<driver>

The class name of the JDBC driver to be used.

Type: java.lang.String
Since: 1.0
Required: Yes
User Property: dbunit.driver

<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

<format>

DataSet file format.

Type: java.lang.String
Since: 1.0
Required: No
User Property: dbunit.format
Default: xml

<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

<queries>

List of DbUnit's Query. See DbUnit's org.dbunit.ant.Query JavaDoc for details.

Type: org.dbunit.ant.Query[]
Since: 1.0
Required: No

<replacementDataSetClass>

Fully-qualified class name of a org.dbunit.dataset.ReplacementDataSet subclass to wrap the expected dataset before comparison. The class must have a public constructor that accepts a single org.dbunit.dataset.IDataSet argument. Use this to apply token substitution (e.g. replacing [NULL] with SQL NULL) without any coupling to the plugin itself.

Example:

public class MyReplacements extends ReplacementDataSet {
    public MyReplacements(IDataSet wrapped) {
        super(wrapped);
        addReplacementObject("[NULL]", null);
    }
}

Type: java.lang.String
Since: 1.3
Required: No
User Property: dbunit.replacementDataSetClass

<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

<sort>

sort.

Type: boolean
Since: 1.0
Required: No
User Property: dbunit.sort

<src>

DataSet file.

Type: java.io.File
Since: 1.0
Required: Yes
User Property: dbunit.src

<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

<tables>

List of DbUnit's Table. See DbUnit's org.dbunit.ant.Table JavaDoc for details.

Type: org.dbunit.ant.Table[]
Since: 1.0
Required: No

<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