Reference
Version · 5.1
Reference guide

changelog-sync

Last updated: August 21, 2026

The changelog-sync command marks all undeployed changes in your changelog as executed in your database.

Uses

The changelog-sync command is typically used when you want to baseline a new database environment.

An example use case for the changelog-sync command is when you have a DEV environment with a set of objects used only in DEV, and you want to use the same changelog to manage a new TEST environment.

The TEST environment does not have or need those DEV-only objects. To avoid deploying the DEV-only objects, you run the changelog-sync command to mark those changes as executed in the DATABASECHANGELOG which tells Liquibase to treat these databases as equivalent.

You can also use the changelog-sync command to mark a change as executed if the object associated with the change was created manually on the database. By marking the changeset as executed, it prevents the next Liquibase update from failing as it tries to create an object that already exists.

Syntax

To run the changelog-sync command, specify the driver, classpath, and URL in Liquibase properties file. You can also specify these properties in your command line.

Then run the changelog-sync command:

liquibase changelog-sync --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	Requirements
`--changelog-file=<string>`	The root changelog	Required
`--url=<string>`	The JDBC database connection URL.	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.	Optional
`--username=<string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirements
`cmdArgs: { changelog-file: "<string>" }`	The root changelog	Required
`cmdArgs: { url: "<string>" }`	The JDBC database connection URL.	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.	Optional
`cmdArgs: { username: "<string>" }`	Username to connect to the target database.	Optional

Attribute	Definition	Requirements
`liquibase.command.changelogFile: <string>` `liquibase.command.changelogSync.changelogFile: <string>`	The root changelog	Required
`liquibase.command.url: <string>` `liquibase.command.changelogSync.url: <string>`	The JDBC database connection URL.	Required
`liquibase.command.contextFilter: <string>` `liquibase.command.changelogSync.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.changelogSync.defaultCatalogName: <string>`	Name of the default catalog to use for the database connection	Optional
`liquibase.command.defaultSchemaName: <string>` `liquibase.command.changelogSync.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.changelogSync.driver: <string>`	The JDBC driver class	Optional
`liquibase.command.driverPropertiesFile: <string>` `liquibase.command.changelogSync.driverPropertiesFile: <string>`	The JDBC driver properties file	Optional
`liquibase.command.labelFilter: <string>` `liquibase.command.changelogSync.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.changelogSync.password: <string>`	Password to connect to the target database.	Optional
`liquibase.command.username: <string>` `liquibase.command.changelogSync.username: <string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirements
`JAVA_OPTS=-Dliquibase.command.changelogFile=<string>` `JAVA_OPTS=-Dliquibase.command.changelogSync.changelogFile=<string>`	The root changelog	Required
`JAVA_OPTS=-Dliquibase.command.url=<string>` `JAVA_OPTS=-Dliquibase.command.changelogSync.url=<string>`	The JDBC database connection URL.	Required
`JAVA_OPTS=-Dliquibase.command.contextFilter=<string>` `JAVA_OPTS=-Dliquibase.command.changelogSync.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.changelogSync.defaultCatalogName=<string>`	Name of the default catalog to use for the database connection	Optional
`JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>` `JAVA_OPTS=-Dliquibase.command.changelogSync.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.changelogSync.driver=<string>`	The JDBC driver class	Optional
`JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.changelogSync.driverPropertiesFile=<string>`	The JDBC driver properties file	Optional
`JAVA_OPTS=-Dliquibase.command.labelFilter=<string>` `JAVA_OPTS=-Dliquibase.command.changelogSync.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.changelogSync.password=<string>`	Password to connect to the target database.	Optional
`JAVA_OPTS=-Dliquibase.command.username=<string>` `JAVA_OPTS=-Dliquibase.command.changelogSync.username=<string>`	Username to connect to the target database.	Optional

Attribute	Definition	Requirements
`LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>` `LIQUIBASE_COMMAND_CHANGELOG_SYNC_CHANGELOG_FILE=<string>`	The root changelog	Required
`LIQUIBASE_COMMAND_URL=<string>` `LIQUIBASE_COMMAND_CHANGELOG_SYNC_URL=<string>`	The JDBC database connection URL.	Required
`LIQUIBASE_COMMAND_CONTEXT_FILTER=<string>` `LIQUIBASE_COMMAND_CHANGELOG_SYNC_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_CHANGELOG_SYNC_DEFAULT_CATALOG_NAME=<string>`	Name of the default catalog to use for the database connection	Optional
`LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>` `LIQUIBASE_COMMAND_CHANGELOG_SYNC_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_CHANGELOG_SYNC_DRIVER=<string>`	The JDBC driver class	Optional
`LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_CHANGELOG_SYNC_DRIVER_PROPERTIES_FILE=<string>`	The JDBC driver properties file	Optional
`LIQUIBASE_COMMAND_LABEL_FILTER=<string>` `LIQUIBASE_COMMAND_CHANGELOG_SYNC_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_CHANGELOG_SYNC_PASSWORD=<string>`	Password to connect to the target database.	Optional
`LIQUIBASE_COMMAND_USERNAME=<string>` `LIQUIBASE_COMMAND_CHANGELOG_SYNC_USERNAME=<string>`	Username to connect to the target database.	Optional

Output

When successful, the changelog-sync command produces the following output:

Liquibase Version: 4.9.1 Liquibase command 'changelog-sync' was executed successfully.

Previouscalculate-checksum Nextchangelog-sync-sql

changelog-sync

Uses

Syntax

Command parameters

CLI

Flow

liquibase.properties

JAVA OPTS

Environment variable

Output