com.github.cloudyrock.mongock

Annotation Type ChangeSet

Deprecated.

@Deprecated
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface ChangeSet

From Mongock version 5, this annotation is deprecated and shouldn't be used (remains in code for backwards compatibility). Please follow one of the recommended approaches depending on your use case: - For existing changeLogs/changeSets created prior version 5: leave them untouched (use with the deprecated annotation). - For new changeLogs/changeSets created from version 5: use ChangeUnit annotated methods (@Execution / @RollbackExecution). For more details please visit the migration guide.

See Also:

ChangeLog

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	author Deprecated. Author of the changeset.
String	id Deprecated. Unique ID of the changeset.
String	order Deprecated. Sequence that provide correct order for changeSets.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	failFast Deprecated. If true, will make the entire migration to break if the changeSet produce an exception or the validation doesn't success.
boolean	runAlways Deprecated. Executes the change set on every Mongock's execution, even if it has been run before.
String	systemVersion Deprecated. Specifies the software systemVersion on which the ChangeSet is to be applied.

Element Detail

author

public abstract String author

Deprecated.

Author of the changeset. Obligatory

Returns:

author

id

public abstract String id

Deprecated.

Unique ID of the changeset. Obligatory

Returns:

unique id

order

public abstract String order

Deprecated.

Sequence that provide correct order for changeSets. Sorted alphabetically, ascending. Obligatory.

Returns:

ordering

runAlways

public abstract boolean runAlways

Deprecated.

Executes the change set on every Mongock's execution, even if it has been run before. Optional (default is false)

Returns:

should run always?

Default:

false

systemVersion

public abstract String systemVersion

Deprecated.

Specifies the software systemVersion on which the ChangeSet is to be applied. Optional (default is 0 and means all)

Returns:

systemVersion

Default:

"0"

failFast

public abstract boolean failFast

Deprecated.

If true, will make the entire migration to break if the changeSet produce an exception or the validation doesn't success. Migration will continue otherwise.

Returns:

failFast

Default:

true