Maven rollback-one-changeset-sql
Note: This is a Liquibase Pro goal, so you need a Liquibase Pro License Key to use it.
rollback-one-changeset-sql is a helper goal that allows you to inspect the SQL Liquibase will run to revert the changeset specified when using the rollback-one-changeset goal.
Uses
rollback-one-changeset-sql is typically used when you want to inspect the raw SQL that Liquibase uses to revert your changeset when you run the rollback-one-changeset goal so that you don't unintentionally make a mistake.
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, include <changelog-file>specify your changelog file here</changelog-file> and <ProLicenseKey>specify your Liquibase Pro license key here</ProLicenseKey> to pom.xml.
Running the rollback-one-changeset-sql Maven goal
Before running the rollback-one-changeset-sql goal, gather the following information from your DATABASECHANGELOG table:
- The
authorof the changeset you want to revert - The
idof the changeset you want to revert - The
filename(changeset path) of the changeset you want to revert
Note: The liquibase.rollbackScript script is only needed if the rollback is not yet defined in the changelog and if it is not a rollback that is automatically provided by Liquibase.
Also, you can run the history goal to see the history of all deployments against the configured database:
mvn liquibase:historyNext, run the rollback-one-changeset-sql goal, with your information:
Note: Running the rollback-one-changeset-sql goal requires a Maven project to be implemented.
mvn liquibase:rollback-one-changeset-sql
-Dliquibase.changeSetAuthor="LiquibaseProUser"
-Dliquibase.changeSetId="createProSchema"
-Dliquibase.changeSetPath="changelog.xml" -Dliquibase.forceNote: Enter the name of the changeset author, id, and the path with the changelog filename that you want to use in place of LiquibaseProUser, createProSchema, and changelog.xml. For more information, run mvn liquibase:help -Ddetail=true -Dgoal=rollback-one-changeset-sql.
Output
When successful, the rollback-one-changeset-sql 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:rollback-one-changeset-sql (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 10:24:59 (version 4.1.1 #10 built at 2020-10-12 19:24+0000)
[INFO] Parsing Liquibase Properties File local.liquibase.properties for changeLog parameters
[INFO] Executing on Database: jdbc:oracle:thin:@localhost:1521/ORCL
[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] Successfully acquired change log lock
[INFO] Reading from DATABASECHANGELOG
[INFO] Successfully released change log lock
-- Lock Database
UPDATE DATABASECHANGELOGLOCK SET LOCKED = 1, LOCKEDBY = 'WIN-20E107KB4TN (172.30.3.88)', LOCKGRANTED = TO_TIMESTAMP('2020-11-27 10:25:01.185', 'YYYY-MM-DD HH24:MI:SS.FF') WHERE ID = 1 AND LOCKED = 0;
-- *********************************************************************
-- Rollback changeset 'dbchangelog.xml::createProSchema::LiquibaseProUser'
-- *********************************************************************
-- Change Log: dbchangelog.xml
-- Ran at: 11/27/20 10:25 AM
-- Against: MVN_UAT@jdbc:oracle:thin:@localhost:1521/ORCL
-- Liquibase version: 4.1.1
-- *********************************************************************
-- Rolling Back ChangeSet: dbchangelog.xml::createProSchema:: LiquibaseProUser
DROP TABLE 2;
DELETE FROM DATABASECHANGELOG WHERE ID = 'createProSchema' AND AUTHOR = 'LiquibaseProUser' AND FILENAME = 'dbchangelog.xml';
-- Release Database Lock
UPDATE DATABASECHANGELOGLOCK SET LOCKED = 0, LOCKEDBY = NULL, LOCKGRANTED = NULL WHERE ID = 1;
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4.917 s
[INFO] Finished at: 2020-11-27T10:25:01-06:00
[INFO] ------------------------------------------------------------------------rollback-one-changeset-sql required Maven configuration attributes
|
Attribute |
Definition |
|---|---|
| liquibase.changeSetAuthor | Specifies the author of the changeset you want to roll back. |
| liquibase.changeSetId | Specifies the changeset Id to roll back. |
| liquibase.changeSetPath | Specifies the path to the changelog, which contains the changeset you want to roll back. |
| liquibase.force | Specifies a required flag, which indicates you intend to run rollback-one-changeset-sql. |
| liquibase.liquibaseProLicenseKey | Specifies your Liquibase Pro license key. |
rollback-one-changeset-sql optional Maven configuration attributes
| Attribute | Definition |
|---|---|
| liquibase.changeLogDirectory | Specifies the directory where Liquibase can find your changelog file. |
| liquibase.changelog-file | 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.clear-checksums [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.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 path to the generated SQL output file. |
| liquibase.outputFileEncoding | Indicates that you want to set the
character encoding of the output file during the update-sql 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.rollbackScript | Specifies the path to a rollback script. |
| 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 parameter 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 to use when running 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. |