Package org.opensearch.index.translog.transfer

Class TranslogTransferManager

java.lang.Object

org.opensearch.index.translog.transfer.TranslogTransferManager

public class TranslogTransferManager
extends Object

The class responsible for orchestrating the transfer of a TransferSnapshot via a TransferService

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
TranslogTransferManager(org.opensearch.core.index.shard.ShardId shardId, TransferService transferService, BlobPath remoteDataTransferPath, BlobPath remoteMetadataTransferPath, FileTransferTracker fileTransferTracker, RemoteTranslogTransferTracker remoteTranslogTransferTracker, RemoteStoreSettings remoteStoreSettings)

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes all the translog content related to the underlying shard.
void	deleteGenerationAsync(long primaryTerm, Set<Long> generations, Runnable onCompletion)	This method handles deletion of multiple generations for a single primary term.
void	deletePrimaryTermsAsync(long minPrimaryTermToKeep)	Deletes all primary terms from remote store that are more than the given minPrimaryTermToKeep.
void	deleteStaleTranslogMetadataFilesAsync(Runnable onCompletion)
void	deleteTranslogFiles()
boolean	downloadTranslog(String primaryTerm, String generation, Path location)
int	getMaxRemoteTranslogReadersSettings()
byte[]	getMetadataBytes(TranslogTransferMetadata metadata)	Get the metadata bytes for a TranslogTransferMetadata object
RemoteTranslogTransferTracker	getRemoteTranslogTransferTracker()
org.opensearch.core.index.shard.ShardId	getShardId()
TranslogTransferMetadata	readMetadata()
boolean	transferSnapshot(TransferSnapshot transferSnapshot, TranslogTransferListener translogTransferListener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TranslogTransferManager

public TranslogTransferManager(org.opensearch.core.index.shard.ShardId shardId,
 TransferService transferService,
 BlobPath remoteDataTransferPath,
 BlobPath remoteMetadataTransferPath,
 FileTransferTracker fileTransferTracker,
 RemoteTranslogTransferTracker remoteTranslogTransferTracker,
 RemoteStoreSettings remoteStoreSettings)

Method Details

getRemoteTranslogTransferTracker

public RemoteTranslogTransferTracker getRemoteTranslogTransferTracker()

getShardId

public org.opensearch.core.index.shard.ShardId getShardId()

transferSnapshot

public boolean transferSnapshot(TransferSnapshot transferSnapshot,
 TranslogTransferListener translogTransferListener)
                         throws IOException

Throws:

IOException

downloadTranslog

public boolean downloadTranslog(String primaryTerm,
 String generation,
 Path location)
                         throws IOException

Throws:

IOException

readMetadata

public TranslogTransferMetadata readMetadata()
                                      throws IOException

Throws:

IOException

getMetadataBytes

public byte[] getMetadataBytes(TranslogTransferMetadata metadata)
                        throws IOException

Get the metadata bytes for a TranslogTransferMetadata object

Parameters:

metadata - The object to be parsed

Returns:

Byte representation for the given metadata

Throws:

IOException

deleteGenerationAsync

public void deleteGenerationAsync(long primaryTerm,
 Set<Long> generations,
 Runnable onCompletion)

This method handles deletion of multiple generations for a single primary term. The deletion happens for translog and metadata files.

Parameters:

primaryTerm - primary term where the generations will be deleted.

generations - set of generation to delete.

onCompletion - runnable to run on completion of deletion regardless of success/failure.

deletePrimaryTermsAsync

public void deletePrimaryTermsAsync(long minPrimaryTermToKeep)

Deletes all primary terms from remote store that are more than the given minPrimaryTermToKeep. The caller of the method must ensure that the value is lesser than equal to the minimum primary term referenced by the remote translog metadata.

Parameters:

minPrimaryTermToKeep - all primary terms below this primary term are deleted.

delete

public void delete()

Deletes all the translog content related to the underlying shard.

deleteStaleTranslogMetadataFilesAsync

public void deleteStaleTranslogMetadataFilesAsync(Runnable onCompletion)

deleteTranslogFiles

public void deleteTranslogFiles()
                         throws IOException

Throws:

IOException

getMaxRemoteTranslogReadersSettings

public int getMaxRemoteTranslogReadersSettings()