`update-to-tag-sql`

The update-to-tag-sql command is a helper command that inspects the SQL Liquibase will run while using the update-to-tag command.

Uses

The update-to-tag-sql command is used to inspect the raw SQL before running the update-to-tag command, so you can correct any issues that may arise before running the command. Liquibase uses the raw SQL to apply database changes you have added to the changelog file based on the tag specified.

Tip: When you run update-to-tag-sql, check whether you specified the correct tag and which changesets were deployed. (If you specify a tag that Liquibase cannot find in your changelog, the update-to-tag command deploys all changes.)

Syntax

To run the update-to-tag-sql command, specify the driver, classpath, and URL in the Liquibase properties file. You can also specify them from the command line.

Then run the update-to-tag-sql command:

liquibase update-to-tag-sql --tag=myTag --changelog-file=example-changelog.xml

Note: The --tag=myTag syntax was added in Liquibase 4.4. If you use an older version, specify your tag as a positional argument: <command> myTag.

Parameters

Global parameters

Attribute	Definition	Requirement
`--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
`--tag=<string>`	The tag identifying which tagged changesets in the changelog to evaluate. Specify as `--tag=myTag`. Positional format `<command> <tag>` deprecated in 4.4+.	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	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
`--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
`--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: { 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: { tag: "<string>" }`	The tag identifying which tagged changesets in the changelog to evaluate. Specify as `--tag=myTag`. Positional format `<command> <tag>` deprecated in 4.4+.	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	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: { 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: { 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.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.updateToTagSql.changelogFile: <string>`	The root changelog	Required
`liquibase.command.tag: <string>` `liquibase.command.updateToTagSql.tag: <string>`	The tag identifying which tagged changesets in the changelog to evaluate. Specify as `--tag=myTag`. Positional format `<command> <tag>` deprecated in 4.4+.	Required
`liquibase.command.url: <string>` `liquibase.command.updateToTagSql.url: <string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`liquibase.command.changeExecListenerClass: <string>` `liquibase.command.updateToTagSql.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.updateToTagSql.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.updateToTagSql.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.updateToTagSql.defaultCatalogName: <string>`	Name of the default catalog to use for the database connection	Optional
`liquibase.command.defaultSchemaName: <string>` `liquibase.command.updateToTagSql.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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`liquibase.command.driver: <string>` `liquibase.command.updateToTagSql.driver: <string>`	The JDBC driver class	Optional
`liquibase.command.driverPropertiesFile: <string>` `liquibase.command.updateToTagSql.driverPropertiesFile: <string>`	The JDBC driver properties file	Optional
`liquibase.command.labelFilter: <string>` `liquibase.command.updateToTagSql.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.outputDefaultCatalog: <true\|false>` `liquibase.command.updateToTagSql.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.updateToTagSql.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.updateToTagSql.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.updateToTagSql.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.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.updateToTagSql.changelogFile=<string>`	The root changelog	Required
`JAVA_OPTS=-Dliquibase.command.tag=<string>` `JAVA_OPTS=-Dliquibase.command.updateToTagSql.tag=<string>`	The tag identifying which tagged changesets in the changelog to evaluate. Specify as `--tag=myTag`. Positional format `<command> <tag>` deprecated in 4.4+.	Required
`JAVA_OPTS=-Dliquibase.command.url=<string>` `JAVA_OPTS=-Dliquibase.command.updateToTagSql.url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`JAVA_OPTS=-Dliquibase.command.changeExecListenerClass=<string>` `JAVA_OPTS=-Dliquibase.command.updateToTagSql.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.updateToTagSql.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.updateToTagSql.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.updateToTagSql.defaultCatalogName=<string>`	Name of the default catalog to use for the database connection	Optional
`JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>` `JAVA_OPTS=-Dliquibase.command.updateToTagSql.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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`JAVA_OPTS=-Dliquibase.command.driver=<string>` `JAVA_OPTS=-Dliquibase.command.updateToTagSql.driver=<string>`	The JDBC driver class	Optional
`JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.updateToTagSql.driverPropertiesFile=<string>`	The JDBC driver properties file	Optional
`JAVA_OPTS=-Dliquibase.command.labelFilter=<string>` `JAVA_OPTS=-Dliquibase.command.updateToTagSql.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.outputDefaultCatalog=<true\|false>` `JAVA_OPTS=-Dliquibase.command.updateToTagSql.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.updateToTagSql.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.updateToTagSql.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.updateToTagSql.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_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_UPDATE_TO_TAG_SQL_CHANGELOG_FILE=<string>`	The root changelog	Required
`LIQUIBASE_COMMAND_TAG=<string>` `LIQUIBASE_COMMAND_UPDATE_TO_TAG_SQL_TAG=<string>`	The tag identifying which tagged changesets in the changelog to evaluate. Specify as `--tag=myTag`. Positional format `<command> <tag>` deprecated in 4.4+.	Required
`LIQUIBASE_COMMAND_URL=<string>` `LIQUIBASE_COMMAND_UPDATE_TO_TAG_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_TO_TAG_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_TO_TAG_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_TO_TAG_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_TO_TAG_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_TO_TAG_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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`LIQUIBASE_COMMAND_DRIVER=<string>` `LIQUIBASE_COMMAND_UPDATE_TO_TAG_SQL_DRIVER=<string>`	The JDBC driver class	Optional
`LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_UPDATE_TO_TAG_SQL_DRIVER_PROPERTIES_FILE=<string>`	The JDBC driver properties file	Optional
`LIQUIBASE_COMMAND_LABEL_FILTER=<string>` `LIQUIBASE_COMMAND_UPDATE_TO_TAG_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_OUTPUT_DEFAULT_CATALOG=<true\|false>` `LIQUIBASE_COMMAND_UPDATE_TO_TAG_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_UPDATE_TO_TAG_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_UPDATE_TO_TAG_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_TO_TAG_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

*Liquibase checks the changelog and any nested changelogs for the definitions of the changesets to update.

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

Liquibase Version: 4.9.1
Liquibase Community 4.9.1 by Liquibase
-- *********************************************************************
-- Update to 'version3' Database Script
-- *********************************************************************
-- Change Log: example-changelog.sql
-- Ran at: 5/9/22, 2:50 PM
-- Against: DBUSER@jdbc:h2:tcp://localhost:9090/mem:dev
-- Liquibase version: 4.9.1
-- *********************************************************************

-- Lock Database
UPDATE PUBLIC.DATABASECHANGELOGLOCK SET LOCKED = TRUE, LOCKEDBY = 'DESKTOP-SQVSSV2 (192.168.1.179)', LOCKGRANTED = NOW() WHERE ID = 1 AND LOCKED = FALSE;

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

Liquibase command 'update-to-tag-sql' was executed successfully.