Package liquibase.change
Annotation Type DatabaseChangeProperty
-
@Retention(RUNTIME) @Target(METHOD) @Repeatable(DatabaseChangeProperties.class) public @interface DatabaseChangeProperty
Annotation used byAbstractChange
to declareChangeParameterMetaData
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 fromChangeFactory.getChangeMetaData(Change)
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String[]
alternatePropertyNames
String
description
Value to put intoChangeParameterMetaData.getDescription()
String
exampleValue
Value to put intoChangeParameterMetaData.getExampleValue(Database)
boolean
isChangeProperty
If false, this field or method will not be included inChangeParameterMetaData
String
mustEqualExisting
Value to put intoChangeParameterMetaData.getMustEqualExisting()
String[]
requiredForDatabase
Value to put intoChangeParameterMetaData.getRequiredForDatabase()
LiquibaseSerializable.SerializationType
serializationType
Format to use when serializing this Change via aChangeLogSerializer
.String
since
Value to put intoChangeParameterMetaData.getSince()
String[]
supportsDatabase
Value to put intoChangeParameterMetaData.getSupportedDatabases()
ChecksumVersion[]
version
The checksum version that this annotation applies to.
-
-
-
Element Detail
-
description
String description
Value to put intoChangeParameterMetaData.getDescription()
- Default:
- ""
-
-
-
exampleValue
String exampleValue
Value to put intoChangeParameterMetaData.getExampleValue(Database)
- Default:
- ""
-
-
-
since
String since
Value to put intoChangeParameterMetaData.getSince()
- Default:
- ""
-
-
-
isChangeProperty
boolean isChangeProperty
If false, this field or method will not be included inChangeParameterMetaData
- Default:
- true
-
-
-
requiredForDatabase
String[] requiredForDatabase
Value to put intoChangeParameterMetaData.getRequiredForDatabase()
- Default:
- {"COMPUTE"}
-
-
-
supportsDatabase
String[] supportsDatabase
Value to put intoChangeParameterMetaData.getSupportedDatabases()
- Default:
- {"COMPUTE"}
-
-
-
mustEqualExisting
String mustEqualExisting
Value to put intoChangeParameterMetaData.getMustEqualExisting()
- Default:
- ""
-
-
-
serializationType
LiquibaseSerializable.SerializationType serializationType
Format to use when serializing this Change via aChangeLogSerializer
.- Default:
- liquibase.serializer.LiquibaseSerializable.SerializationType.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 theDatabaseChangeProperty
annotations on a particular property, the most specific matching annotation is selected. For example, if a particular property has:- Default:
- {}
-
-
-
alternatePropertyNames
String[] alternatePropertyNames
- Default:
- {}
-
-