Module org.elasticsearch.server

Package org.elasticsearch.index.engine

Class LuceneChangesSnapshot

java.lang.Object

org.elasticsearch.index.engine.SearchBasedChangesSnapshot

org.elasticsearch.index.engine.LuceneChangesSnapshot

All Implemented Interfaces:

Closeable, AutoCloseable, Translog.Snapshot

public final class LuceneChangesSnapshot
extends SearchBasedChangesSnapshot

A Translog.Snapshot from changes in a Lucene index

Field Summary

Fields inherited from class org.elasticsearch.index.engine.SearchBasedChangesSnapshot

DEFAULT_BATCH_SIZE, fromSeqNo, requiredFullRange, searchBatchSize, toSeqNo

Fields inherited from interface org.elasticsearch.index.translog.Translog.Snapshot

EMPTY

Constructor Summary

Constructors

Constructor	Description
LuceneChangesSnapshot(MapperService mapperService, Engine.Searcher engineSearcher, int searchBatchSize, long fromSeqNo, long toSeqNo, boolean requiredFullRange, boolean singleConsumer, boolean accessStats, IndexVersion indexVersionCreated)	Creates a new "translog" snapshot from Lucene for reading operations whose seq# in the specified range.

Method Summary

Modifier and Type	Method	Description
void	close()
protected Translog.Operation	nextOperation()	Abstract method for retrieving the next operation.
int	skippedOperations()	The number of operations have been skipped (overridden or trimmed) in the snapshot so far.
int	totalOperations()	The total estimated number of operations in the snapshot.

Methods inherited from class org.elasticsearch.index.engine.SearchBasedChangesSnapshot

addSourceMetadata, assertDocSoftDeleted, leaves, next, nextTopDocs, setNextSourceMetadataReader

Methods inherited from class java.lang.Object

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

Constructor Details

LuceneChangesSnapshot

public LuceneChangesSnapshot(MapperService mapperService,
 Engine.Searcher engineSearcher,
 int searchBatchSize,
 long fromSeqNo,
 long toSeqNo,
 boolean requiredFullRange,
 boolean singleConsumer,
 boolean accessStats,
 IndexVersion indexVersionCreated)
                      throws IOException

Creates a new "translog" snapshot from Lucene for reading operations whose seq# in the specified range.

Parameters:

mapperService - the mapper service for this index

engineSearcher - the internal engine searcher which will be taken over if the snapshot is opened successfully

searchBatchSize - the number of documents should be returned by each search

fromSeqNo - the min requesting seq# - inclusive

toSeqNo - the maximum requesting seq# - inclusive

requiredFullRange - if true, the snapshot will strictly check for the existence of operations between fromSeqNo and toSeqNo

singleConsumer - true if the snapshot is accessed by a single thread that creates the snapshot

accessStats - true if the stats of the snapshot can be accessed via totalOperations()

indexVersionCreated - the version on which this index was created

Throws:

IOException

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class SearchBasedChangesSnapshot

Throws:

IOException

totalOperations

public int totalOperations()

Description copied from interface: Translog.Snapshot

The total estimated number of operations in the snapshot.

Specified by:

totalOperations in interface Translog.Snapshot

Overrides:

totalOperations in class SearchBasedChangesSnapshot

skippedOperations

public int skippedOperations()

Description copied from interface: Translog.Snapshot

The number of operations have been skipped (overridden or trimmed) in the snapshot so far. Unlike Translog.Snapshot.totalOperations(), this value is updated each time after Translog.Snapshot.next()) is called.

nextOperation

protected Translog.Operation nextOperation()
                                    throws IOException

Description copied from class: SearchBasedChangesSnapshot

Abstract method for retrieving the next operation. Should be implemented by subclasses.

Specified by:

nextOperation in class SearchBasedChangesSnapshot

Returns:

The next Translog.Operation in the snapshot.

Throws:

IOException - If an I/O error occurs.