history

The history command lists all deployed changesets and their deploymentIds. The history command does not modify the database.

Uses

The history command is typically used when you want to inspect a particular group of changes to ensure that they have been applied to the database.

Syntax

To run the history command, specify the driver, classpath, and URL in the Liquibase properties file. For more information, see Create and Configure a liquibase.properties File. You can also specify these properties in your command line.

Then run the history command:

liquibase history

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.

Attribute Definition Requirement
--output-file

File path to where the command output will be written. If not specified, output goes to STDOUT. See --output-file.

Optional

Command arguments

Attribute Definition Requirement
--url

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

Required
--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
--format

Specifies the format of the output. TEXT displays the output as plain text. TABULAR groups changesets by deployment ID and displays other information (timestamp, path, author, ID, and checksum) in individual table cells. Default: TABULAR.

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.

Related links