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 parameters
CLI
Attribute |
Definition |
Requirement |
--changelog-file=<string>
|
The root changelog
|
Required
|
--url=<string>
|
The JDBC database connection URL. See Using JDBC URL in Liquibase.
|
Required
|
--context-filter=<string>
|
Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run.
Note: If you use Liquibase 4.23.0 or earlier, use the syntax --contexts instead of --context-filter .
|
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 |
--label-filter=<string>
|
Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.
|
Optional |
--password=<string>
|
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=<string>
|
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 |
Flow
Attribute |
Definition |
Requirement |
cmdArgs: { changelog-file: "<string>" }
|
The root changelog
|
Required
|
cmdArgs: { url: "<string>" }
|
The JDBC database connection URL. See Using JDBC URL in Liquibase.
|
Required
|
cmdArgs: { context-filter: "<string>" }
|
Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run.
Note: If you use Liquibase 4.23.0 or earlier, use the syntax --contexts instead of --context-filter .
|
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: { label-filter: "<string>" }
|
Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.
|
Optional |
cmdArgs: { password: "<string>" }
|
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 |
cmdArgs: { username: "<string>" }
|
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 |
liquibase.properties
Attribute |
Definition |
Requirement |
liquibase.command.changelogFile: <string>
liquibase.command.markNextChangesetRan.changelogFile: <string>
|
The root changelog
|
Required
|
liquibase.command.url: <string>
liquibase.command.markNextChangesetRan.url: <string>
|
The JDBC database connection URL. See Using JDBC URL in Liquibase.
|
Required
|
liquibase.command.contextFilter: <string>
liquibase.command.markNextChangesetRan.contextFilter: <string>
|
Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run.
Note: If you use Liquibase 4.23.0 or earlier, use the syntax --contexts instead of --context-filter .
|
Optional |
liquibase.command.defaultCatalogName: <string>
liquibase.command.markNextChangesetRan.defaultCatalogName: <string>
|
Name of the default catalog to use for the database
connection
|
Optional |
liquibase.command.defaultSchemaName: <string>
liquibase.command.markNextChangesetRan.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.markNextChangesetRan.driver: <string>
|
The JDBC driver class
|
Optional |
liquibase.command.driverPropertiesFile: <string>
liquibase.command.markNextChangesetRan.driverPropertiesFile: <string>
|
The JDBC driver properties file
|
Optional |
liquibase.command.labelFilter: <string>
liquibase.command.markNextChangesetRan.labelFilter: <string>
|
Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.
|
Optional |
liquibase.command.password: <string>
liquibase.command.markNextChangesetRan.password: <string>
|
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 |
liquibase.command.username: <string>
liquibase.command.markNextChangesetRan.username: <string>
|
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 |
JAVA_OPTS
Attribute |
Definition |
Requirement |
JAVA_OPTS=-Dliquibase.command.changelogFile=<string>
JAVA_OPTS=-Dliquibase.command.markNextChangesetRan.changelogFile=<string>
|
The root changelog
|
Required
|
JAVA_OPTS=-Dliquibase.command.url=<string>
JAVA_OPTS=-Dliquibase.command.markNextChangesetRan.url=<string>
|
The JDBC database connection URL. See Using JDBC URL in Liquibase.
|
Required
|
JAVA_OPTS=-Dliquibase.command.contextFilter=<string>
JAVA_OPTS=-Dliquibase.command.markNextChangesetRan.contextFilter=<string>
|
Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run.
Note: If you use Liquibase 4.23.0 or earlier, use the syntax --contexts instead of --context-filter .
|
Optional |
JAVA_OPTS=-Dliquibase.command.defaultCatalogName=<string>
JAVA_OPTS=-Dliquibase.command.markNextChangesetRan.defaultCatalogName=<string>
|
Name of the default catalog to use for the database
connection
|
Optional |
JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>
JAVA_OPTS=-Dliquibase.command.markNextChangesetRan.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.markNextChangesetRan.driver=<string>
|
The JDBC driver class
|
Optional |
JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>
JAVA_OPTS=-Dliquibase.command.markNextChangesetRan.driverPropertiesFile=<string>
|
The JDBC driver properties file
|
Optional |
JAVA_OPTS=-Dliquibase.command.labelFilter=<string>
JAVA_OPTS=-Dliquibase.command.markNextChangesetRan.labelFilter=<string>
|
Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.
|
Optional |
JAVA_OPTS=-Dliquibase.command.password=<string>
JAVA_OPTS=-Dliquibase.command.markNextChangesetRan.password=<string>
|
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 |
JAVA_OPTS=-Dliquibase.command.username=<string>
JAVA_OPTS=-Dliquibase.command.markNextChangesetRan.username=<string>
|
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 |
Environment variable
Attribute |
Definition |
Requirement |
LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>
LIQUIBASE_COMMAND_MARK_NEXT_CHANGESET_RAN_CHANGELOG_FILE=<string>
|
The root changelog
|
Required
|
LIQUIBASE_COMMAND_URL=<string>
LIQUIBASE_COMMAND_MARK_NEXT_CHANGESET_RAN_URL=<string>
|
The JDBC database connection URL. See Using JDBC URL in Liquibase.
|
Required
|
LIQUIBASE_COMMAND_CONTEXT_FILTER=<string>
LIQUIBASE_COMMAND_MARK_NEXT_CHANGESET_RAN_CONTEXT_FILTER=<string>
|
Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run.
Note: If you use Liquibase 4.23.0 or earlier, use the syntax --contexts instead of --context-filter .
|
Optional |
LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>
LIQUIBASE_COMMAND_MARK_NEXT_CHANGESET_RAN_DEFAULT_CATALOG_NAME=<string>
|
Name of the default catalog to use for the database
connection
|
Optional |
LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>
LIQUIBASE_COMMAND_MARK_NEXT_CHANGESET_RAN_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_MARK_NEXT_CHANGESET_RAN_DRIVER=<string>
|
The JDBC driver class
|
Optional |
LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>
LIQUIBASE_COMMAND_MARK_NEXT_CHANGESET_RAN_DRIVER_PROPERTIES_FILE=<string>
|
The JDBC driver properties file
|
Optional |
LIQUIBASE_COMMAND_LABEL_FILTER=<string>
LIQUIBASE_COMMAND_MARK_NEXT_CHANGESET_RAN_LABEL_FILTER=<string>
|
Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.
|
Optional |
LIQUIBASE_COMMAND_PASSWORD=<string>
LIQUIBASE_COMMAND_MARK_NEXT_CHANGESET_RAN_PASSWORD=<string>
|
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 |
LIQUIBASE_COMMAND_USERNAME=<string>
LIQUIBASE_COMMAND_MARK_NEXT_CHANGESET_RAN_USERNAME=<string>
|
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