Maven listlocks

listLocks returns a list of one that includes the hostname, IP address, and the timestamp the connection acquired the lock on the DATABASECHANGELOG table.

Uses

listLocks is typically used when an error occurs during a database deployment. The error might indicate that there is a lock on the DATABASECHANGELOG table by another user that is preventing Liquibasefrom applying schema changes to the specified database.

listLocks will read the DATABASECHANGELOGLOCK table and return a list that includes the hostname, IP address, and the timestamp the lock was granted to the DATABASECHANGELOG table and determines the connections to the DATABASECHANGELOG table based on the database URL.

Maven configuration

Liquibase Maven can be configured multiple ways. One way is to define your Liquibase configuration properties in your pom.xml file. You can also indicate the location of your liquibase.properties file using the following syntax:

<liquibase.propertyFile>path/to/properties_file</liquibase.propertyFile>

Note: Replace path/to/properties_file with the location of your default properties file. See the example below.

Example: <liquibase.propertyFile>${project.basedir}/local.liquibase.properties</liquibase.propertyFile>

Note: Multiple profiles can be created in the pom.xml which contain different Liquibase properties. See the example below.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
						
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.9.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>liquibase-project</artifactId>
	<version>05XII19</version>
		<profiles>
		<profile>
		<id>DEV</id>
		<properties>
						
<liquibase.propertyFile>${project.basedir}/DEV.properties</liquibase.propertyFile>
		</properties>
	</profile>
	<profile>
		<id>QA</id>
		<properties>
						
<liquibase.propertyFile>${project.basedir}/QA.properties</liquibase.propertyFile>
		</properties>
	</profile>
	<profile>
		<id>PROD</id>
		<properties>
						
<liquibase.propertyFile>${project.basedir}/PROD.properties</liquibase.propertyFile>
		</properties>
	</profile>
	</profiles>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>com.microsoft.sqlserver</groupId>
			<artifactId>mssql-jdbc</artifactId>
			<version>8.1.0.jre8-preview</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/com.oracle.jdbc/ojdbc6 -->
		<dependency>
			<groupId>com.oracle.jdbc</groupId>
			<artifactId>ojdbc8</artifactId>
			<version>19.3.0.0</version>
		</dependency>
	</dependencies>
	<build>
		<pluginManagement>
			<plugins>
				<plugin>
					<groupId>org.springframework.boot</groupId>
					<artifactId>spring-boot-maven-plugin</artifactId>
				</plugin>
				<plugin>
					<groupId>org.liquibase</groupId>
					<artifactId>liquibase-maven-plugin</artifactId>
					<version>3.8.9</version>
 
			<!--  <executions>
				<execution>
					<goals>
						<goal>diff</goal>
					</goals>
					<phase>process-classes</phase>
				</execution>
			</executions>-->
		<dependencies>
						
		<!--Pick ONLY ONE of the following database dependencies.  These are working examples for you to use to start with -->
			<dependency>
				<groupId>com.microsoft.sqlserver</groupId>
				<artifactId>mssql-jdbc</artifactId>
				<version>7.4.1.jre8</version>
			</dependency>
			<dependency>
				<groupId>postgresql</groupId>
				<artifactId>postgresql</artifactId>
				<version>9.1-901-1.jdbc4</version>
			</dependency>
			<dependency>
				<!--  How to add Oracle JDBC driver in your Maven local repository
				https://www.mkyong.com/maven/how-to-add-oracle-jdbc-driver-in-your-maven-local-repository/ -->
				<groupId>com.oracle</groupId>
				<artifactId>ojdbc7</artifactId>
				<version>4.1.3</version>
			</dependency>
		</dependencies>
	</plugin>
</plugins>
</pluginManagement>
</build>
</project>

Running the listLocks Maven goal

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

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

mvn liquibase:listLocks

When successful, the listLocks Maven goal produces the following output when there is no lock on the table:

[INFO] Executing on Database: jdbc:oracle:thin:@support.datical.net:1521:ORCL
[INFO] SELECT MD5SUM FROM DATABASECHANGELOG WHERE MD5SUM IS NOT NULL AND ROWNUM=1
[INFO] SELECT COUNT(*) FROM DATABASECHANGELOGLOCK
[INFO] SELECT COUNT(*) FROM DATABASECHANGELOGLOCK
[INFO] SELECT ID,LOCKED,LOCKGRANTED,LOCKEDBY FROM DATABASECHANGELOGLOCK WHERE ID=1 FOR UPDATE
Database change log locks for MVN_UAT@jdbc:oracle:thin:@support.datical.net:1521:ORCL
- No locks

When there is a lock on the table, the listLocks Maven goal produces the following output:

code Database change log locks for db2inst1@jdbc:db2://localhost:50000/sample2
- 2605:6000:101c:686:486:f4ae:82fe:3c99%en0 (2605:6000:101c:686:486:f4ae:82fe:3c99%en0) at Jul 6, 2020, 4:45:38 PM
Liquibase command 'listlocks' was executed successfully.

listLocks Optional Maven Configuration Properties

Property Definition
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.clearCheckSums [boolean] A flag that forces checksums to be cleared from the DATABASECHANGELOG table. Default value is: false.
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 [boolean] Deprecated. Use an empty or null value for the password instead. Default value is: false.
expressionVariables A map-based collection of changelog properties to apply.
expressionVars 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.liquibaseProLicenseKey Specifies your Liquibase Pro license key.
liquibase.logging Controls the amount of logging detail Liquibase outputs when executing. The values can be "DEBUG", "INFO", "WARNING", "SEVERE", or "OFF". The value is not case sensitive. Default value is: INFO.
liquibase.outputDefaultCatalog [boolean] Specifies whether to ignore the catalog/database name. Default value is: false.
liquibase.outputDefaultSchema [boolean] Specifies whether to ignore the schema name. Default value is: false.
liquibase.outputFileEncoding A flag which indicates you want to set the character encoding of the output file during the updateSQL phase.
liquibase.password Specifies the database password for database connection.
liquibase.promptOnNonLocalDatabase [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 you want to use to configure Liquibase.
liquibase.propertyFileWillOverride [boolean] A flag which indicates 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 parameter 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.url Specifies the database URL you want to use to execute Liquibase.
liquibase.username Specifies the database username for database connection.
liquibase.verbose [boolean] Controls the amount of output detail when you call the plugin. Default value is: false.