liquibase:rollback
Full name:
org.liquibase:liquibase-plugin:1.7.0.0-SNAPSHOT:rollback
Description:
A Maven Mojo for invoking Liquibase rollbacks on a 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 |
|---|---|---|---|
| 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. |
| defaultSchemaName | String |
- |
The default schema name to use the for database connection. |
| driver | String |
- |
The fully qualified name of the driver class to use to connect to the database. |
| dropFirst | boolean |
- |
Whether or not to perform a drop on the database before executing
the change. Default value is: false. |
| emptyPassword | boolean |
- |
Deprecated. Use an empty string as the password for the database connection.
This should not be used along side the password
setting. Default value is: false. |
| 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. |
| 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. |
| rollbackCount | int |
- |
The number of change sets to rollback. Default value is: -1. |
| rollbackDate | String |
- |
The date to rollback the database to. The format of the date must
match that of the DateFormat.getDateInstance() for the
platform the plugin is executing on. |
| rollbackTag | String |
- |
The tag to roll the database back to. |
| 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
Specifies the change log file to use for Liquibase.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.changeLogFile}
Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table.
- Type:
boolean - Required:
No - Expression:
${liquibase.clearCheckSums} - Default:
false
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 - Expression:
${liquibase.contexts}
The default schema name to use the for database connection.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.defaultSchemaName}
driver :
The fully qualified name of the driver class to use to connect to the database.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.driver}
Whether or not to perform a drop on the database before executing the change.
- Type:
boolean - Required:
No - Expression:
${liquibase.dropFirst} - Default:
false
Use an empty string as the password for the database connection.
This should not be used along side the password
setting.
- Deprecated:
Use an empty or null value for the password instead. - Type:
boolean - Required:
No - Expression:
${liquibase.emptyPassword} - Default:
false
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 - Expression:
${liquibase.includeArtifact} - Default:
true
logging :
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.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.logging} - Default:
INFO
password :
The database password to use to connect to the specified database.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.password}
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 - Expression:
${liquibase.promptOnNonLocalDatabase} - Default:
true
The Liquibase properties file used to configure the Liquibase
Liquibase.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.propertyFile}
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 - Expression:
${liquibase.propertyFileWillOverride} - Default:
false
The number of change sets to rollback.
- Type:
int - Required:
No - Expression:
${liquibase.rollbackCount} - Default:
-1
The date to rollback the database to. The format of the date must
match that of the DateFormat.getDateInstance() for the
platform the plugin is executing on.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.rollbackDate}
The tag to roll the database back to.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.rollbackTag}
url :
The Database URL to connect to for executing Liquibase.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.url}
username :
The database username to use to connect to the specified database.
- Type:
java.lang.String - Required:
No - Expression:
${liquibase.username}
verbose :
Controls the verbosity of the output from invoking the plugin.
- Type:
boolean - Required:
No - Expression:
${liquibase.verbose} - Default:
false
