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.

Parameters

Global parameters

Attribute Definition Requirement

--license-key=<string>

Your Liquibase Pro license key

 Required

--output-file=<string>

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

 Optional

Command parameters

Attribute Definition Requirement

--changelog-file=<string>

The root changelog

 Required

--changeset-author=<string>

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

 Required

--changeset-id=<string>

The changeset ID from the changelog.

 Required

--changeset-path=<string>

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

 Required

--url=<string>

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

 Required

--default-catalog-name=<string>

Name of the default catalog to use for the database connection

 Optional

--default-schema-name=<string>

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=<string>

The JDBC driver class

 Optional

--driver-properties-file=<string>

The JDBC driver properties file

 Optional

--output-default-catalog=<true|false>

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=<true|false>

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=<string>

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=<string>

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=<string>

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

Global parameters

Attribute Definition Requirement

globalArgs: { license-key: "<string>" }

Your Liquibase Pro license key

 Required

globalArgs: { output-file: "<string>" }

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

 Optional

Command parameters

Attribute Definition Requirement

cmdArgs: { changelog-file: "<string>" }

The root changelog

 Required

cmdArgs: { changeset-author: "<string>" }

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

 Required

cmdArgs: { changeset-id: "<string>" }

The changeset ID from the changelog.

 Required

cmdArgs: { changeset-path: "<string>" }

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

 Required

cmdArgs: { url: "<string>" }

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

 Required

cmdArgs: { default-catalog-name: "<string>" }

Name of the default catalog to use for the database connection

 Optional

cmdArgs: { default-schema-name: "<string>" }

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

cmdArgs: { driver: "<string>" }

The JDBC driver class

 Optional

cmdArgs: { driver-properties-file: "<string>" }

The JDBC driver properties file

 Optional

cmdArgs: { output-default-catalog: "<true|false>" }

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

cmdArgs: { output-default-schema: "<true|false>" }

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

cmdArgs: { password: "<string>" }

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

cmdArgs: { rollback-script: "<string>" }

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

cmdArgs: { username: "<string>" }

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

Global parameters

Attribute Definition Requirement

liquibase.licenseKey: <string>

Your Liquibase Pro license key

 Required

liquibase.outputFile: <string>

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

 Optional

Command parameters

Attribute Definition Requirement

liquibase.command.changelogFile: <string>

liquibase.command.rollbackOneChangesetSql.changelogFile: <string>

The root changelog

 Required

liquibase.command.changesetAuthor: <string>

liquibase.command.rollbackOneChangesetSql.changesetAuthor: <string>

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

 Required

liquibase.command.changesetId: <string>

liquibase.command.rollbackOneChangesetSql.changesetId: <string>

The changeset ID from the changelog.

 Required

liquibase.command.changesetPath: <string>

liquibase.command.rollbackOneChangesetSql.changesetPath: <string>

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

 Required

liquibase.command.url: <string>

liquibase.command.rollbackOneChangesetSql.url: <string>

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

 Required

liquibase.command.defaultCatalogName: <string>

liquibase.command.rollbackOneChangesetSql.defaultCatalogName: <string>

Name of the default catalog to use for the database connection

 Optional

liquibase.command.defaultSchemaName: <string>

liquibase.command.rollbackOneChangesetSql.defaultSchemaName: <string>

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

liquibase.command.driver: <string>

liquibase.command.rollbackOneChangesetSql.driver: <string>

The JDBC driver class

 Optional

liquibase.command.driverPropertiesFile: <string>

liquibase.command.rollbackOneChangesetSql.driverPropertiesFile: <string>

The JDBC driver properties file

 Optional

liquibase.command.outputDefaultCatalog: <true|false>

liquibase.command.rollbackOneChangesetSql.outputDefaultCatalog: <true|false>

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

liquibase.command.outputDefaultSchema: <true|false>

liquibase.command.rollbackOneChangesetSql.outputDefaultSchema: <true|false>

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

liquibase.command.password: <string>

liquibase.command.rollbackOneChangesetSql.password: <string>

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

liquibase.command.rollbackScript: <string>

liquibase.command.rollbackOneChangesetSql.rollbackScript: <string>

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

liquibase.command.username: <string>

liquibase.command.rollbackOneChangesetSql.username: <string>

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

Global parameters

Attribute Definition Requirement

JAVA_OPTS=-Dliquibase.licenseKey=<string>

Your Liquibase Pro license key

 Required

JAVA_OPTS=-Dliquibase.outputFile=<string>

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

 Optional

Command parameters

Attribute Definition Requirement

JAVA_OPTS=-Dliquibase.command.changelogFile=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.changelogFile=<string>

The root changelog

 Required

JAVA_OPTS=-Dliquibase.command.changesetAuthor=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.changesetAuthor=<string>

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

 Required

JAVA_OPTS=-Dliquibase.command.changesetId=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.changesetId=<string>

The changeset ID from the changelog.

 Required

JAVA_OPTS=-Dliquibase.command.changesetPath=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.changesetPath=<string>

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

 Required

JAVA_OPTS=-Dliquibase.command.url=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.url=<string>

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

 Required

JAVA_OPTS=-Dliquibase.command.defaultCatalogName=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.defaultCatalogName=<string>

Name of the default catalog to use for the database connection

 Optional

JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.defaultSchemaName=<string>

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

JAVA_OPTS=-Dliquibase.command.driver=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.driver=<string>

The JDBC driver class

 Optional

JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.driverPropertiesFile=<string>

The JDBC driver properties file

 Optional

JAVA_OPTS=-Dliquibase.command.outputDefaultCatalog=<true|false>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.outputDefaultCatalog=<true|false>

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

JAVA_OPTS=-Dliquibase.command.outputDefaultSchema=<true|false>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.outputDefaultSchema=<true|false>

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

JAVA_OPTS=-Dliquibase.command.password=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.password=<string>

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

JAVA_OPTS=-Dliquibase.command.rollbackScript=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.rollbackScript=<string>

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

JAVA_OPTS=-Dliquibase.command.username=<string>

JAVA_OPTS=-Dliquibase.command.rollbackOneChangesetSql.username=<string>

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

Global parameters

Attribute Definition Requirement

LIQUIBASE_LICENSE_KEY=<string>

Your Liquibase Pro license key

 Required

LIQUIBASE_OUTPUT_FILE=<string>

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

 Optional

Command parameters

Attribute Definition Requirement

LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_CHANGELOG_FILE=<string>

The root changelog

 Required

LIQUIBASE_COMMAND_CHANGESET_AUTHOR=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_CHANGESET_AUTHOR=<string>

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

 Required

LIQUIBASE_COMMAND_CHANGESET_ID=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_CHANGESET_ID=<string>

The changeset ID from the changelog.

 Required

LIQUIBASE_COMMAND_CHANGESET_PATH=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_CHANGESET_PATH=<string>

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

 Required

LIQUIBASE_COMMAND_URL=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_URL=<string>

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

 Required

LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_DEFAULT_CATALOG_NAME=<string>

Name of the default catalog to use for the database connection

 Optional

LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_DEFAULT_SCHEMA_NAME=<string>

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

LIQUIBASE_COMMAND_DRIVER=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_DRIVER=<string>

The JDBC driver class

 Optional

LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_DRIVER_PROPERTIES_FILE=<string>

The JDBC driver properties file

 Optional

LIQUIBASE_COMMAND_OUTPUT_DEFAULT_CATALOG=<true|false>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_OUTPUT_DEFAULT_CATALOG=<true|false>

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

LIQUIBASE_COMMAND_OUTPUT_DEFAULT_SCHEMA=<true|false>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_OUTPUT_DEFAULT_SCHEMA=<true|false>

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

LIQUIBASE_COMMAND_PASSWORD=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_PASSWORD=<string>

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

LIQUIBASE_COMMAND_ROLLBACK_SCRIPT=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_ROLLBACK_SCRIPT=<string>

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

LIQUIBASE_COMMAND_USERNAME=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_SQL_USERNAME=<string>

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