io.mongock.runner.core.builder.roles

Interface MigrationWriter<SELF extends MigrationWriter<SELF,CONFIG>,CONFIG extends MongockConfiguration>

All Superinterfaces:

Configurable<SELF,CONFIG>, SelfInstanstiator<SELF>

All Known Subinterfaces:

RunnerBuilder<SELF,CONFIG>

public interface MigrationWriter<SELF extends MigrationWriter<SELF,CONFIG>,CONFIG extends MongockConfiguration>
extends Configurable<SELF,CONFIG>, SelfInstanstiator<SELF>

Method Summary

Modifier and Type	Method and Description
default SELF	setTrackIgnored(boolean trackIgnored) Indicates if the ignored changeSets should be tracked or not
default SELF	withMetadata(Map<String,Object> metadata) Set the metadata for the Mongock process.

Methods inherited from interface io.mongock.runner.core.builder.roles.Configurable

getConfig, getType, getVersion, setConfig

Methods inherited from interface io.mongock.runner.core.builder.roles.SelfInstanstiator

getInstance

Method Detail

setTrackIgnored

default SELF setTrackIgnored(boolean trackIgnored)

Indicates if the ignored changeSets should be tracked or not

Parameters:

trackIgnored - if the ignored changeSets should be tracked

Returns:

builder for fluent interface

withMetadata

default SELF withMetadata(Map<String,Object> metadata)

Set the metadata for the Mongock process. This metadata will be added to each document in the MongockChangeLog collection. This is useful when the system needs to add some extra info to the changeLog. Optional Default value empty Map

Parameters:

metadata - Custom metadata object to be added

Returns:

builder for fluent interface