Optional Parameters

Name	Type	Since	Description
changeLogFile	String	-	Specifies the change log file to use for Liquibase.
clearCheckSums	boolean	-	Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table. Default value is: false.
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.
databaseClass	String	-	The class to use as the database object.
defaultSchemaName	String	-	The default schema name to use the for database connection.
diffChangeLogFile	String	-	The diff change log file to output the differences to. If this is null then the differences will be output to the screen.
driver	String	-	The fully qualified name of the driver class to use to connect to the database.
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.
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.
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.
logging	String	-	Controls the level of logging from Liquibase when executing. The value can be "all", "finest", "finer", "fine", "info", "warning", "severe" or "off". The value is case insensitive. Default value is: INFO.
password	String	-	The database password to use to connect to the specified database.
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.
propertyFile	String	-	The Liquibase properties file used to configure the 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.
referenceDefaultSchemaName	String	-	The reference database password to use to connect to the specified database. If this is null then an empty password will be used.
referenceDriver	String	-	The fully qualified name of the driver class to use to connect to the reference database. If this is not specified, then the driver will be used instead.
referencePassword	String	-	The reference database password to use to connect to the specified database. If this is null then an empty password will be used.
referenceServer	String	-	The server id in settings.xml to use when authenticating with.
referenceUrl	String	-	The reference database URL to connect to for executing Liquibase. If performing a diff against a Hibernate config xml file, then use "hibernate:PATH_TO_CONFIG_XML" as the URL. The path to the hibernate configuration file can be relative to the test classpath for the Maven project.
referenceUsername	String	-	The reference database username to use to connect to the specified database.
server	String	-	The server id in settings.xml to use when authenticating with.
skip	boolean	-	Set this to 'true' to skip running liquibase. Its use is NOT RECOMMENDED, but quite convenient on occasion.
systemProperties	Properties	-	List of system properties to pass to the database.
url	String	-	The Database URL to connect to for executing Liquibase.
username	String	-	The database username to use to connect to the specified database.
verbose	boolean	-	Controls the verbosity of the output from invoking the plugin. Default value is: false.

Parameter Details

changeLogFile:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.changeLogFile}

---

clearCheckSums:

• Type: boolean
• Required: No
• Expression: ${liquibase.clearCheckSums}
• Default: false

---

contexts:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.contexts}

---

databaseClass:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.databaseClass}

---

defaultSchemaName:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.defaultSchemaName}

---

diffChangeLogFile:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.diffChangeLogFile}

---

driver:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.driver}

---

emptyPassword:

• Type: boolean
• Required: No
• Expression: ${liquibase.emptyPassword}
• Default: false

---

expressionVariables:

• Type: java.util.Map
• Required: No

---

expressionVars:

• Type: java.util.Properties
• Required: No

---

includeArtifact:

• Type: boolean
• Required: No
• Expression: ${liquibase.includeArtifact}
• Default: true

---

includeTestOutputDirectory:

• Type: boolean
• Required: No
• Expression: ${liquibase.includeTestOutputDirectory}
• Default: true

---

logging:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.logging}
• Default: INFO

---

password:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.password}

---

promptOnNonLocalDatabase:

• Type: boolean
• Required: No
• Expression: ${liquibase.promptOnNonLocalDatabase}
• Default: true

---

propertyFile:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.propertyFile}

---

propertyFileWillOverride:

• Type: boolean
• Required: No
• Expression: ${liquibase.propertyFileWillOverride}
• Default: false

---

referenceDefaultSchemaName:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.referenceDefaultSchemaName}

---

referenceDriver:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.referenceDriver}

---

referencePassword:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.referencePassword}

---

referenceServer:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.referenceServer}

---

referenceUrl:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.referenceUrl}

---

referenceUsername:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.referenceUsername}

---

server:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.server}

---

skip:

• Type: boolean
• Required: No
• Expression: ${liquibase.should.run}

---

systemProperties:

• Type: java.util.Properties
• Required: No

---

url:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.url}

---

username:

• Type: java.lang.String
• Required: No
• Expression: ${liquibase.username}

---

verbose:

• Type: boolean
• Required: No
• Expression: ${liquibase.verbose}
• Default: false