update

The update command deploys any changes that are in the changelog file and that have not been deployed to your database yet.

Uses

The update command is typically used to apply database changes that are specified in the changelog file to your database.

When you run the update command, Liquibase sequentially reads changesets in the changelog file, then it compares the unique identifiers of id, author, and path to filename to the values stored in the DATABASECHANGELOG table.

  • If the unique identifiers do not exist, Liquibase will apply the changeset to the database.
  • If the unique identifiers exist, the MD5Sum of the changeset is compared to the one in the database.
  • If they are different, Liquibase will produce an error message that someone has changed it unexpectedly. However, if the status of the runOnChange or runAlways changeset attribute is set to TRUE, Liquibase will re-apply the changeset.

Running the update command

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

liquibase --changelog-file=dbchangelog.xml update

Note: Enter the name of the changelog you want to use in place of dbchangelog.xml.

update global attributes

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
--changelog-file

The root changelog

Required
--url

The JDBC database connection URL

Required
--username*

The database username

Required
--password*

The database password

Required
--liquibaseSchemaName

Specifies in what schema the LiquibaseDATABASECHANGELOG and DATABASECHANGELOGLOCK tables will be managed

Optional
--liquibaseCatalogName

For MSSQL only: Specifies in what catalog the LiquibaseDATABASECHANGELOG and DATABASECHANGELOGLOCK tables will be managed

Optional

Note: The username and password attributes are not required for connections and systems which use alternate means of authentication.

update command attributes

Attributes Definition Requirement
--labels

Tags you can add to changesets to determine which changesets in the changelog to evaluate based on their labels

Optional
--contexts

Expressions you can add to changesets to determine which changesets in the changelog to evaluate based on their contexts

Optional
--rollback-on-error=[boolean]

Liquibase Pro only. If any changeset in a deployment fails, rollback-on-error stops the update operation and rolls back all changesets you just deployed. Default value: false.

Note: A changeset marked fail-on-error=false does not trigger as an error, so rollback-on-error will not occur. Additionally, if a changeset is not auto-rollback compliant or does not have a rollback script, then rollback-on-error does not occur for any changeset. Read more: Auto Rollback.

Optional