Package org.opensearch.indices.recovery

Interface RecoveryTargetHandler

All Superinterfaces:

FileChunkWriter

All Known Implementing Classes:

RecoveryTarget, RemoteRecoveryTargetHandler

public interface RecoveryTargetHandler
extends FileChunkWriter

Handler for the recovery target

Opensearch.internal:

Method Summary

Modifier and Type	Method	Description
default void	cancel()
void	cleanFiles(int totalTranslogOps, long globalCheckpoint, Store.MetadataSnapshot sourceMetadata, org.opensearch.core.action.ActionListener<Void> listener)	After all source files has been sent over, this command is sent to the target so it can clean any local files that are not part of the source store
void	finalizeRecovery(long globalCheckpoint, long trimAboveSeqNo, org.opensearch.core.action.ActionListener<Void> listener)	The finalize request refreshes the engine now that new segments are available, enables garbage collection of tombstone files, updates the global checkpoint.
void	forceSegmentFileSync()	Used with Segment replication only
void	handoffPrimaryContext(ReplicationTracker.PrimaryContext primaryContext)	Handoff the primary context between the relocation source and the relocation target.
void	indexTranslogOperations(List<Translog.Operation> operations, int totalTranslogOps, long maxSeenAutoIdTimestampOnPrimary, long maxSeqNoOfUpdatesOrDeletesOnPrimary, RetentionLeases retentionLeases, long mappingVersionOnPrimary, org.opensearch.core.action.ActionListener<Long> listener)	Index a set of translog operations on the target
void	prepareForTranslogOperations(int totalTranslogOps, org.opensearch.core.action.ActionListener<Void> listener)	Prepares the target to receive translog operations, after all file have been copied
void	receiveFileInfo(List<String> phase1FileNames, List<Long> phase1FileSizes, List<String> phase1ExistingFileNames, List<Long> phase1ExistingFileSizes, int totalTranslogOps, org.opensearch.core.action.ActionListener<Void> listener)	Notifies the target of the files it is going to receive

Methods inherited from interface org.opensearch.indices.recovery.FileChunkWriter

writeFileChunk

Method Details

prepareForTranslogOperations

void prepareForTranslogOperations(int totalTranslogOps,
 org.opensearch.core.action.ActionListener<Void> listener)

Prepares the target to receive translog operations, after all file have been copied

Parameters:

totalTranslogOps - total translog operations expected to be sent

forceSegmentFileSync

void forceSegmentFileSync()

Used with Segment replication only

This function is used to force a sync target primary node with source (old primary). This is to avoid segment files conflict with replicas when target is promoted as primary.

finalizeRecovery

void finalizeRecovery(long globalCheckpoint,
 long trimAboveSeqNo,
 org.opensearch.core.action.ActionListener<Void> listener)

The finalize request refreshes the engine now that new segments are available, enables garbage collection of tombstone files, updates the global checkpoint.

Parameters:

globalCheckpoint - the global checkpoint on the recovery source

trimAboveSeqNo - The recovery target should erase its existing translog above this sequence number from the previous primary terms.

listener - the listener which will be notified when this method is completed

handoffPrimaryContext

void handoffPrimaryContext(ReplicationTracker.PrimaryContext primaryContext)

Handoff the primary context between the relocation source and the relocation target.

Parameters:

primaryContext - the primary context from the relocation source

indexTranslogOperations

void indexTranslogOperations(List<Translog.Operation> operations,
 int totalTranslogOps,
 long maxSeenAutoIdTimestampOnPrimary,
 long maxSeqNoOfUpdatesOrDeletesOnPrimary,
 RetentionLeases retentionLeases,
 long mappingVersionOnPrimary,
 org.opensearch.core.action.ActionListener<Long> listener)

Index a set of translog operations on the target

Parameters:

operations - operations to index

totalTranslogOps - current number of total operations expected to be indexed

maxSeenAutoIdTimestampOnPrimary - the maximum auto_id_timestamp of all append-only requests processed by the primary shard

maxSeqNoOfUpdatesOrDeletesOnPrimary - the max seq_no of update operations (index operations overwrite Lucene) or delete ops on the primary shard when capturing these operations. This value is at least as high as the max_seq_no_of_updates on the primary was when any of these ops were processed on it.

retentionLeases - the retention leases on the primary

mappingVersionOnPrimary - the mapping version which is at least as up to date as the mapping version that the primary used to index translog operations in this request. If the mapping version on the replica is not older this version, we should not retry on MapperException; otherwise we should wait for a new mapping then retry.

listener - a listener which will be notified with the local checkpoint on the target after these operations are successfully indexed on the target.

receiveFileInfo

void receiveFileInfo(List<String> phase1FileNames,
 List<Long> phase1FileSizes,
 List<String> phase1ExistingFileNames,
 List<Long> phase1ExistingFileSizes,
 int totalTranslogOps,
 org.opensearch.core.action.ActionListener<Void> listener)

Notifies the target of the files it is going to receive

cleanFiles

void cleanFiles(int totalTranslogOps,
 long globalCheckpoint,
 Store.MetadataSnapshot sourceMetadata,
 org.opensearch.core.action.ActionListener<Void> listener)

After all source files has been sent over, this command is sent to the target so it can clean any local files that are not part of the source store

Parameters:

totalTranslogOps - an update number of translog operations that will be replayed later on

globalCheckpoint - the global checkpoint on the primary

sourceMetadata - meta data of the source store

cancel

default void cancel()

Specified by:

cancel in interface FileChunkWriter