Package org.apache.lucene.index

Class PendingDeletes

java.lang.Object

org.apache.lucene.index.PendingDeletes

Direct Known Subclasses:

PendingSoftDeletes

class PendingDeletes
extends java.lang.Object

This class handles accounting and applying pending deletes for live segment readers

Field Summary

Fields

Modifier and Type	Field	Description
protected SegmentCommitInfo	info
private Bits	liveDocs
(package private) boolean	liveDocsInitialized
protected int	pendingDeleteCount
private FixedBitSet	writeableLiveDocs

Constructor Summary

Constructors

Constructor	Description
PendingDeletes(SegmentCommitInfo info)
PendingDeletes(SegmentCommitInfo info, Bits liveDocs, boolean liveDocsInitialized)
PendingDeletes(SegmentReader reader, SegmentCommitInfo info)

Method Summary

Modifier and Type	Method	Description
private boolean	assertCheckLiveDocs(Bits bits, int expectedLength, int expectedDeleteCount)
(package private) boolean	delete(int docID)	Marks a document as deleted in this segment and return true if a document got actually deleted or if the document was already deleted.
(package private) void	dropChanges()	Resets the pending docs
(package private) int	getDelCount()	Returns the number of deleted docs in the segment.
(package private) Bits	getHardLiveDocs()	Returns a snapshot of the hard live docs.
(package private) Bits	getLiveDocs()	Returns a snapshot of the current live docs.
protected FixedBitSet	getMutableBits()
(package private) boolean	isFullyDeleted(IOSupplier<CodecReader> readerIOSupplier)	Returns true iff the segment represented by this PendingDeletes is fully deleted
(package private) boolean	mustInitOnDelete()	Returns true if we have to initialize this PendingDeletes before delete(int); otherwise this PendingDeletes is ready to accept deletes.
(package private) boolean	needsRefresh(CodecReader reader)	Returns true if the given reader needs to be refreshed in order to see the latest deletes
(package private) int	numDeletesToMerge(MergePolicy policy, IOSupplier<CodecReader> readerIOSupplier)
(package private) int	numDocs()	Returns the number of live documents in this segment
protected int	numPendingDeletes()	Returns the number of pending deletes that are not written to disk.
(package private) void	onDocValuesUpdate(FieldInfo info, DocValuesFieldUpdates.Iterator iterator)	Called for every field update for the given field at flush time
(package private) void	onNewReader(CodecReader reader, SegmentCommitInfo info)	Called once a new reader is opened for this segment ie.
java.lang.String	toString()
(package private) boolean	verifyDocCounts(CodecReader reader)
(package private) boolean	writeLiveDocs(Directory dir)	Writes the live docs to disk and returns true if any new docs were written.

Methods inherited from class java.lang.Object

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

Field Detail

info

protected final SegmentCommitInfo info

liveDocs

private Bits liveDocs

writeableLiveDocs

private FixedBitSet writeableLiveDocs

pendingDeleteCount

protected int pendingDeleteCount

liveDocsInitialized

boolean liveDocsInitialized

Constructor Detail

PendingDeletes

PendingDeletes(SegmentReader reader,
               SegmentCommitInfo info)

PendingDeletes

PendingDeletes(SegmentCommitInfo info)

PendingDeletes

PendingDeletes(SegmentCommitInfo info,
               Bits liveDocs,
               boolean liveDocsInitialized)

Method Detail

getMutableBits

protected FixedBitSet getMutableBits()

delete

boolean delete(int docID)
        throws java.io.IOException

Marks a document as deleted in this segment and return true if a document got actually deleted or if the document was already deleted.

Throws:

java.io.IOException

getLiveDocs

Bits getLiveDocs()

Returns a snapshot of the current live docs.

getHardLiveDocs

Bits getHardLiveDocs()

Returns a snapshot of the hard live docs.

numPendingDeletes

protected int numPendingDeletes()

Returns the number of pending deletes that are not written to disk.

onNewReader

void onNewReader(CodecReader reader,
                 SegmentCommitInfo info)
          throws java.io.IOException

Called once a new reader is opened for this segment ie. when deletes or updates are applied.

Throws:

java.io.IOException

assertCheckLiveDocs

private boolean assertCheckLiveDocs(Bits bits,
                                    int expectedLength,
                                    int expectedDeleteCount)

dropChanges

void dropChanges()

Resets the pending docs

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeLiveDocs

boolean writeLiveDocs(Directory dir)
               throws java.io.IOException

Writes the live docs to disk and returns true if any new docs were written.

Throws:

java.io.IOException

isFullyDeleted

boolean isFullyDeleted(IOSupplier<CodecReader> readerIOSupplier)
                throws java.io.IOException

Returns true iff the segment represented by this PendingDeletes is fully deleted

Throws:

java.io.IOException

onDocValuesUpdate

void onDocValuesUpdate(FieldInfo info,
                       DocValuesFieldUpdates.Iterator iterator)
                throws java.io.IOException

Called for every field update for the given field at flush time

Parameters:

info - the field info of the field that's updated

iterator - the values to apply

Throws:

java.io.IOException

numDeletesToMerge

int numDeletesToMerge(MergePolicy policy,
                      IOSupplier<CodecReader> readerIOSupplier)
               throws java.io.IOException

Throws:

java.io.IOException

needsRefresh

final boolean needsRefresh(CodecReader reader)

Returns true if the given reader needs to be refreshed in order to see the latest deletes

getDelCount

final int getDelCount()

Returns the number of deleted docs in the segment.

numDocs

final int numDocs()

Returns the number of live documents in this segment

verifyDocCounts

boolean verifyDocCounts(CodecReader reader)

mustInitOnDelete

boolean mustInitOnDelete()

Returns true if we have to initialize this PendingDeletes before delete(int); otherwise this PendingDeletes is ready to accept deletes. A PendingDeletes can be initialized by providing it a reader via onNewReader(CodecReader, SegmentCommitInfo).