rollback-one-changeset-sql

Note: This is a Liquibase Pro feature, so you need a Liquibase Pro License Key to use it.

The rollback-one-changeset-sql command is a helper command that allows you to inspect the SQL Liquibase will run to revert the changeset specified in the rollback-one-changeset command. It is only available for Liquibase Pro users.

Uses

The rollback-one-changeset-sql command is useful when you want to inspect the raw SQL that Liquibase uses to revert your changeset when you run the rollback-one-changeset command, so that you don't unintentionally make a mistake.

Syntax

Before running the rollback-one-changeset-sql command, gather the following information from your DATABASECHANGELOG table or by running the history command:

  • The author of the changeset you want to revert
  • The ID of the changeset you want to revert
  • The file path and name of the changeset you want to revert

Then run the rollback-one-changeset-sql command, with your information:

liquibase rollback-one-changeset-sql --changelog-file=example-changelog.xml --changeset-author="LiquibaseProUser" --changeset-id="createProc-proschema" --changeset-path=changelog.xml

For more command-specific help, type liquibase rollback-one-changeset-sql --help into the command prompt.

Global arguments

Tip: For best results, specify all commands and parameters in the --kebab-case format in the CLI. If your preference is camelCase, it also works in the CLI.

Attribute Definition Requirement
--license-key

Your Liquibase Pro license key

 Required
--output-file

File path to where the command output will be written. If not specified, output goes to STDOUT. See --output-file.

 Optional

Command arguments

Attribute Definition Requirement
--changeset-author

The name of the author for the changeset. Supports * as a wildcard.

 Required
--changeset-id

The changeset ID from the changelog.

 Required
--changelog-file

The root changelog

 Required
--changeset-path

The path to the changelog containing the changeset you want to roll back.

 Required
--url

The JDBC database connection URL. See Using JDBC URL in Liquibase.

 Required
--default-catalog-name

Name of the default catalog to use for the database connection

 Optional
--default-schema-name

Name of the default schema to use for the database connection. If defaultSchemaName is set, then objects do not have to be fully qualified. This means you can refer to just mytable instead of myschema.mytable.

Tip: In Liquibase v4.23.0+, camelCase for defaultSchemaName works successfully. If you are on an earlier version, camelCase may not work as expected.

Note: The syntax liquibase.command.defaultSchemaName is valid for v4.19.0+. For prior versions, use defaultSchemaName.

 Optional
--driver

The JDBC driver class

 Optional
--driver-properties-file

The JDBC driver properties file

 Optional
--output-default-catalog

Control whether names of objects in the default catalog are fully qualified or not. If true, they are. If false, only objects outside the default catalog are fully qualified Default: true.

 Optional
--output-default-schema

Control whether names of objects in the default schema are fully qualified or not. If true, they are. If false, only objects outside the default schema are fully qualified Default: true.

 Optional
--password

Password to connect to the target database.

Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.

 Optional
--rollback-script

The path to the script to use to perform the rollback. Only needed if the rollback is not already defined in the changelog, and if it is not a rollback statement that is automatically generated by Liquibase.

 Optional
--username

Username to connect to the target database.

Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.

 Optional

Note: The username and password attributes are not required for connections and systems which use alternate means of authentication. Also, you can specify database credentials as part of the url attribute.

Output

When successful, the rollback-one-changeset-sql command produces the following output:

Liquibase Version: 4.9.1
Liquibase Pro 4.9.1 by Liquibase licensed to Liquibase Pro Evaluation until Tue Jun 07 18:00:00 MDT 2022
WARNING!  Your license will expire in 29 days!
To renew Liquibase Pro please contact sales@liquibase.com or go to https://www.liquibase.org/download
rollback-one-changeset executed for DBUSER@jdbc:h2:tcp://localhost:9090/mem:dev
-- Lock Database
UPDATE PUBLIC.DATABASECHANGELOGLOCK SET LOCKED = TRUE, LOCKEDBY = 'DESKTOP-SQVSSV2 (192.168.1.179)', LOCKGRANTED = NOW() WHERE ID = 1 AND LOCKED = FALSE;

-- *********************************************************************
--rollback changeset 'example-changelog.sql::1::your.name'
-- *********************************************************************
-- Change Log: example-changelog.sql
-- Ran at: 5/10/22, 4:31 PM
-- Against: DBUSER@jdbc:h2:tcp://localhost:9090/mem:dev
-- Liquibase version: 4.9.1
-- *********************************************************************

-- Rolling Back ChangeSet: example-changelog.sql::1::your.name
DROP TABLE person;

DELETE FROM PUBLIC.DATABASECHANGELOG WHERE ID = '1' AND AUTHOR = 'your.name' AND FILENAME = 'example-changelog.sql';

-- Release Database Lock
UPDATE PUBLIC.DATABASECHANGELOGLOCK SET LOCKED = FALSE, LOCKEDBY = NULL, LOCKGRANTED = NULL WHERE ID = 1;

Liquibase command 'rollback-one-changeset-sql' was executed successfully.

Like what you see? Try this command in Pro for Free.

Related links