Maven dbDoc

Uses

The dbDoc The goal 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 file's syntax, see Maven Properties.

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 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.

Maven dbDoc output

When successful, the dbDoc Maven goal produces the following output:

[INFO] Scanning for projects... [INFO] [INFO] ------------------------------------------------------------------------ [INFO] Building liquibase-app 1.0-SNAPSHOT [INFO] ------------------------------------------------------------------------ [INFO] [INFO] --- liquibase-commercial-maven-plugin:3.9.0:dbDoc (default-cli) @ liquibase-app --- [INFO] ------------------------------------------------------------------------ [INFO] Parsing Liquibase Properties File [INFO] File: liquibase.properties [INFO] 'referencePassword' in properties file is not being used by this task. [INFO] 'referenceUrl' in properties file is not being used by this task. [INFO] 'referenceUsername' in properties file is not being used by this task. [INFO] ------------------------------------------------------------------------ [INFO] [INFO] [INFO] Liquibase Community 3.9.0 by Liquibase [INFO] Starting Liquibase at Thu, 09 Jul 2020 07:57:01 CDT (version 3.9.0 #11 built at Thu May 14 04:03:56 UTC 2020) [INFO] Parsing Liquibase Properties File liquibase.properties for changeLog parameters [INFO] Executing on Database: jdbc:oracle:thin:@//win-20e107kb4tn:1521/ORCL [INFO] Generating Database Documentation [INFO] SELECT COUNT(*) FROM DATABASECHANGELOGLOCK [INFO] SELECT COUNT(*) FROM DATABASECHANGELOGLOCK [INFO] SELECT LOCKED FROM DATABASECHANGELOGLOCK WHERE ID=1 FOR UPDATE [INFO] Successfully acquired change log lock [INFO] SELECT MD5SUM FROM DATABASECHANGELOG WHERE MD5SUM IS NOT NULL AND ROWNUM=1 [INFO] SELECT COUNT(*) FROM DATABASECHANGELOG [INFO] Reading from DATABASECHANGELOG [INFO] SELECT * FROM DATABASECHANGELOG ORDER BY DATEEXECUTED ASC, ORDEREXECUTED ASC [INFO] SELECT sequence_name, CASE WHEN increment_by > 0 THEN CASE WHEN min_value=1 THEN NULL ELSE min_value END ELSE CASE WHEN min_value=(-999999999999999999999999999) THEN NULL else min_value END END AS min_value, CASE WHEN increment_by > 0 THEN CASE WHEN max_value=999999999999999999999999999 THEN NULL ELSE max_value END ELSE CASE WHEN max_value=last_number THEN NULL else max_value END END AS max_value, CASE WHEN increment_by = 1 THEN NULL ELSE increment_by END AS increment_by, CASE WHEN cycle_flag = 'N' THEN NULL ELSE cycle_flag END AS will_cycle, CASE WHEN order_flag = 'N' THEN NULL ELSE order_flag END AS is_ordered, LAST_NUMBER as START_VALUE, CASE WHEN cache_size = 20 THEN NULL ELSE cache_size END AS cache_size FROM ALL_SEQUENCES WHERE SEQUENCE_OWNER = 'GAMBITCARD_DEV' [INFO] select ucc.owner as constraint_container, ucc.constraint_name as constraint_name, ucc.column_name, f.validated as constraint_validate from all_cons_columns ucc INNER JOIN al l_constraints f ON ucc.owner = f.owner AND ucc.constraint_name = f.constraint_name where ucc.constraint_name='AK_EXEMPLAR_PPD' and ucc.owner='GAMBITCARD_DEV' and ucc.table_name not like 'BIN$%' order by ucc.position [INFO] select ucc.owner as constraint_container, ucc.constraint_name as constraint_name, ucc.column_name, f.validated as constraint_validate from all_cons_columns ucc INNER JOIN al l_constraints f ON ucc.owner = f.owner AND ucc.constraint_name = f.constraint_name where ucc.constraint_name='AK_TITLE_DIRECTOR' and ucc.owner='GAMBITCARD_DEV' and ucc.table_name n ot like 'BIN$%' order by ucc.position [INFO] Table person created [INFO] ChangeSet changelog.xml::1::MikeOlivas ran successfully in 6ms [INFO] Table company created [INFO] ChangeSet changelog.xml::2::MikeOlivas ran successfully in 2ms [INFO] Columns country(varchar(2)) added to person [INFO] ChangeSet changelog.xml::3::MikeOlivas ran successfully in 1ms [INFO] Successfully released change log lock [INFO] ------------------------------------------------------------------------ [INFO] [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 15.066 s [INFO] Finished at: 2020-07-09T07:57:14-05:00 [INFO] Final Memory: 23M/453M [INFO] ------------------------------------------------------------------------