Maven dbDoc

Description

dbDoc generates documentation in a Javadoc format 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

Liquibase Maven can be configured multiple ways. One way is to define your Liquibase configuration properties in your pom.xml file. You can also indicate the location of your liquibase.properties file using the following syntax:

<liquibase.propertyFile>path/to/properties_file</liquibase.propertyFile>

Note: Replace path/to/properties_file with the location of your default properties file. See the example below.

Example: <liquibase.propertyFile>${project.basedir}/local.liquibase.properties</liquibase.propertyFile>

Note: Multiple profiles can be created in the pom.xml which contain different Liquibase properties. See the example below.

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: The outputDirectory is typically located in the place where you store your pom.xml file which is in the root of the Maven project. So, if you specify your output directory as target/docs, the command will put the files in the projectname\target\docs directory. Enter the name of the output directory that you want to use in place of target/doc.

dbDoc Optional Maven Configuration Properties

Property Definition
liquibase.changeLogDirectory Specifies the path to your Liquibase changelog folder.
liquibase.changeLogFile Specifies 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] A flag that 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 [boolean] Deprecated. Use an empty or null value for the password instead. Default value is: false.
expressionVariables A map-based collection of changelog properties to apply.
expressionVars 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 will execute, which can be separated by a comma if multiple labels are required or you need to designate a more complex expression. If a label is not specified, then ALL labels will be executed.
liquibase.liquibaseProLicenseKey Specifies your Liquibase Pro license key.
liquibase.logging Controls the amount of logging detail Liquibase outputs when executing. The values can be "DEBUG", "INFO", "WARNING", "SEVERE", or "OFF". The value is not case sensitive. Default value is: INFO.
liquibase.outputDefaultCatalog [boolean] Specifies whether to ignore the catalog/database name. Default value is: false.
liquibase.outputDefaultSchema [boolean] Specifies whether to ignore the schema name. Default value is: false.
liquibase.outputFileEncoding A flag which indicates you want to set the character encoding of the output file during the updateSQL phase.
liquibase.password Specifies the database password for database connection.
liquibase.promptOnNonLocalDatabase [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 you want to use to configure Liquibase.
liquibase.propertyFileWillOverride [boolean] A flag which indicates 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 parameter 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 database connection.
liquibase.verbose [boolean] Controls the amount of output detail when you call the plugin. Default value is: false.