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.

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.

Parameter 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

Parameter 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
--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
--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
--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.

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