• Reference
  • Version · 6.0
  • Change Automation Reference

generated-changeset-ids-contains-description

Last updated: August 12, 2026

The generated-changeset-ids-contains-description global parameter is a Boolean that determines whether Liquibase includes changeset descriptions in changelogs generated with the generate-changelog command in addition to changeset IDs. The default value is false.

Uses

If you set generated-changeset-ids-contains-description to true and run the generate-changelog command, Liquibase includes a human-readable description of each changeset as part of the value of the id attribute in the changelog it generates. Otherwise, it only includes the changeset ID, which is made of a randomly generated value followed by the current count of changesets in the changelog.

Note: Liquibase uses the id attribute to give each change a unique identifier, not to specify the order changes are run. It can be an integer or a string.

Syntax

You can set this parameter in the following ways:

Option

Syntax

Liquibase properties file (defaults file)

liquibase.generatedChangesetIdsContainsDescription: <true|false>

Global flow file argument

globalArgs: { generated-changeset-ids-contains-description: "<true|false>" }

Global CLI parameter

liquibase --generated-changeset-ids-contains-description=<true|false> generate-changelog --changelog-file=example-changelog.xml

JVM system property (JAVA_OPTS environment variable)

Unix:

JAVA_OPTS=-Dliquibase.generatedChangesetIdsContainsDescription=<true|false>

Windows:

JAVA_OPTS=-D"liquibase.generatedChangesetIdsContainsDescription"=<true|false>

Liquibase environment variable

LIQUIBASE_GENERATED_CHANGESET_IDS_CONTAINS_DESCRIPTION=<true|false>

Previousgenerate-inline-sqlNextglobal-end-delimiter