release-locks

release-locks removes the specific Liquibase lock record from the DATABASECHANGELOGLOCK table in the needed database.

Uses

release-locks is typically used when there is an interruption with the Liquibase process during deployment resulting from the DATABASECHANGELOGLOCK table being in a locked state.

Syntax

To run the release-locks command, specify the driver, classpath, and URL in the Liquibase properties file. You can also specify these properties in your command line.

Then run the release-locks command:

liquibase release-locks --changelog-file=example-changelog.xml

Command arguments

Tip: For best results, specify all commands and parameters in the --kebab-case format in the CLI. If your preference is camelCase, it also works in the CLI.

Attributes Definition Requirement
--url

The JDBC database connection URL. See Using JDBC URL in Liquibase.

 Required
--changelog-file

The root changelog

 Optional
--default-catalog-name

Name of the default catalog to use for the database connection

 Optional
--default-schema-name

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.

Tip: In Liquibase v4.23.0+, camelCase for defaultSchemaName works successfully. If you are on an earlier version, camelCase may not work as expected.

Note: The syntax liquibase.command.defaultSchemaName is valid for v4.19.0+. For prior versions, use defaultSchemaName.

 Optional
--driver

The JDBC driver class

 Optional
--driver-properties-file

The JDBC driver properties file

 Optional
--password

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

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

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.

When successful, the release-locks command produces the following output:

Liquibase Community 4.9.1 by Liquibase
Successfully released all database change log locks for 'DBUSER@jdbc:h2:tcp://localhost:9090/mem:dev'
Liquibase command 'release-locks' was executed successfully.

Related links