`db-doc`

The db-doc command generates documentation in a Javadoc format based on the existing database and changelogs.

Uses

The db-doc command 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.

Note: See the changelogDocs.zip file for an example of the database documentation structure with the related directories and files.

Syntax

To run the db-doc command, specify the driver, classpath, and URL in your Liquibase properties file. For more information, see Create and Configure a liquibase.properties File. You can also specify these properties from the command line.

Then run the db-doc command:

liquibase db-doc --output-directory=exampleDirectory --changelog-file=example-changelog.xml

Note: The --output-directory=exampleDirectory syntax was added in Liquibase 4.4. If you use an older version, specify your output directory as a positional argument: <command> exampleDirectory. It is best practice to specify a new empty directory because the db-doc command creates its own directories, the CSS file, and multiple HTML files.

Command parameters

Attribute	Definition	Requirement
`--changelog-file=<string>`	The root changelog	Required
`--output-directory=<string>`	The directory where the database documentation is generated. Specify as `--output-directory=exampleDirectory`. Positional format `<command> <directory>` deprecated in 4.4+.	Required
`--url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`--context-filter=<string>`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`--default-catalog-name=<string>`	Name of the default catalog to use for the database connection	Optional
`--default-schema-name=<string>`	Name of the default schema to use for the database connection. If `defaultSchemaName` is set, then objects do not have to be fully qualified. This means you can refer to just `mytable` instead of `myschema.mytable`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`--driver=<string>`	The JDBC driver class	Optional
`--driver-properties-file=<string>`	The JDBC driver properties file	Optional
`--label-filter=<string>`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	Optional
`--password=<string>`	Password to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional
`--schemas=<string>`	Database schemas to include objects from in reporting	Optional
`--username=<string>`	Username to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional

Attribute	Definition	Requirement
`cmdArgs: { changelog-file: "<string>" }`	The root changelog	Required
`cmdArgs: { output-directory: "<string>" }`	The directory where the database documentation is generated. Specify as `--output-directory=exampleDirectory`. Positional format `<command> <directory>` deprecated in 4.4+.	Required
`cmdArgs: { url: "<string>" }`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`cmdArgs: { context-filter: "<string>" }`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`cmdArgs: { default-catalog-name: "<string>" }`	Name of the default catalog to use for the database connection	Optional
`cmdArgs: { default-schema-name: "<string>" }`	Name of the default schema to use for the database connection. If `defaultSchemaName` is set, then objects do not have to be fully qualified. This means you can refer to just `mytable` instead of `myschema.mytable`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`cmdArgs: { driver: "<string>" }`	The JDBC driver class	Optional
`cmdArgs: { driver-properties-file: "<string>" }`	The JDBC driver properties file	Optional
`cmdArgs: { label-filter: "<string>" }`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	Optional
`cmdArgs: { password: "<string>" }`	Password to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional
`cmdArgs: { schemas: "<string>" }`	Database schemas to include objects from in reporting	Optional
`cmdArgs: { username: "<string>" }`	Username to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional

Attribute	Definition	Requirement
`liquibase.command.changelogFile: <string>` `liquibase.command.dbDoc.changelogFile: <string>`	The root changelog	Required
`liquibase.command.outputDirectory: <string>` `liquibase.command.dbDoc.outputDirectory: <string>`	The directory where the database documentation is generated. Specify as `--output-directory=exampleDirectory`. Positional format `<command> <directory>` deprecated in 4.4+.	Required
`liquibase.command.url: <string>` `liquibase.command.dbDoc.url: <string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`liquibase.command.contextFilter: <string>` `liquibase.command.dbDoc.contextFilter: <string>`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`liquibase.command.defaultCatalogName: <string>` `liquibase.command.dbDoc.defaultCatalogName: <string>`	Name of the default catalog to use for the database connection	Optional
`liquibase.command.defaultSchemaName: <string>` `liquibase.command.dbDoc.defaultSchemaName: <string>`	Name of the default schema to use for the database connection. If `defaultSchemaName` is set, then objects do not have to be fully qualified. This means you can refer to just `mytable` instead of `myschema.mytable`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`liquibase.command.driver: <string>` `liquibase.command.dbDoc.driver: <string>`	The JDBC driver class	Optional
`liquibase.command.driverPropertiesFile: <string>` `liquibase.command.dbDoc.driverPropertiesFile: <string>`	The JDBC driver properties file	Optional
`liquibase.command.labelFilter: <string>` `liquibase.command.dbDoc.labelFilter: <string>`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	Optional
`liquibase.command.password: <string>` `liquibase.command.dbDoc.password: <string>`	Password to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional
`liquibase.command.schemas: <string>` `liquibase.command.dbDoc.schemas: <string>`	Database schemas to include objects from in reporting	Optional
`liquibase.command.username: <string>` `liquibase.command.dbDoc.username: <string>`	Username to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional

Attribute	Definition	Requirement
`JAVA_OPTS=-Dliquibase.command.changelogFile=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.changelogFile=<string>`	The root changelog	Required
`JAVA_OPTS=-Dliquibase.command.outputDirectory=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.outputDirectory=<string>`	The directory where the database documentation is generated. Specify as `--output-directory=exampleDirectory`. Positional format `<command> <directory>` deprecated in 4.4+.	Required
`JAVA_OPTS=-Dliquibase.command.url=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`JAVA_OPTS=-Dliquibase.command.contextFilter=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.contextFilter=<string>`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`JAVA_OPTS=-Dliquibase.command.defaultCatalogName=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.defaultCatalogName=<string>`	Name of the default catalog to use for the database connection	Optional
`JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.defaultSchemaName=<string>`	Name of the default schema to use for the database connection. If `defaultSchemaName` is set, then objects do not have to be fully qualified. This means you can refer to just `mytable` instead of `myschema.mytable`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`JAVA_OPTS=-Dliquibase.command.driver=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.driver=<string>`	The JDBC driver class	Optional
`JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.driverPropertiesFile=<string>`	The JDBC driver properties file	Optional
`JAVA_OPTS=-Dliquibase.command.labelFilter=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.labelFilter=<string>`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	Optional
`JAVA_OPTS=-Dliquibase.command.password=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.password=<string>`	Password to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional
`JAVA_OPTS=-Dliquibase.command.schemas=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.schemas=<string>`	Database schemas to include objects from in reporting	Optional
`JAVA_OPTS=-Dliquibase.command.username=<string>` `JAVA_OPTS=-Dliquibase.command.dbDoc.username=<string>`	Username to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional

Attribute	Definition	Requirement
`LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>` `LIQUIBASE_COMMAND_DB_DOC_CHANGELOG_FILE=<string>`	The root changelog	Required
`LIQUIBASE_COMMAND_OUTPUT_DIRECTORY=<string>` `LIQUIBASE_COMMAND_DB_DOC_OUTPUT_DIRECTORY=<string>`	The directory where the database documentation is generated. Specify as `--output-directory=exampleDirectory`. Positional format `<command> <directory>` deprecated in 4.4+.	Required
`LIQUIBASE_COMMAND_URL=<string>` `LIQUIBASE_COMMAND_DB_DOC_URL=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`LIQUIBASE_COMMAND_CONTEXT_FILTER=<string>` `LIQUIBASE_COMMAND_DB_DOC_CONTEXT_FILTER=<string>`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>` `LIQUIBASE_COMMAND_DB_DOC_DEFAULT_CATALOG_NAME=<string>`	Name of the default catalog to use for the database connection	Optional
`LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>` `LIQUIBASE_COMMAND_DB_DOC_DEFAULT_SCHEMA_NAME=<string>`	Name of the default schema to use for the database connection. If `defaultSchemaName` is set, then objects do not have to be fully qualified. This means you can refer to just `mytable` instead of `myschema.mytable`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`LIQUIBASE_COMMAND_DRIVER=<string>` `LIQUIBASE_COMMAND_DB_DOC_DRIVER=<string>`	The JDBC driver class	Optional
`LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_DB_DOC_DRIVER_PROPERTIES_FILE=<string>`	The JDBC driver properties file	Optional
`LIQUIBASE_COMMAND_LABEL_FILTER=<string>` `LIQUIBASE_COMMAND_DB_DOC_LABEL_FILTER=<string>`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	Optional
`LIQUIBASE_COMMAND_PASSWORD=<string>` `LIQUIBASE_COMMAND_DB_DOC_PASSWORD=<string>`	Password to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional
`LIQUIBASE_COMMAND_SCHEMAS=<string>` `LIQUIBASE_COMMAND_DB_DOC_SCHEMAS=<string>`	Database schemas to include objects from in reporting	Optional
`LIQUIBASE_COMMAND_USERNAME=<string>` `LIQUIBASE_COMMAND_DB_DOC_USERNAME=<string>`	Username to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.	Optional

Note: The username and password attributes are not required for connections and systems which use alternate means of authentication. Also, you can specify database credentials as part of the url attribute.

Output

Liquibase command 'db-doc' was executed successfully.