dbunit:compare

Execute DbUnit Compare operation

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Requires dependency resolution of artifacts in scope: compile

Required Parameters

Name Type Description
driver String The class name of the JDBC driver to be used.
src File DataSet file
url String The JDBC URL for the database to access, e.g. jdbc:db2:SAMPLE.

Optional Parameters

Name Type Description
dataTypeFactoryName String Set the DataType factory to add support for non-standard database vendor data types. Default value is org.dbunit.dataset.datatype.DefaultDataTypeFactory.
datatypeWarning boolean Enable or disable the warning message displayed when DbUnit encounter an unsupported data type. Default value is false.
escapePattern String escapePattern
format String DataSet file format Default value is xml.
password String Database password. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key
queries Query[] List of DbUnit's Query. See DbUnit's org.dbunit.ant.Query JavaDoc for details
schema String The schema name that tables can be found under.
settingsKey String Server's id in settings.xml to look up username and password. Default to ${url} if not given.
skip boolean Skip the execution when true, very handy when using together with maven.test.skip. Default value is false.
sort boolean sort
supportBatchStatement boolean Enable or disable usage of JDBC batched statement by DbUnit Default value is false.
tables Table[] List of DbUnit's Table. See DbUnit's org.dbunit.ant.Table JavaDoc for details
useQualifiedTableNames boolean Enable or disable multiple schemas support by prefixing table names with the schema name. Default value is false.
username String Database username. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key

Parameter Details

dataTypeFactoryName

Set the DataType factory to add support for non-standard database vendor data types.

  • Type: java.lang.String
  • Required: No
  • Expression: ${dataTypeFactoryName}
  • Default: org.dbunit.dataset.datatype.DefaultDataTypeFactory

datatypeWarning Enable or disable the warning message displayed when DbUnit encounter an unsupported data type.
  • Type: boolean
  • Required: No
  • Expression: ${datatypeWarning}
  • Default: false

driver The class name of the JDBC driver to be used.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${driver}

escapePattern escapePattern
  • Type: java.lang.String
  • Required: No
  • Expression: ${escapePattern}

format DataSet file format
  • Type: java.lang.String
  • Required: No
  • Expression: ${format}
  • Default: xml

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

queries List of DbUnit's Query. See DbUnit's org.dbunit.ant.Query JavaDoc for details
  • Type: org.dbunit.ant.Query[]
  • Required: No

schema The schema name that tables can be found under.
  • Type: java.lang.String
  • Required: No
  • Expression: ${schema}

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

skip Skip the execution when true, very handy when using together with maven.test.skip.
  • Type: boolean
  • Required: No
  • Expression: ${skip}
  • Default: false

sort sort
  • Type: boolean
  • Required: No
  • Expression: ${sort}

src DataSet file
  • Type: java.io.File
  • Required: Yes
  • Expression: ${src}

supportBatchStatement Enable or disable usage of JDBC batched statement by DbUnit
  • Type: boolean
  • Required: No
  • Expression: ${supportBatchStatement}
  • Default: false

tables List of DbUnit's Table. See DbUnit's org.dbunit.ant.Table JavaDoc for details
  • Type: org.dbunit.ant.Table[]
  • Required: No

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

useQualifiedTableNames Enable or disable multiple schemas support by prefixing table names with the schema name.
  • Type: boolean
  • Required: No
  • Expression: ${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
  • Required: No
  • Expression: ${username}