com.github.cloudyrock.mongock

Annotation Type ChangeSet

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

Set of changes to be added to the DB. Many changesets are included in one changelog.

Since:

27/07/2014

See Also:

ChangeLog

Required Element Summary

Required Elements

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

Optional Element Summary

Optional Elements

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

Element Detail

author

public abstract String author

Author of the changeset. Obligatory

Returns:

author

id

public abstract String id

Unique ID of the changeset. Obligatory

Returns:

unique id

order

public abstract String order

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

Returns:

ordering

runAlways

public abstract boolean runAlways

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

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

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