Reference
Version · 6.0
Change Automation Reference

list-locks

Last updated: August 12, 2026

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

Uses

list-locks 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.

list-locks 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.

Syntax

To run the list-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 list-locks command:

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

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.

Command parameters

Attribute	Definition	Requirement
`--url=<string>`	The JDBC database connection URL.	Required
`--changelog-file=<string>`	The root changelog	Optional
`--default-catalog-name=<string>`	Name of the default catalog to use for the database connection	Optional
`--default-schema-name=<string>`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`--driver=<string>`	The JDBC driver class	Optional
`--driver-properties-file=<string>`	The JDBC driver properties file	Optional
`--password=<string>`	Password to connect to the target database.	Optional
`--username=<string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirement
`cmdArgs: { url: "<string>" }`	The JDBC database connection URL.	Required
`cmdArgs: { changelog-file: "<string>" }`	The root changelog	Optional
`cmdArgs: { default-catalog-name: "<string>" }`	Name of the default catalog to use for the database connection	Optional
`cmdArgs: { default-schema-name: "<string>" }`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`cmdArgs: { driver: "<string>" }`	The JDBC driver class	Optional
`cmdArgs: { driver-properties-file: "<string>" }`	The JDBC driver properties file	Optional
`cmdArgs: { password: "<string>" }`	Password to connect to the target database.	Optional
`cmdArgs: { username: "<string>" }`	Username to connect to the target database.	Optional

Attribute	Definition	Requirement
`liquibase.command.url: <string>` `liquibase.command.listLocks.url: <string>`	The JDBC database connection URL.	Required
`liquibase.command.changelogFile: <string>` `liquibase.command.listLocks.changelogFile: <string>`	The root changelog	Optional
`liquibase.command.defaultCatalogName: <string>` `liquibase.command.listLocks.defaultCatalogName: <string>`	Name of the default catalog to use for the database connection	Optional
`liquibase.command.defaultSchemaName: <string>` `liquibase.command.listLocks.defaultSchemaName: <string>`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`liquibase.command.driver: <string>` `liquibase.command.listLocks.driver: <string>`	The JDBC driver class	Optional
`liquibase.command.driverPropertiesFile: <string>` `liquibase.command.listLocks.driverPropertiesFile: <string>`	The JDBC driver properties file	Optional
`liquibase.command.password: <string>` `liquibase.command.listLocks.password: <string>`	Password to connect to the target database.	Optional
`liquibase.command.username: <string>` `liquibase.command.listLocks.username: <string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirement
`JAVA_OPTS=-Dliquibase.command.url=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.url=<string>`	The JDBC database connection URL.	Required
`JAVA_OPTS=-Dliquibase.command.changelogFile=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.changelogFile=<string>`	The root changelog	Optional
`JAVA_OPTS=-Dliquibase.command.defaultCatalogName=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.defaultCatalogName=<string>`	Name of the default catalog to use for the database connection	Optional
`JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.defaultSchemaName=<string>`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`JAVA_OPTS=-Dliquibase.command.driver=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.driver=<string>`	The JDBC driver class	Optional
`JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.driverPropertiesFile=<string>`	The JDBC driver properties file	Optional
`JAVA_OPTS=-Dliquibase.command.password=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.password=<string>`	Password to connect to the target database.	Optional
`JAVA_OPTS=-Dliquibase.command.username=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.username=<string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirement
`LIQUIBASE_COMMAND_URL=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_URL=<string>`	The JDBC database connection URL.	Required
`LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_CHANGELOG_FILE=<string>`	The root changelog	Optional
`LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_DEFAULT_CATALOG_NAME=<string>`	Name of the default catalog to use for the database connection	Optional
`LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_DEFAULT_SCHEMA_NAME=<string>`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`LIQUIBASE_COMMAND_DRIVER=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_DRIVER=<string>`	The JDBC driver class	Optional
`LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_DRIVER_PROPERTIES_FILE=<string>`	The JDBC driver properties file	Optional
`LIQUIBASE_COMMAND_PASSWORD=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_PASSWORD=<string>`	Password to connect to the target database.	Optional
`LIQUIBASE_COMMAND_USERNAME=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_USERNAME=<string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirement
`--url=<string>`	The JDBC database connection URL.	Required
`--changelog-file=<string>`	The root changelog	Optional
`--default-catalog-name=<string>`	Name of the default catalog to use for the database connection	Optional
`--default-schema-name=<string>`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`--driver=<string>`	The JDBC driver class	Optional
`--driver-properties-file=<string>`	The JDBC driver properties file	Optional
`--password=<string>`	Password to connect to the target database.	Optional
`--username=<string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirement
`cmdArgs: { url: "<string>" }`	The JDBC database connection URL.	Required
`cmdArgs: { changelog-file: "<string>" }`	The root changelog	Optional
`cmdArgs: { default-catalog-name: "<string>" }`	Name of the default catalog to use for the database connection	Optional
`cmdArgs: { default-schema-name: "<string>" }`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`cmdArgs: { driver: "<string>" }`	The JDBC driver class	Optional
`cmdArgs: { driver-properties-file: "<string>" }`	The JDBC driver properties file	Optional
`cmdArgs: { password: "<string>" }`	Password to connect to the target database.	Optional
`cmdArgs: { username: "<string>" }`	Username to connect to the target database.	Optional

Attribute	Definition	Requirement
`liquibase.command.url: <string>` `liquibase.command.listLocks.url: <string>`	The JDBC database connection URL.	Required
`liquibase.command.changelogFile: <string>` `liquibase.command.listLocks.changelogFile: <string>`	The root changelog	Optional
`liquibase.command.defaultCatalogName: <string>` `liquibase.command.listLocks.defaultCatalogName: <string>`	Name of the default catalog to use for the database connection	Optional
`liquibase.command.defaultSchemaName: <string>` `liquibase.command.listLocks.defaultSchemaName: <string>`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`liquibase.command.driver: <string>` `liquibase.command.listLocks.driver: <string>`	The JDBC driver class	Optional
`liquibase.command.driverPropertiesFile: <string>` `liquibase.command.listLocks.driverPropertiesFile: <string>`	The JDBC driver properties file	Optional
`liquibase.command.password: <string>` `liquibase.command.listLocks.password: <string>`	Password to connect to the target database.	Optional
`liquibase.command.username: <string>` `liquibase.command.listLocks.username: <string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirement
`JAVA_OPTS=-Dliquibase.command.url=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.url=<string>`	The JDBC database connection URL.	Required
`JAVA_OPTS=-Dliquibase.command.changelogFile=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.changelogFile=<string>`	The root changelog	Optional
`JAVA_OPTS=-Dliquibase.command.defaultCatalogName=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.defaultCatalogName=<string>`	Name of the default catalog to use for the database connection	Optional
`JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.defaultSchemaName=<string>`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`JAVA_OPTS=-Dliquibase.command.driver=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.driver=<string>`	The JDBC driver class	Optional
`JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.driverPropertiesFile=<string>`	The JDBC driver properties file	Optional
`JAVA_OPTS=-Dliquibase.command.password=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.password=<string>`	Password to connect to the target database.	Optional
`JAVA_OPTS=-Dliquibase.command.username=<string>` `JAVA_OPTS=-Dliquibase.command.listLocks.username=<string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirement
`LIQUIBASE_COMMAND_URL=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_URL=<string>`	The JDBC database connection URL.	Required
`LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_CHANGELOG_FILE=<string>`	The root changelog	Optional
`LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_DEFAULT_CATALOG_NAME=<string>`	Name of the default catalog to use for the database connection	Optional
`LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_DEFAULT_SCHEMA_NAME=<string>`	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`. Note: In the properties file and `JAVA_OPTS` only: in 4.18.0 and earlier, specify this parameter using the syntax `defaultSchemaName`. In 4.19.0 and later, use the syntax `liquibase.command.defaultSchemaName`. Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set `--preserve-schema-case` to `true`. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a `DatabaseException` error if you specify a mixed-case value of `defaultSchemaName`. In 4.23.0 and later, the Liquibase validator accepts any casing.	Optional
`LIQUIBASE_COMMAND_DRIVER=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_DRIVER=<string>`	The JDBC driver class	Optional
`LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_DRIVER_PROPERTIES_FILE=<string>`	The JDBC driver properties file	Optional
`LIQUIBASE_COMMAND_PASSWORD=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_PASSWORD=<string>`	Password to connect to the target database.	Optional
`LIQUIBASE_COMMAND_USERNAME=<string>` `LIQUIBASE_COMMAND_LIST_LOCKS_USERNAME=<string>`	Username to connect to the target database.	Optional

The list-locks command produces the following output when there is no lock on the table:

Liquibase Community 4.9.1 by Liquibase Database change log locks for DBUSER@jdbc:h2:tcp://localhost:9090/mem:dev - No locks Liquibase command 'list-locks' was executed successfully.

The list-locks command produces the following output when there is a lock on the table:

Liquibase Community 4.9.1 by Liquibase Database change log locks for DBUSER@jdbc:h2:tcp://localhost:9090/mem:dev - 2605:6000:101c:686:486:f4ae:82fe:3c99%en0 (2605:6000:101c:686:486:f4ae:82fe:3c99%en0) at May 6, 2022, 9:04:38 PM Liquibase command 'list-locks' was executed successfully.

PreviousLicense status NextMark-next-changeset-ran

list-locks

Uses

Syntax

Command parameters

CLI

Flow

liquibase.properties

JAVA OPTS

Environment variable