Package liquibase.change

Annotation Type DatabaseChangeProperty

@Retention(RUNTIME)
@Target(METHOD)
@Repeatable(DatabaseChangeProperties.class)
public @interface DatabaseChangeProperty

Annotation used by AbstractChange to declare ChangeParameterMetaData information. The annotation should be placed on the read method. This annotation should not be checked for outside AbstractChange, if any code is trying to determine the metadata provided by this annotation, it should get it from ChangeFactory.getChangeMetaData(Change)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	alternatePropertyNames
String	description	Value to put into ChangeParameterMetaData.getDescription()
String	exampleValue	Value to put into ChangeParameterMetaData.getExampleValue(Database)
boolean	isChangeProperty	If false, this field or method will not be included in ChangeParameterMetaData
String	mustEqualExisting	Value to put into ChangeParameterMetaData.getMustEqualExisting()
String[]	requiredForDatabase	Value to put into ChangeParameterMetaData.getRequiredForDatabase()
LiquibaseSerializable.SerializationType	serializationType	Format to use when serializing this Change via a ChangeLogSerializer.
String	since	Value to put into liquibase.change.ChangeParameterMetaData#getSince()
String[]	supportsDatabase	Value to put into ChangeParameterMetaData.getSupportedDatabases()
ChecksumVersion[]	version	The checksum version that this annotation applies to.

Element Details

description

String description

Value to put into ChangeParameterMetaData.getDescription()

Default:

""

exampleValue

String exampleValue

Value to put into ChangeParameterMetaData.getExampleValue(Database)

Default:

""

since

String since

Value to put into liquibase.change.ChangeParameterMetaData#getSince()

Default:

""

isChangeProperty

boolean isChangeProperty

If false, this field or method will not be included in ChangeParameterMetaData

Default:

true

requiredForDatabase

String[] requiredForDatabase

Value to put into ChangeParameterMetaData.getRequiredForDatabase()

Default:

{"COMPUTE"}

supportsDatabase

String[] supportsDatabase

Value to put into ChangeParameterMetaData.getSupportedDatabases()

Default:

{"COMPUTE"}

mustEqualExisting

String mustEqualExisting

Value to put into ChangeParameterMetaData.getMustEqualExisting()

Default:

""

serializationType

LiquibaseSerializable.SerializationType serializationType

Format to use when serializing this Change via a ChangeLogSerializer.

Default:

NAMED_FIELD

version

ChecksumVersion[] version

The checksum version that this annotation applies to. This can be omitted, and it is assumed that the annotation applies to all checksum versions. If a version is applied to some, but not all of the DatabaseChangeProperty annotations on a particular property, the most specific matching annotation is selected. For example, if a particular property has:

Default:

{}

alternatePropertyNames

String[] alternatePropertyNames

Default:

{}