The LiquibaseDbDocTask
generates a Javadoc-like documentation based on
current database and the given changelog file.
Table C.35: Attributes
Name | Type | Description | Default | Required |
---|---|---|---|---|
jar | String | Location of the Liquibase jar file. | n/a | Yes |
classpath | String | Additional classpath entries. | n/a | Yes |
changeLogFile | String | Location of the changelog file in which the changes get written or read from. | n/a | Yes |
username | String | The username needed to connect to the database. | n/a | Yes |
password | String | The password needed to connect to the database. | n/a | Yes |
url | String | The JDBC URL representing the database data source, e.g jdbc:mysql://localhost/mydatabase | n/a | Yes |
outputDir | String | Absolute path where the documentation gets written to. If the given directory does not exist, it get`s created automatically. | n/a | Yes |
<liquibase-dbdoc jar="/usr/local/lib/liquibase/liquibase.jar" classpathref="/usr/local/lib/liquibase/lib/mysql-connector-java-5.1.15-bin.jar" changelogFile="./changelogTest.xml" username="liquibase" password="liquibase" url="jdbc:mysql://localhost/mydatabase" outputDir="/tmp/generateddocs" />