Generating database documentation

Using change information stored in the changelogs and an existing database, Liquibase can generate database change documentation.

Running DBDoc

The dbDoc command support is currently available through the command line only.

Example

liquibase.sh --driver=oracle.jdbc.OracleDriver \
	--url=jdbc:oracle:thin:@testdb:1521:test \
	--username=bob \
	--password=bob \
	--changeLogFile=path/to/changelog.xml
dbDoc \
	/docs/dbdoc

Sample output

The documentation output is based on a JavaDoc style documentation. The report of changes from our sample changelog is available here.