com.edorasware.commons.core.elastic

Interface ElasticIndexService

public interface ElasticIndexService

Service interface for managing Elasticsearch indexes.

Method Summary

Modifier and Type	Method and Description
void	enableUpdateTracking() Enables update tracking in transactions.
void	resetAll(Instant timestamp) Resets all indices when the database has been reset.
void	synchronize(String indexName, Instant timestamp, boolean deleteOldIndexOnCompletion, boolean force) Synchronize a specific index from the database as required.
void	synchronizeAll(Instant timestamp, boolean deleteOldIndexOnCompletion, boolean force) Synchronize all indices from the database as required.
void	waitForSynchronizationCompletion() Waits for an active synchronization to complete.

Method Detail

resetAll

void resetAll(Instant timestamp)

Resets all indices when the database has been reset.

enableUpdateTracking

void enableUpdateTracking()

Enables update tracking in transactions.

This should be called after the system initialisation (including upgrades) has been completed. Before this method is called, changes may be indexed immediately, improving the performance of bulk updates but with a risk that the index will be invalid if a transaction should fail.

synchronizeAll

void synchronizeAll(Instant timestamp,
                    boolean deleteOldIndexOnCompletion,
                    boolean force)

Synchronize all indices from the database as required.

Parameters:

timestamp - the current timestamp

deleteOldIndexOnCompletion - true if the old index should be deleted

force - true if a new index should always be created

synchronize

void synchronize(String indexName,
                 Instant timestamp,
                 boolean deleteOldIndexOnCompletion,
                 boolean force)

Synchronize a specific index from the database as required.

Parameters:

indexName - the active index name (i.e. the alias)

timestamp - the current timestamp

deleteOldIndexOnCompletion - true if the old index should be deleted

force - true if a new index should always be created

waitForSynchronizationCompletion

void waitForSynchronizationCompletion()

Waits for an active synchronization to complete.