Maven futureRollbackSQL
futureRollbackSQL is a helper goal that produces the raw SQL Liquibase would need to roll back changes that have not yet been deployed to your database.
Uses
futureRollbackSQL is typically used when you want to inspect the raw SQL Liquibase would use to revert changes associated with undeployed changesets. The futureRollbackSQL goal generates the SQL that is required to roll back the database to the current state after the next update.
It is best practice to inspect SQL Liquibase would run when using the update goal so you can review any changes the command would make to your database.
Note: The updateSQL goal is also a helper goal that you can use before running the update goal. The main difference is that updateSQL creates objects associated with undeployed changesets and futureRollbackSQL drops objects associated with undeployed changesets.
Maven configuration
Liquibase Maven can be configured in multiple ways. One way is to define your Liquibase configuration properties in your pom.xml file. To configure your pom.xml file, refer to Configuring Liquibase Attributes in your Maven POM File. If pom.xml does not reference a Liquibase properties file, add <changeLogFile>properties-file-name</changeLogFile> to pom.xml, where properties-file-name represents the name of the Liquibase properties file, like liquibase.properties.
Before running the futureRollbackSQL goal, add <outputChangeLogFile>yourOutputFileName.txt</outputChangeLogFile> to pom.xml.
Running the futureRollbackSQL Maven goal
Running the futureRollbackSQL goal requires a Maven project to be implemented.
To run the goal, type the following in your command prompt:
mvn liquibase:futureRollbackSQL
Output
When successful, the futureRollbackSQL Maven goal produces the following output:
[INFO] Scanning for projects...
[INFO]
[INFO] -------------------< com.example:liquibase-project >--------------------
[INFO] Building liquibase-project 05XII19
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] --- liquibase-maven-plugin:4.1.1:futureRollbackSQL (default-cli) @ liquibase-project ---
[INFO] ------------------------------------------------------------------------
[INFO] Successfully installed license from Base64 string starting with 'ABwwGgQUvH' (property liquibaseProLicenseKey).
[INFO] Liquibase Pro 4.1.1 by Datical licensed to support until Wed Sep 22 23:59:59 CDT 2021
[INFO] Liquibase Pro 4.1.1 by Datical licensed to support until Wed Sep 22 23:59:59 CDT 2021
[INFO] ####################################################
## _ _ _ _ ##
## | | (_) (_) | ##
## | | _ __ _ _ _ _| |__ __ _ ___ ___ ##
## | | | |/ _` | | | | | '_ \ / _` / __|/ _ \ ##
## | |___| | (_| | |_| | | |_) | (_| \__ \ __/ ##
## \_____/_|\__, |\__,_|_|_.__/ \__,_|___/\___| ##
## | | ##
## |_| ##
## ##
## Get documentation at docs.liquibase.com ##
## Get certified courses at learn.liquibase.com ##
## Get advanced features and support at ##
## liquibase.com/support ##
## ##
####################################################
Starting Liquibase at 03:57:06 (version 4.1.1 #10 built at 2020-10-12 19:24+0000)
[INFO] Char encoding not set! The created file will be system dependent!
[INFO] Output File: C:\Users\Nataliya.WIN-20E107KB4TN\Desktop\Liquibase Projects\Maven Projects\my-liquibase-app\myfutureRollback.sql
[INFO] Parsing Liquibase Properties File local.liquibase.properties for changeLog parameters
[INFO] Executing on Database: jdbc:oracle:thin:@localhost:1521/ORCL
[INFO] Successfully acquired change log lock
[INFO] Reading from DATABASECHANGELOG
[INFO] Successfully released change log lock
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.341 s
[INFO] Finished at: 2020-11-26T03:57:08-06:00
[INFO] ------------------------------------------------------------------------
An example of the output file
-- *********************************************************************
-- SQL to roll back currently unexecuted changes
-- *********************************************************************
-- Change Log: dbchangelog.xml
-- Ran at: 11/26/20 4:06 AM
-- Against: MVN_UAT@jdbc:oracle:thin:@localhost:1521/ORCL
-- Liquibase version: 4.1.1
-- *********************************************************************
-- Lock Database
UPDATE DATABASECHANGELOGLOCK SET LOCKED = 1, LOCKEDBY = 'WIN-20E107KB4TN (172.30.3.88)', LOCKGRANTED = TO_TIMESTAMP('2020-11-26 04:06:50.763', 'YYYY-MM-DD HH24:MI:SS.FF') WHERE ID = 1 AND LOCKED = 0;
-- Rolling Back ChangeSet: dbchangelog.xml::1606322157619-1::Nataliya (generated)
DROP TABLE TEST;
DELETE FROM DATABASECHANGELOG WHERE ID = '1606322157619-1' AND AUTHOR = 'Nataliya (generated)' AND FILENAME = 'dbchangelog.xml';
-- Release Database Lock
UPDATE DATABASECHANGELOGLOCK SET LOCKED = 0, LOCKEDBY = NULL, LOCKGRANTED = NULL WHERE ID = 1;futureRollbackSQL optional Maven configuration attributes
| Attribute | Definition |
|---|---|
| liquibase.changeLogDirectory | Specifies the directory where Liquibase can find your changelog file. |
| liquibase.changeLogFile | Specifies the changelog file for Liquibase to use. |
| liquibase.changelogCatalogName | Specifies the catalog Liquibase will use to create your changelog tables. |
| liquibase.changelogSchemaName | Specifies the schema Liquibase will use to create your changelog tables. |
| liquibase.clearCheckSums [boolean] | Forces checksums to be cleared from the DATABASECHANGELOG table. Default value is: false. |
| liquibase.contexts | Specifies which contexts Liquibase will execute, which can be separated by a comma if multiple contexts are required. If a context is not specified, then all contexts will be executed. |
| liquibase.databaseChangeLogLockTableName | Specifies the table name to use for the DATABASECHANGELOGLOCK table. |
| liquibase.databaseChangeLogTableName | Specifies the table name to use for the DATABASECHANGELOG table. |
| liquibase.databaseClass | Specifies the database object class. |
| liquibase.defaultCatalogName | Specifies the default catalog name to use for the database connection. |
| liquibase.defaultSchemaName | Specifies the default schema name to use for the database connection. |
| liquibase.driver | Specifies the driver class name to use for the database connection. |
| driverPropertiesFile | Specifies the location of a JDBC connection properties file which contains properties the driver will use. |
| liquibase.emptyPassword [boolean] | Deprecated. Use an empty or null value for the password instead. Default value is: false. |
| expressionVariables | Specifies a map-based collection of changelog properties to apply. |
| expressionVars | Specifies a property-based collection of changelog properties to apply. |
| liquibase.includeArtifact [boolean] | Includes a Maven project artifact in the class
loader, which obtains the Liquibase properties file and
changelog files. Default value is true. |
| liquibase.includeTestOutputDirectory [boolean] | Includes the Maven test output directory in the
class loader, which obtains the Liquibase properties file and
changelog files. Default value is true.
|
| liquibase.labels | Specifies which labels Liquibase will execute, which can be separated by a comma if multiple labels are required or you need to designate a more complex expression. If a label is not specified, then all labels will be executed. |
| liquibase.liquibaseProLicenseKey | Specifies your Liquibase Pro license key. |
| liquibase.outputDefaultCatalog [boolean] | Specifies whether to ignore the catalog or database name. Default value is: false. |
| liquibase.outputDefaultSchema [boolean] | Specifies whether to ignore the schema name. Default value is: false. |
| liquibase.output-file |
Specifies the file to output the rollback SQL script to. If it exists it will be overwritten. Default value is: ${project.build.directory}/liquibase/migrate.sql. |
| liquibase.outputFileEncoding | Indicates that you want to set the
character encoding of the output file during the updateSQL phase. |
| liquibase.password | Specifies the database password for the database connection. |
| liquibase.promptOnNonLocalDatabase [boolean] | [Deprecated] Controls whether users are prompted before executing changesets to a non-local database. Default value is: true. |
| liquibase.propertyFile | Specifies the Liquibase properties file to use for configuration, like liquibase.properties. |
| liquibase.propertyFileWillOverride [boolean] | Values in the Liquibase properties file override settings provided by a Maven plugin. By default, if a property is explicitly specified, it is not overridden if it also appears in the properties file. Default value is false. |
| liquibase.propertyProviderClass | Specifies the property provider which must be a
java.util.Properties implementation. |
| liquibase.rollbackCount |
Defines the number of changesets to roll back. Default value is: 1. |
| liquibase.rollbackDate | Defines the date for which you want to roll back the database. The format of the date must match either an ISO date format or that of the DateFormat.getDateInstance() for the platform the plugin is being executed on. |
| liquibase.rollbackTag | Defines the tag for which you want to roll back the database. |
| liquibase.server | Specifies the server ID in the Maven
settings.xml to use when authenticating. |
| liquibase.skip [boolean] | Specifies whether to skip running Liquibase. The use of this attribute is not recommended but can be used when needed. Default value is: false. |
| systemProperties | Specifies a list of system properties you want to pass to the database. |
| liquibase.url | Specifies the database URL you want to use to execute Liquibase. |
| liquibase.username | Specifies the database username for the database connection. |
| liquibase.verbose [boolean] | Controls the amount of output detail when you call the plugin. Default value is: false. |