Ant Task

DB Toolbox can be called from Ant build files.

<taskdef name="dbtoolbox" classname="org.dbtoolbox.ant.DBToolboxTask">
    <classpath>
        <fileset dir="lib" includes="*.jar"/>
        <path location="/usr/share/java/mysql-connector-java-5.1.6.jar"/>
    </classpath>
</taskdef>
<dbtoolbox>
    <connection
        driverClassName="com.mysql.jdbc.Driver"
        url="jdbc:mysql://localhost:3306/test"
        username="test"
        password="test"/>
    <extractor />
    <validator configFile="etc/validator.xml"/>
    <generator name="html" outputFolder="dbdoc"/>
</dbtoolbox>

Connection configuration

factory Connection type, either driver for JDBC driver or jndi for JNDI registered datasource.
Default: driver
url JDBC database URL or JNDI registry URL
username Login
password Password
driverclassname JDBC Driver class name
Applies only: jdbc
jndiName Name of the datasource in the JNDI registry
Applies only: jndi
jndiPropertiesFile Location of a jndi.properties configuration file
Applies only: jndi

Extractor configuration

type Database product type, either hsqldb, mysql,postgres, derby or oracle
Default: Automatically detected database product type and if unknown use generic one.
catalogName Name of the catalog to extract
Applies only: mysql

Validator configuration

configFile Validator configuration file location
configFormat Validator configuration file format, either xml or properties
Default: Automatically detected from extension

Generator configuration

name Generator name, either html for HTML website, text for plain text document or xml for XML document.
Default: html
outputFolder Output folder
Applies only: html and xml
outputFile Output file
Applies only: text