`update-one-changeset-sql`

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

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

Uses

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

Syntax

Before running the update-one-changeset-sql command, gather the following information from your changelog:

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

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

liquibase update-one-changeset-sql --changelog-file=example-changelog.xml --changeset-id=2 --changeset-author=anotherdev --changeset-path=example-changelog.xml

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

Parameters

Global parameters

Parameter	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

Parameter	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
`--change-exec-listener-class=<string>`	Fully-qualified class which specifies a `ChangeExecListener`. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`--change-exec-listener-properties-file=<string>`	Path to a properties file for the `ChangeExecListener` class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`--context-filter=<string>`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`--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
`--label-filter=<string>`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	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
`--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

Parameter	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

Parameter	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: { change-exec-listener-class: "<string>" }`	Fully-qualified class which specifies a `ChangeExecListener`. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`cmdArgs: { change-exec-listener-properties-file: "<string>" }`	Path to a properties file for the `ChangeExecListener` class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`cmdArgs: { context-filter: "<string>" }`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`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: { label-filter: "<string>" }`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	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: { 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

Parameter	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

Parameter	Definition	Requirement
`liquibase.command.changelogFile: <string>` `liquibase.command.updateOneChangesetSql.changelogFile: <string>`	The root changelog	Required
`liquibase.command.changesetAuthor: <string>` `liquibase.command.updateOneChangesetSql.changesetAuthor: <string>`	The name of the author for the changeset. Supports `*` as a wildcard.	Required
`liquibase.command.changesetId: <string>` `liquibase.command.updateOneChangesetSql.changesetId: <string>`	The changeset ID from the changelog.	Required
`liquibase.command.changesetPath: <string>` `liquibase.command.updateOneChangesetSql.changesetPath: <string>`	The path to the changelog containing the changeset you want to roll back.	Required
`liquibase.command.url: <string>` `liquibase.command.updateOneChangesetSql.url: <string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`liquibase.command.changeExecListenerClass: <string>` `liquibase.command.updateOneChangesetSql.changeExecListenerClass: <string>`	Fully-qualified class which specifies a `ChangeExecListener`. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`liquibase.command.changeExecListenerPropertiesFile: <string>` `liquibase.command.updateOneChangesetSql.changeExecListenerPropertiesFile: <string>`	Path to a properties file for the `ChangeExecListener` class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`liquibase.command.contextFilter: <string>` `liquibase.command.updateOneChangesetSql.contextFilter: <string>`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`liquibase.command.defaultCatalogName: <string>` `liquibase.command.updateOneChangesetSql.defaultCatalogName: <string>`	Name of the default catalog to use for the database connection	Optional
`liquibase.command.defaultSchemaName: <string>` `liquibase.command.updateOneChangesetSql.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.updateOneChangesetSql.driver: <string>`	The JDBC driver class	Optional
`liquibase.command.driverPropertiesFile: <string>` `liquibase.command.updateOneChangesetSql.driverPropertiesFile: <string>`	The JDBC driver properties file	Optional
`liquibase.command.labelFilter: <string>` `liquibase.command.updateOneChangesetSql.labelFilter: <string>`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	Optional
`liquibase.command.password: <string>` `liquibase.command.updateOneChangesetSql.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.username: <string>` `liquibase.command.updateOneChangesetSql.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

Parameter	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

Parameter	Definition	Requirement
`JAVA_OPTS=-Dliquibase.command.changelogFile=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.changelogFile=<string>`	The root changelog	Required
`JAVA_OPTS=-Dliquibase.command.changesetAuthor=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.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.updateOneChangesetSql.changesetId=<string>`	The changeset ID from the changelog.	Required
`JAVA_OPTS=-Dliquibase.command.changesetPath=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.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.updateOneChangesetSql.url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`JAVA_OPTS=-Dliquibase.command.changeExecListenerClass=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.changeExecListenerClass=<string>`	Fully-qualified class which specifies a `ChangeExecListener`. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`JAVA_OPTS=-Dliquibase.command.changeExecListenerPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.changeExecListenerPropertiesFile=<string>`	Path to a properties file for the `ChangeExecListener` class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`JAVA_OPTS=-Dliquibase.command.contextFilter=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.contextFilter=<string>`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`JAVA_OPTS=-Dliquibase.command.defaultCatalogName=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.defaultCatalogName=<string>`	Name of the default catalog to use for the database connection	Optional
`JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.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.updateOneChangesetSql.driver=<string>`	The JDBC driver class	Optional
`JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.driverPropertiesFile=<string>`	The JDBC driver properties file	Optional
`JAVA_OPTS=-Dliquibase.command.labelFilter=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.labelFilter=<string>`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	Optional
`JAVA_OPTS=-Dliquibase.command.password=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.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.username=<string>` `JAVA_OPTS=-Dliquibase.command.updateOneChangesetSql.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

Parameter	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

Parameter	Definition	Requirement
`LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>` `LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_SQL_CHANGELOG_FILE=<string>`	The root changelog	Required
`LIQUIBASE_COMMAND_CHANGESET_AUTHOR=<string>` `LIQUIBASE_COMMAND_UPDATE_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_UPDATE_ONE_CHANGESET_SQL_CHANGESET_ID=<string>`	The changeset ID from the changelog.	Required
`LIQUIBASE_COMMAND_CHANGESET_PATH=<string>` `LIQUIBASE_COMMAND_UPDATE_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_UPDATE_ONE_CHANGESET_SQL_URL=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_CLASS=<string>` `LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_SQL_CHANGE_EXEC_LISTENER_CLASS=<string>`	Fully-qualified class which specifies a `ChangeExecListener`. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_SQL_CHANGE_EXEC_LISTENER_PROPERTIES_FILE=<string>`	Path to a properties file for the `ChangeExecListener` class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`LIQUIBASE_COMMAND_CONTEXT_FILTER=<string>` `LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_SQL_CONTEXT_FILTER=<string>`	Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run. Note: If you use Liquibase 4.23.0 or earlier, use the syntax `--contexts` instead of `--context-filter`.	Optional
`LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>` `LIQUIBASE_COMMAND_UPDATE_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_UPDATE_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_UPDATE_ONE_CHANGESET_SQL_DRIVER=<string>`	The JDBC driver class	Optional
`LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_SQL_DRIVER_PROPERTIES_FILE=<string>`	The JDBC driver properties file	Optional
`LIQUIBASE_COMMAND_LABEL_FILTER=<string>` `LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_SQL_LABEL_FILTER=<string>`	Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.	Optional
`LIQUIBASE_COMMAND_PASSWORD=<string>` `LIQUIBASE_COMMAND_UPDATE_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_USERNAME=<string>` `LIQUIBASE_COMMAND_UPDATE_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 update-one-changeset-sql command produces the following output:

$ liquibase update-one-changeset-sql --changeset-id=2 --changeset-author=anotherdev --changeset-path=example-changelog.sql

-- Create Database Lock Table
CREATE TABLE DATABASECHANGELOGLOCK (ID INT NOT NULL, LOCKED BOOLEAN NOT NULL, LOCKGRANTED TIMESTAMP, LOCKEDBY VARCHAR(255), CONSTRAINT PK_DATABASECHANGELOGLOCK PRIMARY KEY (ID));

-- Initialize Database Lock Table
DELETE FROM DATABASECHANGELOGLOCK;

INSERT INTO DATABASECHANGELOGLOCK (ID, LOCKED) VALUES (1, FALSE);

-- Lock Database
UPDATE DATABASECHANGELOGLOCK SET LOCKED = TRUE, LOCKEDBY = 'mmc-mbp.lan (192.168.86.155)', LOCKGRANTED = NOW() WHERE ID = 1 AND LOCKED = FALSE;

-- Create Database Change Log Table
CREATE TABLE DATABASECHANGELOG (ID VARCHAR(255) NOT NULL, AUTHOR VARCHAR(255) NOT NULL, FILENAME VARCHAR(255) NOT NULL, DATEEXECUTED TIMESTAMP NOT NULL, ORDEREXECUTED INT NOT NULL, EXECTYPE VARCHAR(10) NOT NULL, MD5SUM VARCHAR(35), DESCRIPTION VARCHAR(255), COMMENTS VARCHAR(255), TAG VARCHAR(255), LIQUIBASE VARCHAR(20), CONTEXTS VARCHAR(255), LABELS VARCHAR(255), DEPLOYMENT_ID VARCHAR(10));

--changeset example-changelog.sql::2::anotherdev
-- example comment
create table company (
    id int primary key auto_increment not null,
    name varchar(50) not null,
    address1 varchar(50),
    address2 varchar(50),
    city varchar(30)
);

INSERT INTO DATABASECHANGELOG (ID, AUTHOR, FILENAME, DATEEXECUTED, ORDEREXECUTED, MD5SUM, DESCRIPTION, COMMENTS, EXECTYPE, CONTEXTS, LABELS, LIQUIBASE, DEPLOYMENT_ID) VALUES ('2', 'anotherdev', 'example-changelog.sql', NOW(), 1, '8:7db038f9d66960203d8a260e9751a2bd', 'sql', 'example comment', 'EXECUTED', 'example-context', 'example-label', 'DEV', '1888387896');

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

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

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