liquibase.change

Annotation Type DatabaseChangeProperty

@Retention(value=RUNTIME)
 @Target(value=METHOD)
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 and Description
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 ChangeParameterMetaData.getSince()
String[]	supportsDatabase Value to put into ChangeParameterMetaData.getSupportedDatabases()

Element Detail

description

public abstract String description

Value to put into ChangeParameterMetaData.getDescription()

Default:

""

exampleValue

public abstract String exampleValue

Value to put into ChangeParameterMetaData.getExampleValue(Database)

Default:

""

since

public abstract String since

Value to put into ChangeParameterMetaData.getSince()

Default:

""

isChangeProperty

public abstract boolean isChangeProperty

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

Default:

true

requiredForDatabase

public abstract String[] requiredForDatabase

Value to put into ChangeParameterMetaData.getRequiredForDatabase()

Default:

"COMPUTE"

supportsDatabase

public abstract String[] supportsDatabase

Value to put into ChangeParameterMetaData.getSupportedDatabases()

Default:

"COMPUTE"

mustEqualExisting

public abstract String mustEqualExisting

Value to put into ChangeParameterMetaData.getMustEqualExisting()

Default:

""

serializationType

public abstract LiquibaseSerializable.SerializationType serializationType

Format to use when serializing this Change via a ChangeLogSerializer.

Default:

liquibase.serializer.LiquibaseSerializable.SerializationType.NAMED_FIELD