generated-changeset-ids-contains-description

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

For more information, see Working with Command Parameters. You can set this parameter in the following ways:

Option Syntax
Liquibase properties file
liquibase.generatedChangesetIdsContainsDescription: <true|false>
Global CLI parameter
liquibase
 --generated-changeset-ids-contains-description=<true|false> generate-changelog
 --changelog-file=mychangelog.xml

JVM system property

JAVA_OPTS Environment Variable

macOS/Linux:
JAVA_OPTS=-Dliquibase.generatedChangesetIdsContainsDescription=<true|false>
Windows:
set JAVA_OPTS=-Dliquibase.generatedChangesetIdsContainsDescription=<true|false>
Liquibase Environment Variables macOS/Linux:
LIQUIBASE_GENERATED_CHANGESET_IDS_CONTAINS_DESCRIPTION=<true|false>
Windows:
set LIQUIBASE_GENERATED_CHANGESET_IDS_CONTAINS_DESCRIPTION=<true|false>

Note: These commands only apply to the current shell. To set permanent environment variables, see Liquibase Environment Variables.

Output

If you use the generate-changelog command with generated-changeset-ids-contains-description set to true, the output looks like:

<?xml version="1.1" encoding="UTF-8" standalone="no"?>
<databaseChangeLog
	xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
	xmlns:pro="http://www.liquibase.org/xml/ns/pro"
	xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
		http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd
		http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd
		http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd">
	<changeSet author="adrian (generated)" id="l14y-1 (createTable tableName=TEST_TABLE)">
		<createTable tableName="TEST_TABLE">
			<column name="TEST_COLUMN" type="VARCHAR(2147483647)"/>
			<column name="TEST_ID" type="INT">
				<constraints nullable="false" primaryKey="true" primaryKeyName="PK_TEST_TABLE"/>
			</column>
		</createTable>
	</changeSet>
</databaseChangeLog>

Related links