io.mongock.driver.api.entry

Interface ChangeEntryService

All Superinterfaces:

Process, RepositoryIndexable

public interface ChangeEntryService
extends RepositoryIndexable, Process

Method Summary

Modifier and Type	Method and Description
void	deleteAll() Only for testing
default void	ensureAllFields() Ensures that all the entity fields exist, or create them if not.
void	ensureField(Field field) Ensures that the specified entity field exists, or create it if not.
default List<ChangeEntry>	getAllEntriesWithCurrentState() Retrieves a list of the entries in database with the current relevant state ordered by execution timestamp.
List<ChangeEntry>	getEntriesLog() Returns all the changeEntries
default Map<ChangeKey,List<ChangeEntry>>	getEntriesMap()
default List<ChangeEntryExecuted>	getExecuted() Retrieves a list with current executed entries ordered by execution timestamp.
default boolean	isAlreadyExecuted(String changeSetId, String author) Deprecated.
void	saveOrUpdate(ChangeEntry changeEntry) If there is already an ChangeEntry with the same key(executionId, id and author), it's updated.

Methods inherited from interface io.mongock.driver.api.common.RepositoryIndexable

setIndexCreation

Methods inherited from interface io.mongock.utils.Process

initialize

Method Detail

isAlreadyExecuted

@Deprecated
default boolean isAlreadyExecuted(String changeSetId,
                                              String author)

Deprecated.

NOT USED

getExecuted

default List<ChangeEntryExecuted> getExecuted()
                                       throws MongockException

Retrieves a list with current executed entries ordered by execution timestamp.

Returns:

list of current executed entries ordered by execution timestamp

Throws:

MongockException

getAllEntriesWithCurrentState

default List<ChangeEntry> getAllEntriesWithCurrentState()
                                                 throws MongockException

Retrieves a list of the entries in database with the current relevant state ordered by execution timestamp.

Returns:

list of the entries in database with the current relevant state ordered by execution timestamp

Throws:

MongockException

getEntriesMap

default Map<ChangeKey,List<ChangeEntry>> getEntriesMap()

getEntriesLog

List<ChangeEntry> getEntriesLog()

Returns all the changeEntries

Returns:

saveOrUpdate

void saveOrUpdate(ChangeEntry changeEntry)
           throws MongockException

If there is already an ChangeEntry with the same key(executionId, id and author), it's updated. Otherwise, the new changeEntry is inserted.

Parameters:

changeEntry - Entry to be upsert

Throws:

MongockException - if any i/o exception occurs

ensureAllFields

default void ensureAllFields()

Ensures that all the entity fields exist, or create them if not.

ensureField

void ensureField(Field field)

Ensures that the specified entity field exists, or create it if not.

Parameters:

field - Field to be ensured or created

deleteAll

void deleteAll()

Only for testing