io.flamingock.api.annotations

Annotation Type TargetSystem

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

Associates a change class with a specific target system or subsystem. Use this when managing multiple systems (databases, message queues, etc.) within the same pipeline.

Target systems allow fine-grained control over which changes apply to which components of your distributed architecture, enabling selective execution and rollback.

Example usage:

 @TargetSystem(id = "user-database")
 @Change(id = "add-user-preferences", order = "2024-11-17-001", author = "backend-team")
 public class AddUserPreferences {
     @Apply
     public void addPreferencesTable(Connection conn) {
         // Create preferences table in user database
     }
 }

 @TargetSystem(id = "analytics-database")
 @Change(id = "create-metrics-view", order = "2024-11-17-002", author = "analytics-team")
 public class CreateMetricsView {
     @Apply
     public void createView(Connection conn) {
         // Create materialized view in analytics database
     }
 }
 

See Also:

Change

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	id Identifier for the target system this change applies to.

Element Detail

id

public abstract java.lang.String id

Identifier for the target system this change applies to. Must match a system configured in your Flamingock setup.

Returns:

the target system identifier