io.flamingock.api.annotations

Annotation Type Change

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface Change

Marks a class as a change that encapsulates a system evolution operation. Each change represents an atomic, versioned modification to your distributed system.

Example usage:

 @Change(id = "create-user-index", order = "2024-11-15-001", author = "john.doe")
 public class CreateUserIndexChange {
     @Apply
     public void createIndex(MongoDatabase db) {
         // Implementation
     }
 }
 

See Also:

Apply, Rollback

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	author Author of this change.
java.lang.String	id Unique identifier for this change.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	transactional Whether this change should run within a transaction if supported by the target system.

Element Detail

id

public abstract java.lang.String id

Unique identifier for this change. Must be globally unique across all changes. Typically, follows a kebab-case naming convention describing the operation.

Returns:

the unique change identifier

author

public abstract java.lang.String author

Author of this change. Required for audit trail and accountability. Typically, an email, username, or team identifier.

Returns:

the change author identifier

transactional

public abstract boolean transactional

Whether this change should run within a transaction if supported by the target system. Set to false for operations that cannot be transactional (e.g., DDL in some databases).

Returns:

true if transactional execution is required, false otherwise

Default:

true