Maven dbDoc

liquibase:dbDoc

Full name:

org.liquibase:liquibase-maven-plugin:3.8.3:dbDoc

Description:

Generates dbDocs against the database.

Attributes:

Requires a Maven 2.0 project to be executed.
Requires dependency resolution of artifacts in scope: test.

Optional Parameters

Name	Type	Since	Description
liquibase.changeLogDirectory	String	-	Specifies the change log directory into which liquibase can find the change log file.
liquibase.changeLogFile	String	-	Specifies the change log file to use for Liquibase.
liquibase.changelogCatalogName	String	-	Schema against which Liquibase changelog tables will be created.
liquibase.changelogSchemaName	String	-	Schema against which Liquibase changelog tables will be created.
liquibase.clearCheckSums	boolean	-	Flag for forcing the checksums to be cleared from the DatabaseChangeLog table. Default value is: false.
liquibase.contexts	String	-	The Liquibase contexts to execute, which can be "," separated if multiple contexts are required. If no context is specified then ALL contexts will be executed.
liquibase.databaseChangeLogLockTableName	String	-	Table name to use for the databasechangelog.
liquibase.databaseChangeLogTableName	String	-	Table name to use for the databasechangelog.
liquibase.databaseClass	String	-	The class to use as the database object.
liquibase.defaultCatalogName	String	-	The default catalog name to use the for database connection.
liquibase.defaultSchemaName	String	-	The default schema name to use the for database connection.
liquibase.driver	String	-	The fully qualified name of the driver class to use to connect to the database.
driverPropertiesFile	File	-	Location of a properties file containing JDBC connection properties for use by the driver.
liquibase.emptyPassword	boolean	-	Deprecated. Use an empty or null value for the password instead. Default value is: false.
expressionVariables	Map	-	Array to put a expression variable to maven plugin.
expressionVars	Properties	-	Array to put a expression variable to maven plugin.
liquibase.includeArtifact	boolean	-	Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files. Default value is: true.
liquibase.includeTestOutputDirectory	boolean	-	Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files. Default value is: true.
liquibase.labels	String	-	The Liquibase labels to execute, which can be "," separated if multiple labels are required or a more complex expression. If no label is specified then ALL all will be executed.
liquibase.liquibaseProLicenseKey	String	-	Liquibase PRO license key value
liquibase.logging	String	-	Controls the level of logging from Liquibase when executing. The value can be "debug", "info", "warning", "severe", or "off". The value is case insensitive. Default value is: INFO.
liquibase.outputDefaultCatalog	boolean	-	Whether to ignore the catalog/database name.
liquibase.outputDefaultSchema	boolean	-	Whether to ignore the schema name.
liquibase.outputDirectory	String	-	(no description) Default value is: ${project.build.directory}/liquibase/dbDoc.
liquibase.outputFileEncoding	String	-	Flag to set the character encoding of the output file produced by Liquibase during the updateSQL phase.
liquibase.password	String	-	The database password to use to connect to the specified database.
liquibase.promptOnNonLocalDatabase	boolean	-	Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on. Default value is: true.
liquibase.propertyFile	String	-	The Liquibase properties file used to configure the Liquibase Liquibase.
liquibase.propertyFileWillOverride	boolean	-	Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration. By default if a property is explicity specified it is not overridden if it also appears in the properties file. Default value is: false.
liquibase.propertyProviderClass	String	-	The class to use as the property provider (must be a java.util.Properties implementation).
liquibase.server	String	-	The server id in settings.xml to use when authenticating with.
liquibase.skip	boolean	-	Set this to 'true' to skip running liquibase. Its use is NOT RECOMMENDED, but quite convenient on occasion. Default value is: false.
systemProperties	Properties	-	List of system properties to pass to the database.
liquibase.url	String	-	The Database URL to connect to for executing Liquibase.
liquibase.username	String	-	The database username to use to connect to the specified database.
liquibase.verbose	boolean	-	Controls the verbosity of the output from invoking the plugin. Default value is: false.

Parameter Details

liquibase.changeLogDirectory:

Specifies the change log directory into which liquibase can find the change log file.

Type: java.lang.String
Required: No

liquibase.changeLogFile:

Specifies the change log file to use for Liquibase.

Type: java.lang.String
Required: No

liquibase.changelogCatalogName:

Schema against which Liquibase changelog tables will be created.

Type: java.lang.String
Required: No

liquibase.changelogSchemaName:

Schema against which Liquibase changelog tables will be created.

Type: java.lang.String
Required: No

liquibase.clearCheckSums:

Flag for forcing the checksums to be cleared from the DatabaseChangeLog table.

Type: boolean
Required: No
Default: false

liquibase.contexts:

The Liquibase contexts to execute, which can be "," separated if multiple contexts are required. If no context is specified then ALL contexts will be executed.

Type: java.lang.String
Required: No

liquibase.databaseChangeLogLockTableName:

Table name to use for the databasechangelog.

Type: java.lang.String
Required: No

liquibase.databaseChangeLogTableName:

Table name to use for the databasechangelog.

Type: java.lang.String
Required: No

liquibase.databaseClass:

The class to use as the database object.

Type: java.lang.String
Required: No

liquibase.defaultCatalogName:

The default catalog name to use the for database connection.

Type: java.lang.String
Required: No

liquibase.defaultSchemaName:

The default schema name to use the for database connection.

Type: java.lang.String
Required: No

liquibase.driver:

The fully qualified name of the driver class to use to connect to the database.

Type: java.lang.String
Required: No

driverPropertiesFile:

Location of a properties file containing JDBC connection properties for use by the driver.

Type: java.io.File
Required: No

liquibase.emptyPassword:

Deprecated. Use an empty or null value for the password instead.

Use an empty string as the password for the database connection. This should not be used along side the password setting.

Type: boolean
Required: No
Default: false

expressionVariables:

Array to put a expression variable to maven plugin.

Type: java.util.Map
Required: No

expressionVars:

Array to put a expression variable to maven plugin.

Type: java.util.Properties
Required: No

liquibase.includeArtifact:

Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.

Type: boolean
Required: No
Default: true

liquibase.includeTestOutputDirectory:

Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.

Type: boolean
Required: No
Default: true

liquibase.labels:

The Liquibase labels to execute, which can be "," separated if multiple labels are required or a more complex expression. If no label is specified then ALL all will be executed.

Type: java.lang.String
Required: No

liquibase.liquibaseProLicenseKey:

Liquibase PRO license key value

Type: java.lang.String
Required: No

liquibase.logging:

Controls the level of logging from Liquibase when executing. The value can be "debug", "info", "warning", "severe", or "off". The value is case insensitive.

Type: java.lang.String
Required: No
Default: INFO

liquibase.outputDefaultCatalog:

Whether to ignore the catalog/database name.

Type: boolean
Required: No

liquibase.outputDefaultSchema:

Whether to ignore the schema name.

Type: boolean
Required: No

liquibase.outputDirectory:

(no description)

Type: java.lang.String
Required: No
Default: ${project.build.directory}/liquibase/dbDoc

liquibase.outputFileEncoding:

Flag to set the character encoding of the output file produced by Liquibase during the updateSQL phase.

Type: java.lang.String
Required: No

liquibase.password:

The database password to use to connect to the specified database.

Type: java.lang.String
Required: No

liquibase.promptOnNonLocalDatabase:

Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on.

Type: boolean
Required: No
Default: true

liquibase.propertyFile:

The Liquibase properties file used to configure the Liquibase Liquibase.

Type: java.lang.String
Required: No

liquibase.propertyFileWillOverride:

Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration. By default if a property is explicity specified it is not overridden if it also appears in the properties file.

Type: boolean
Required: No
Default: false

liquibase.propertyProviderClass:

The class to use as the property provider (must be a java.util.Properties implementation).