Maven listLocks

listLocks returns the hostname, IP address, and the timestamp the Liquibase lock record was added to the DATABASECHANGELOGLOCK table.

Uses

listLocks is typically used when an error occurs during a database deployment. The error might indicate that there is a lock record in the DATABASECHANGELOGLOCK table by another user that is preventing Liquibase from applying 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 record was granted to the DATABASECHANGELOGLOCK table and determines the connections to the DATABASECHANGELOGLOCK table based on the database URL.

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.

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:

[INFO] Executing on Database: jdbc:oracle:thin:@localhost:1521/ORCL
Database change log locks for MVN@jdbc:oracle:thin:@localhost:1521/ORCL
- 2605:6000:101c:686:486:f4ae:82fe:3c99%en0 (2605:6000:101c:686:486:f4ae:82fe:3c99%en0) at Dec 30, 2020 3:21:05 PM
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.722 s
[INFO] Finished at: 2020-12-30T09:22:04-06:00
[INFO] ------------------------------------------------------------------------

listLocks optional Maven configuration attributes

Attribute Definition
liquibase.changelogCatalogName Specifies the catalog Liquibase will use to create your changelog tables.
liquibase.changelogSchemaName Specifies the schema that Liquibase uses to create your changelog tables.
liquibase.clearCheckSums [boolean] Clears checksums 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 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 that obtains the Liquibase file and changelog files. Default value is true.
liquibase.includeTestOutputDirectory [boolean] Includes the Maven test output directory in the class loader that obtains the Liquibase properties file and changelog files. Default value is true.
liquibase.liquibaseProLicenseKey Specifies your Liquibase Pro license key.
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 database connection.
liquibase.promptOnNonLocalDatabase [boolean] [Deprecated] 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] Values in the Liquibase properties file override settings provided by a Maven plugin. 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.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.