Maven dbDoc

dbDoc generates documentation based on the existing database and changelogs.

Uses

dbDoc is typically used to generate database documentation with the change information stored in the changelogs and the existing database. It captures the current state of your database including everything that has been performed against it. The image below shows an example of the database documentation structure with the related directories and files.

Maven configuration

You can configure Liquibase Maven in multiple ways. You can pass arguments like <changeLogFile> in Maven directly in your pom.xml file, in a liquibase.properties file referenced in your POM, as environment variables, or as JVM system properties. To learn about each files syntax, see Maven Properties

Tip: For more information about the Maven configuration, see Configuring Maven.

Running the dbDoc Maven goal

Running the dbDoc goal requires a Maven project to be implemented.

To run the goal, type the following in your command prompt:

mvn liquibase:dbDoc -Dliquibase.outputDirectory=target/docs

Note: By default, the dbDoc Maven goal puts the generated documentation in the target/liquibase/dbDoc directory. To change it, enter the name of the output directory that you want to use in place of target/doc.

dbDoc optional Maven configuration attributes

Attribute Definition
liquibase.changeLogDirectory

Specifies the path to the directory where Liquibase can find your changelog file.
liquibase.changeLogFile

The changelog file for Liquibase to use.
liquibase.changelogCatalogName

Specifies the catalog Liquibase will use to create your changelog tables.
liquibase.changelogSchemaName

Specifies the schema Liquibase will use to create your changelog tables.
liquibase.clearCheckSums

Boolean. Forces checksums to be cleared from the DATABASECHANGELOG table. Default value is: false.
liquibase.contexts

Specifies which contexts Liquibase will execute, which can be separated by a comma if multiple contexts are required. If a context is not specified, then all contexts will be executed.
liquibase.databaseChangeLogLockTableName

Specifies the table name to use for the DATABASECHANGELOGLOCK table.
liquibase.databaseChangeLogTableName

Specifies the table name to use for the DATABASECHANGELOG table.
liquibase.databaseClass

Specifies the database object class.
liquibase.defaultCatalogName

Specifies the default catalog name to use for the database connection.
liquibase.defaultSchemaName

Specifies the default schema name to use for the database connection.
liquibase.driver

Specifies the driver class name to use for the database connection.
driverPropertiesFile

Specifies the location of a JDBC connection properties file which contains properties the driver will use.
liquibase.emptyPassword

Deprecated. Boolean. Use an empty or null value for the password instead. Default value is: false.
expressionVariables

Specifies a map-based collection of changelog properties to apply.
expressionVars

Specifies a property-based collection of changelog properties to apply.
liquibase.includeArtifact

Boolean. Includes a Maven project artifact in the class loader, which obtains the Liquibase properties file and changelog files. Default value is true.
liquibase.includeTestOutputDirectory

Boolean. Includes the Maven test output directory in the class loader which obtains the Liquibase properties file and changelog files. Default value is true.
liquibase.labels

Specifies which labels Liquibase runs, and which can be separated by a comma if multiple labels are required or you need to designate a more complex expression. If no label is specified, then all labels are run.
liquibase.licenseKey

Specifies your Liquibase Pro license key.
liquibase.outputDefaultCatalog

Boolean. Specifies whether to ignore the catalog or database name. Default value is: false.
liquibase.outputDefaultSchema

Boolean. Specifies whether to ignore the schema name. Default value is: false.
liquibase.outputFileEncoding

Indicates that you want to set the character encoding of the output file during the updateSQL phase.
liquibase.password

Specifies the database password for the database connection.
liquibase.promptOnNonLocalDatabase

Deprecated. Boolean. Controls whether users are prompted before executing changesets to a non-local database. Default value is: true.
liquibase.propertyFile

Specifies the Liquibase properties file to use for configuration, like liquibase.properties.
liquibase.propertyFileWillOverride

Boolean. Indicates that you want the liquibase.properties file to override any settings provided in the Maven plugin configuration. By default, if a property is explicitly specified, it is not overridden if it also appears in the properties file. Default value is: false.
liquibase.propertyProviderClass

Specifies the property provider, which must be a java.util.Properties implementation.
liquibase.server

Specifies the server ID in the Maven settings.xml to use when authenticating.
liquibase.skip

Boolean. Specifies whether to skip running Liquibase. The use of this attribute is not recommended but can be used when needed. Default value is: false.
systemProperties

Specifies a list of system properties you want to pass to the database.
liquibase.url

Specifies the database URL you want to use to execute Liquibase.
liquibase.username

Specifies the database username for the database connection.
liquibase.verbose

Boolean. Controls the amount of output detail when you call the plugin. Default value is: false.