Maven `updateSQL`

updateSQL is a helper goal that allows you to inspect the SQL Liquibase will run while using the Maven update goal.

Uses

updateSQL is typically used when you want to inspect the raw SQL before running the update goal, so you can correct any issues that may arise before running the goal. Liquibase uses the raw SQL to apply changes that you have added to the changelog file to the database.

Maven configuration

You can configure Liquibase Maven in multiple ways. You can pass arguments like <changeLogFile> in Maven directly in your pom.xml file, in a liquibase.properties file referenced in your POM, as environment variables, or as JVM system properties.

Tip: For more information about the Maven configuration, see Configuring Maven.

Running the `updateSQL` Maven goal

Running the updateSQL goal requires a Maven project to be implemented.

To run the goal, type the following in your command prompt:

mvn liquibase:updateSQL

Note: You can also add the liquibase.migrationSqlOutputFile attribute and specify the file to output the migration SQL script to. The default file is migrate.sql. If it exists, it will be overwritten.

Output

When successful, the updateSQL Maven goal produces the following output:


						[INFO] Scanning for projects...
						[INFO] 
						[INFO] ---------------------------- package:projectName ----------------------------
							[INFO] Building projectName 0.0.1-SNAPSHOT
							[INFO]   from pom.xml
							[INFO] --------------------------------[ jar ]---------------------------------
							[INFO] 
							[INFO] --- liquibase:4.25.1:updateSQL (default-cli) @ projectName ---
							[INFO] ------------------------------------------------------------------------
							[INFO] Parsing Liquibase Properties File
							[INFO]   File: liquibase.properties
							[INFO] ------------------------------------------------------------------------
							[INFO] 
							####################################################
							##   _     _             _ _                      ##
							##  | |   (_)           (_) |                     ##
							##  | |    _  __ _ _   _ _| |__   __ _ ___  ___   ##
							##  | |   | |/ _` | | | | | '_ \ / _` / __|/ _ \  ##
							##  | |___| | (_| | |_| | | |_) | (_| \__ \  __/  ##
							##  \_____/_|\__, |\__,_|_|_.__/ \__,_|___/\___|  ##
							##              | |                               ##
							##              |_|                               ##
							##                                                ##
							##  Get documentation at docs.liquibase.com       ##
							##  Get certified courses at learn.liquibase.com  ##
							##                                                ##
							####################################################
							Starting Liquibase at 12:56:38 (version [local build] #0 built at 2024-02-01 19:20+0000)
							[INFO] Set default schema name to PUBLIC
							[INFO] Output SQL Migration File: C:\Users\project-path-here\target\liquibase\migrate.sql
								[INFO] Parsing Liquibase Properties File liquibase.properties for changeLog parameters
								[INFO] Executing on Database: jdbc:h2:tcp://localhost:9090/mem:dev;
								[INFO] Successfully acquired change log lock
								[INFO] Creating database history table with name: DATABASECHANGELOG
								[INFO] Using deploymentId: 7321400093
								[INFO] Table person created
								[INFO] ChangeSet db/changelog/db.changelog-master.xml::1::your.name ran successfully in 10ms
								[INFO] Table company created
								[INFO] ChangeSet db/changelog/db.changelog-master.xml::2::your.name ran successfully in 7ms
								[INFO] Columns country(varchar(2)) added to person
								[INFO] ChangeSet db/changelog/db.changelog-master.xml::3::other.dev ran successfully in 7ms
								[INFO] Update command completed successfully.
								[INFO] Successfully released change log lock
								[INFO] Command execution complete
								[INFO] ------------------------------------------------------------------------
								[INFO]
								[INFO] ------------------------------------------------------------------------
								[INFO] BUILD SUCCESS
								[INFO] ------------------------------------------------------------------------
								[INFO] Total time:  3.212 s
								[INFO] Finished at: 2024-02-07T12:56:40-03:00
								[INFO] ------------------------------------------------------------------------

An example of the output file

-- *********************************************************************
-- Update Database Script
-- *********************************************************************
-- Change Log: dbchangelog.xml
-- Ran at: 11/27/20 3:39 AM
-- Against: MVN_UAT@jdbc:oracle:thin:@localhost:1521/ORCL
-- Liquibase version: 4.1.1
-- *********************************************************************
-- Lock Database
UPDATE DATABASECHANGELOGLOCK SET LOCKED = 1, LOCKEDBY = 'WIN-20E107KB4TN (172.30.3.88)', LOCKGRANTED = TO_TIMESTAMP('2020-11-27 03:39:22.226', 'YYYY-MM-DD HH24:MI:SS.FF') WHERE ID = 1 AND LOCKED = 0;
--changeset dbchangelog.xml::1606322157619-5::Nataliya (generated)
CREATE TABLE 25 (COLUMN14 VARCHAR2(20 BYTE)) TABLESPACE USERS;
INSERT INTO DATABASECHANGELOG (ID, AUTHOR, FILENAME, DATEEXECUTED, ORDEREXECUTED, MD5SUM, DESCRIPTION, COMMENTS, EXECTYPE, CONTEXTS, LABELS, LIQUIBASE, DEPLOYMENT_ID) VALUES ('1606322157619-5', 'Nataliya (generated)', 'dbchangelog.xml', SYSTIMESTAMP, 5, '8:af84f39a12a1f82c4ae37687c38e95c3', 'createTable tableName=25', '', 'EXECUTED', NULL, NULL, '4.1.1', '6469962817');
--changeset dbchangelog.xml::1606322157619-16::Nataliya (generated)
CREATE TABLE 34 (COLUMN1234 VARCHAR2(20 BYTE)) TABLESPACE USERS;
INSERT INTO DATABASECHANGELOG (ID, AUTHOR, FILENAME, DATEEXECUTED, ORDEREXECUTED, MD5SUM, DESCRIPTION, COMMENTS, EXECTYPE, CONTEXTS, LABELS, LIQUIBASE, DEPLOYMENT_ID) VALUES ('1606322157619-16', 'Nataliya (generated)', 'dbchangelog.xml', SYSTIMESTAMP, 6, '8:5503ac52c79f588a025ae7e63123aa31', 'createTable tableName=34', '', 'EXECUTED', NULL, NULL, '4.1.1', '6469962817');
--changeset dbchangelog.xml::1606322157619-17::Nataliya (generated)
CREATE TABLE 24 (COLUMN134 VARCHAR2(20 BYTE)) TABLESPACE USERS;
INSERT INTO DATABASECHANGELOG (ID, AUTHOR, FILENAME, DATEEXECUTED, ORDEREXECUTED, MD5SUM, DESCRIPTION, COMMENTS, EXECTYPE, CONTEXTS, LABELS, LIQUIBASE, DEPLOYMENT_ID) VALUES ('1606322157619-17', 'Nataliya (generated)', 'dbchangelog.xml', SYSTIMESTAMP, 7, '8:f2e0f707ef1a00342c91438c3bfccc16', 'createTable tableName=24', '', 'EXECUTED', NULL, NULL, '4.1.1', '6469962817');
-- Release Database Lock
UPDATE DATABASECHANGELOGLOCK SET LOCKED = 0, LOCKEDBY = NULL, LOCKGRANTED = NULL WHERE ID = 1;

`updateSQL` optional Maven configuration attributes

Attribute	Definition
`liquibase.changeLogDirectory`	Specifies the path to the directory where Liquibase can find your changelog file.
`liquibase.changeLogFile`	The changelog file for Liquibase to use.
`liquibase.changelogCatalogName`	Specifies the catalog Liquibase will use to create your changelog tables.
`liquibase.changelogSchemaName`	Specifies the schema Liquibase will use to create your changelog tables.
`liquibase.changesToApply`	Int. Specifies the number of changes to apply to the database. If 0, all changes not already applied to the database are applied. Default value is: 0.
`liquibase.clearCheckSums`	Boolean. Forces checksums to be cleared from the DATABASECHANGELOG table. Default value is: false.
`liquibase.contexts`	Specifies which contexts Liquibase will execute, which can be separated by a comma if multiple contexts are required. If a context is not specified, then all contexts will be executed.
`liquibase.databaseChangeLogLockTableName`	Specifies the table name to use for the DATABASECHANGELOGLOCK table.
`liquibase.databaseChangeLogTableName`	Specifies the table name to use for the DATABASECHANGELOG table.
`liquibase.databaseClass`	Specifies the database object class.
`liquibase.defaultCatalogName`	Specifies the default catalog name to use for the database connection.
`liquibase.defaultSchemaName`	Specifies the default schema name to use for the database connection.
`liquibase.driver`	Specifies the driver class name to use for the database connection.
`driverPropertiesFile`	Specifies the location of a JDBC connection properties file which contains properties the driver will use.
`liquibase.emptyPassword`	Deprecated. Boolean. Use an empty or null value for the password instead. Default value is: false.
`expressionVariables`	Specifies a map-based collection of changelog properties to apply.
`expressionVars`	Specifies a property-based collection of changelog properties to apply.
`liquibase.includeArtifact`	Boolean. Includes a Maven project artifact in the class loader, which obtains the Liquibase properties file and changelog files. Default value is `true`.
`liquibase.includeTestOutputDirectory`	Boolean. Includes the Maven test output directory in the class loader which obtains the Liquibase properties file and changelog files. Default value is `true`.
`liquibase.labels`	Specifies which labels Liquibase runs, and which can be separated by a comma if multiple labels are required or you need to designate a more complex expression. If no label is specified, then all labels are run.
`liquibase.licenseKey`	Specifies your Liquibase Pro license key.
`liquibase.migrationSqlOutputFile`	Specifies the file to output the rollback/migration SQL script to. If it exists, it will be overwritten. Default value is: `${project.build.directory}/liquibase/migrate.sql`.
`liquibase.outputDefaultCatalog`	Boolean. Specifies whether to ignore the catalog or database name. Default value is: false.
`liquibase.outputDefaultSchema`	Boolean. Specifies whether to ignore the schema name. Default value is: false.
`liquibase.outputFileEncoding`	Indicates that you want to set the character encoding of the output file during the `updateSQL` phase.
`liquibase.password`	Specifies the database password for the database connection.
`liquibase.promptOnNonLocalDatabase`	Deprecated. Boolean. Controls whether users are prompted before executing changesets to a non-local database. Default value is: true.
`liquibase.propertyFile`	Specifies the Liquibase properties file to use for configuration, like `liquibase.properties`.
`liquibase.propertyFileWillOverride`	Boolean. Indicates that you want the `liquibase.properties` file to override any settings provided in the Maven plugin configuration. By default, if a property is explicitly specified, it is not overridden if it also appears in the properties file. Default value is: false.
`liquibase.propertyProviderClass`	Specifies the property provider, which must be a `java.util.Properties` implementation.
`liquibase.server`	Specifies the server ID in the Maven `settings.xml` to use when authenticating.
`liquibase.skip`	Boolean. Specifies whether to skip running Liquibase. The use of this attribute is not recommended but can be used when needed. Default value is: false.
`systemProperties`	Specifies a list of system properties you want to pass to the database.
`liquibase.toTag`	Apply changes up to and including the changesets with the given tag goal.
`liquibase.url`	Specifies the database URL you want to use to execute Liquibase.
`liquibase.username`	Specifies the database username for the database connection.
`liquibase.verbose`	Boolean. Controls the amount of output detail when you call the plugin. Default value is: false.

Maven updateSQL

Uses

Maven configuration

Running the updateSQL Maven goal

updateSQL optional Maven configuration attributes

Maven `updateSQL`

Running the `updateSQL` Maven goal

`updateSQL` optional Maven configuration attributes