Generates dbdoc database documentation for a given database.
<target name="update-database" depends="prepare"> <fail unless="db.changelog.file">db.changelog.file not set</fail> <fail unless="database.url">database.url not set</fail> <fail unless="database.username">database.username not set</fail> <fail unless="database.password">database.password not set</fail> <taskdef resource="liquibasetasks.properties"> <classpath refid="classpath"/> </taskdef> <dbDoc changeLogFile="${db.changelog.file}" driver="${database.driver}" url="${database.url}" username="${database.username}" password="${database.password}" outputDirectory="/path/to/doc/root/directory" classpathref="classpath" > </dbDoc> </target>
| changeLogFile | The change log file to run [required] |
|---|---|
| driver | The name of the database driver to connect with |
| url | The database URL [required] |
| username | The database username to connect with [required] |
| password | The password to use when connecting to the database [required] |
| defaultSchemaName | Schema to use by default for managed database objects and LiquiBase control tables |
| outputDirectory | Directory to save report in [required] |
| classpathref | A reference to the classpath that contains the database driver, liquibase.jar, and the changelog.xml file [required] |
| changeLogProperty | Sets a changelog parameters set Since LiquiBase 1.7 |
|---|
| name | The name of the property to set |
|---|---|
| value | The value of the property to set |