Package org.opensearch.index.translog

Class DefaultTranslogDeletionPolicy

java.lang.Object

org.opensearch.index.translog.TranslogDeletionPolicy

org.opensearch.index.translog.DefaultTranslogDeletionPolicy

public class DefaultTranslogDeletionPolicy
extends TranslogDeletionPolicy

Default implementation for the TranslogDeletionPolicy. Plugins can override the default behaviour via the EnginePlugin.getCustomTranslogDeletionPolicyFactory().

The default policy uses total number, size in bytes and maximum age for files.

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
DefaultTranslogDeletionPolicy(long retentionSizeInBytes, long retentionAgeInMillis, int retentionTotalFiles)

Method Summary

Modifier and Type	Method	Description
long	minTranslogGenRequired(List<TranslogReader> readers, TranslogWriter writer)	returns the minimum translog generation that is still required by the system.
void	setRetentionAgeInMillis(long ageInMillis)
void	setRetentionSizeInBytes(long bytes)
protected void	setRetentionTotalFiles(int retentionTotalFiles)

Methods inherited from class org.opensearch.index.translog.TranslogDeletionPolicy

assertNoOpenTranslogRefs, currentTime, getLocalCheckpointOfSafeCommit, getMinTranslogGenByAge, getMinTranslogGenBySize, getMinTranslogGenByTotalFiles, getMinTranslogGenRequiredByLocks, setLocalCheckpointOfSafeCommit

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultTranslogDeletionPolicy

public DefaultTranslogDeletionPolicy(long retentionSizeInBytes,
 long retentionAgeInMillis,
 int retentionTotalFiles)

Method Details

minTranslogGenRequired

public long minTranslogGenRequired(List<TranslogReader> readers,
 TranslogWriter writer)
                            throws IOException

Description copied from class: TranslogDeletionPolicy

returns the minimum translog generation that is still required by the system. Any generation below the returned value may be safely deleted

Specified by:

minTranslogGenRequired in class TranslogDeletionPolicy

Parameters:

readers - current translog readers

writer - current translog writer

Throws:

IOException

setRetentionSizeInBytes

public void setRetentionSizeInBytes(long bytes)

Specified by:

setRetentionSizeInBytes in class TranslogDeletionPolicy

setRetentionAgeInMillis

public void setRetentionAgeInMillis(long ageInMillis)

Specified by:

setRetentionAgeInMillis in class TranslogDeletionPolicy

setRetentionTotalFiles

protected void setRetentionTotalFiles(int retentionTotalFiles)

Specified by:

setRetentionTotalFiles in class TranslogDeletionPolicy