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

Liquibase Maven can be configured in multiple ways. One way is to define your Liquibase configuration properties in your pom.xml file. To configure your pom.xml file, refer to Configuring Liquibase Attributes in your Maven POM File. If pom.xml does not reference a Liquibase file, include <changeLogFile>specify the changelog file here</changeLogFile> to pom.xml.

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.

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

[INFO] Scanning for projects...
[INFO]
[INFO] -------------------< com.example:liquibase-project >--------------------
[INFO] Building liquibase-project 05XII19
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] --- liquibase-maven-plugin:4.1.1:updateSQL (default-cli) @ liquibase-project ---
[INFO] ------------------------------------------------------------------------
[INFO] Successfully installed license from Base64 string starting with 'ABwwGgQUvH' (property liquibaseProLicenseKey).
[INFO] Liquibase Pro 4.1.1 by Datical licensed to support until Wed Sep 22 23:59:59 CDT 2021
[INFO] Liquibase Pro 4.1.1 by Datical licensed to support until Wed Sep 22 23:59:59 CDT 2021
[INFO] ####################################################
##   _     _             _ _                      ##
##  | |   (_)           (_) |                     ##
##  | |    _  __ _ _   _ _| |__   __ _ ___  ___   ##
##  | |   | |/ _` | | | | | '_ \ / _` / __|/ _ \  ##
##  | |___| | (_| | |_| | | |_) | (_| \__ \  __/  ##
##  \_____/_|\__, |\__,_|_|_.__/ \__,_|___/\___|  ##
##              | |                               ##
##              |_|                               ##
##                                                ##
##  Get documentation at docs.liquibase.com       ##
##  Get certified courses at learn.liquibase.com  ##
##  Get advanced features and support at          ##
##      liquibase.com/support                     ##
##                                                ##
####################################################
Starting Liquibase at 03:39:21 (version 4.1.1 #10 built at 2020-10-12 19:24+0000)
[INFO] Char encoding not set! The created file will be system dependent!
[INFO] Output SQL Migration File: C:\Users\Nataliya.WIN-20E107KB4TN\Desktop\Liquibase Projects\Maven Projects\my-liquibase-app\target\liquibase\migrate.sql
[INFO] Parsing Liquibase Properties File local.liquibase.properties for changeLog parameters
[INFO] Executing on Database: jdbc:oracle:thin:@localhost:1521/ORCL
[INFO] Successfully acquired change log lock
[INFO] Reading from DATABASECHANGELOG
[INFO] Table 25 created
[INFO] ChangeSet dbchangelog.xml::1606322157619-5::Nataliya (generated) ran successfully in 3ms
[INFO] Table 34 created
[INFO] ChangeSet dbchangelog.xml::1606322157619-16::Nataliya (generated) ran successfully in 1ms
[INFO] Table 24 created
[INFO] ChangeSet dbchangelog.xml::1606322157619-17::Nataliya (generated) ran successfully in 1ms
[INFO] Successfully released change log lock
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.960 s
[INFO] Finished at: 2020-11-27T03:39:22-06:00
[INFO] ------------------------------------------------------------------------
-- *********************************************************************
-- 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.