mark-next-changeset-ran

The mark-next-changeset-ran command marks the next change you apply as executed in your database.

Uses

The mark-next-changeset-ran command is typically used when you have made a change manually, and the deployment is failing. Here is a use case that shows the whole process in more detail:

  • You have a changelog with a specific changeset and want to create a table in your database, and then apply your changes manually without using Liquibase. In this case, there will be no record of this change in the DATABASECHANGELOG table.
  • Then you decide to deploy the same changeset by using the update command, Liquibase checks the DATABASECHANGELOG table to see if there is such a changeset. Since there is no record of it, Liquibase tries to create a table, but as it already exists, you receive an error.
  • As a result, Liquibase stops deployment at that specific changeset without executing it.
  • Running the mark-next-changeset-ran adds that changeset in the changelog as a record even though the table is already created. The command detects that the changeset was deployed.

Additionally, the best practice is to run the mark-next-changeset-ran-sql helper command to inspect the mark-next-changeset-ran SQL, so you can correct any issues that may arise before running the command.

Syntax

To run the mark-next-changeset-ran 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 mark-next-changeset-ran command:

liquibase mark-next-changeset-ran --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.

Attribute Definition Requirement
--changelog-file

The root changelog

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

Output

Liquibase Community 4.9.1 by Liquibase
Liquibase command 'mark-next-changeset-ran' was executed successfully.

Related links

  • Ant markNextChangesetRan