dbtoolbox:validator-report

Note:This goal should be used as a Maven report.

Full name:

net.sourceforge.dbtoolbox:dbtoolbox-maven-plugin:1.0-SNAPSHOT:validator-report

Description:

Goal which generates database documentation report.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: site.

Required Parameters

Name Type Since Description
outputName String - The filename to use for the report.
Default value is: dbvalid.
reportOutputDirectory File - Report output directory

Optional Parameters

Name Type Since Description
connectionFactory String - Connection factory name, either "driver" or "jndi". Defaults to "driver"
Default value is: driver.
driverClassName String - Fully qualified class name of the JDBC driver. Applies on "driver" only.
driverClassPath String - Class path containing the JDBC driver. Applies on "driver" only.
jndiName String - JNDI path or name, location in the JNDI registry. Applies on "jndi" only.
jndiPropertiesFile File - JNDI Properties file location. Applies on "jndi" only.
password String - Password. Applies on "driver" and "jndi"
url String - JDBC URL or JNDI server URL Applies on "driver" and "jndi"
username String - Login/user name. Applies on "driver" and "jndi"
validatorPropertiesFile File - Properties file used for validation. null means no validation

Parameter Details

connectionFactory:

Connection factory name, either "driver" or "jndi". Defaults to "driver"
  • Type: java.lang.String
  • Required: No
  • Default: driver

driverClassName:

Fully qualified class name of the JDBC driver. Applies on "driver" only.
  • Type: java.lang.String
  • Required: No

driverClassPath:

Class path containing the JDBC driver. Applies on "driver" only.
  • Type: java.lang.String
  • Required: No

jndiName:

JNDI path or name, location in the JNDI registry. Applies on "jndi" only.
  • Type: java.lang.String
  • Required: No

jndiPropertiesFile:

JNDI Properties file location. Applies on "jndi" only.
  • Type: java.io.File
  • Required: No

outputName:

The filename to use for the report.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${outputName}
  • Default: dbvalid

password:

Password. Applies on "driver" and "jndi"
  • Type: java.lang.String
  • Required: No

reportOutputDirectory:

Report output directory
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}

url:

JDBC URL or JNDI server URL Applies on "driver" and "jndi"
  • Type: java.lang.String
  • Required: No

username:

Login/user name. Applies on "driver" and "jndi"
  • Type: java.lang.String
  • Required: No

validatorPropertiesFile:

Properties file used for validation. null means no validation
  • Type: java.io.File
  • Required: No