Uses of Class
org.apache.lucene.index.SegmentCommitInfo

Packages that use SegmentCommitInfo

Package	Description
org.apache.lucene.backward_codecs.lucene50	Lucene 5.0 file format.
org.apache.lucene.codecs	Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.lucene90	Lucene 9.0 file format.
org.apache.lucene.codecs.simpletext	Simpletext Codec: writes human readable postings.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.internal.tests	Internal bridges to package-private internals, for use by the lucene test framework only.
org.apache.lucene.misc.index	Misc index tools and index support.

Uses of SegmentCommitInfo in org.apache.lucene.backward_codecs.lucene50

Methods in org.apache.lucene.backward_codecs.lucene50 with parameters of type SegmentCommitInfo

Modifier and Type	Method	Description
void	Lucene50LiveDocsFormat.files(SegmentCommitInfo info, Collection<String> files)
Bits	Lucene50LiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)
void	Lucene50LiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)	Note: although this format is only used on older versions, we need to keep the write logic in addition to the read logic.

Uses of SegmentCommitInfo in org.apache.lucene.codecs

Methods in org.apache.lucene.codecs with parameters of type SegmentCommitInfo

Modifier and Type	Method	Description
abstract void	LiveDocsFormat.files(SegmentCommitInfo info, Collection<String> files)	Records all files in use by this SegmentCommitInfo into the files argument.
abstract Bits	LiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)	Read live docs bits.
abstract void	LiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)	Persist live docs bits.

Uses of SegmentCommitInfo in org.apache.lucene.codecs.lucene90

Methods in org.apache.lucene.codecs.lucene90 with parameters of type SegmentCommitInfo

Modifier and Type	Method	Description
void	Lucene90LiveDocsFormat.files(SegmentCommitInfo info, Collection<String> files)
Bits	Lucene90LiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)
void	Lucene90LiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)

Uses of SegmentCommitInfo in org.apache.lucene.codecs.simpletext

Methods in org.apache.lucene.codecs.simpletext with parameters of type SegmentCommitInfo

Modifier and Type	Method	Description
void	SimpleTextLiveDocsFormat.files(SegmentCommitInfo info, Collection<String> files)
Bits	SimpleTextLiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)
void	SimpleTextLiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)

Uses of SegmentCommitInfo in org.apache.lucene.index

Fields in org.apache.lucene.index declared as SegmentCommitInfo

Modifier and Type	Field	Description
(package private) final SegmentCommitInfo	LogMergePolicy.SegmentInfoAndLevel.info
(package private) SegmentCommitInfo	MergePolicy.OneMerge.info
protected final SegmentCommitInfo	PendingDeletes.info
(package private) final SegmentCommitInfo	ReadersAndUpdates.info
private final SegmentCommitInfo	SegmentReader.originalSi
(package private) final SegmentCommitInfo	FrozenBufferedUpdates.privateSegment
private final SegmentCommitInfo	TieredMergePolicy.SegmentSizeAndDocs.segInfo
(package private) final SegmentCommitInfo	DocumentsWriterPerThread.FlushedSegment.segmentInfo
private final SegmentCommitInfo	SegmentReader.si

Fields in org.apache.lucene.index with type parameters of type SegmentCommitInfo

Modifier and Type	Field	Description
(package private) final List<SegmentCommitInfo>	BufferedUpdatesStream.ApplyDeletesResult.allDeleted
(package private) final HashMap<SegmentCommitInfo,Integer>	CachingMergeContext.cachedNumDeletesToMerge
private final HashSet<SegmentCommitInfo>	IndexWriter.mergingSegments
private final Map<SegmentCommitInfo,ReadersAndUpdates>	ReaderPool.readerMap
private List<SegmentCommitInfo>	IndexWriter.rollbackSegments
final List<SegmentCommitInfo>	MergePolicy.OneMerge.segments	Segments to be merged.
private List<SegmentCommitInfo>	SegmentInfos.segments
private final Map<SegmentCommitInfo,Boolean>	IndexWriter.segmentsToMerge

Methods in org.apache.lucene.index that return SegmentCommitInfo

Modifier and Type	Method	Description
SegmentCommitInfo	SegmentCommitInfo.clone()
private SegmentCommitInfo	IndexWriter.copySegmentAsIs(SegmentCommitInfo info, String segName, IOContext context)	Copies the segment files as-is into the IndexWriter's directory.
SegmentCommitInfo	MergePolicy.OneMerge.getMergeInfo()	Returns the SegmentCommitInfo for the merged segment, or null if it hasn't been set yet.
(package private) SegmentCommitInfo	SegmentReader.getOriginalSegmentInfo()	Returns the original SegmentInfo passed to the segment reader on creation time.
SegmentCommitInfo	SegmentReader.getSegmentInfo()	Return the SegmentInfoPerCommit of the segment this reader is reading.
SegmentCommitInfo	SegmentInfos.info(int i)	Returns SegmentCommitInfo at the provided index.
(package private) SegmentCommitInfo	IndexWriter.newestSegment()

Methods in org.apache.lucene.index that return types with arguments of type SegmentCommitInfo

Modifier and Type	Method	Description
List<SegmentCommitInfo>	SegmentInfos.asList()	Returns all contained segments as an unmodifiable List view.
(package private) List<SegmentCommitInfo>	SegmentInfos.createBackupSegmentInfos()
private List<SegmentCommitInfo>	IndexWriter.getInfosToApply(FrozenBufferedUpdates updates)	Returns the SegmentCommitInfo that this packet is supposed to apply its deletes to, or null if the private segment was already merged away.
final Set<SegmentCommitInfo>	CachingMergeContext.getMergingSegments()
Set<SegmentCommitInfo>	IndexWriter.getMergingSegments()	Expert: to be used by a MergePolicy to avoid selecting merges for segments already being merged.
Set<SegmentCommitInfo>	MergePolicy.MergeContext.getMergingSegments()	Returns an unmodifiable set of segments that are currently merging.
Iterator<SegmentCommitInfo>	SegmentInfos.iterator()	Returns an unmodifiable Iterator of contained segments in order.

Methods in org.apache.lucene.index with parameters of type SegmentCommitInfo

Modifier and Type	Method	Description
void	SegmentInfos.add(SegmentCommitInfo si)	Appends the provided SegmentCommitInfo.
protected final boolean	MergePolicy.assertDelCount(int delCount, SegmentCommitInfo info)	Asserts that the delCount for this SegmentCommitInfo is valid
(package private) boolean	ReaderPool.assertInfoIsLive(SegmentCommitInfo info)	Asserts this info still exists in IW's segment infos
private static CheckIndex.Status.SoftDeletsStatus	CheckIndex.checkSoftDeletes(String softDeletesField, SegmentCommitInfo info, SegmentReader reader, PrintStream infoStream, boolean failFast)
(package private) boolean	SegmentInfos.contains(SegmentCommitInfo si)	Return true if the provided SegmentCommitInfo is contained.
private SegmentCommitInfo	IndexWriter.copySegmentAsIs(SegmentCommitInfo info, String segName, IOContext context)	Copies the segment files as-is into the IndexWriter's directory.
(package private) boolean	ReaderPool.drop(SegmentCommitInfo info)	Drops reader for the given SegmentCommitInfo if it's pooled
private void	IndexWriter.dropDeletedSegment(SegmentCommitInfo info)	Drops a segment that has 100% deleted documents.
(package private) ReadersAndUpdates	ReaderPool.get(SegmentCommitInfo info, boolean create)	Obtain a ReadersAndLiveDocs instance from the readerPool.
(package private) DocValuesProducer	SegmentDocValues.getDocValuesProducer(long gen, SegmentCommitInfo si, Directory dir, FieldInfos infos)	Returns the DocValuesProducer for the given generation.
(package private) ReadersAndUpdates	IndexWriter.getPooledInstance(SegmentCommitInfo info, boolean create)
(package private) int	SegmentInfos.indexOf(SegmentCommitInfo si)	Returns index of the provided SegmentCommitInfo.
protected final boolean	MergePolicy.isMerged(SegmentInfos infos, SegmentCommitInfo info, MergePolicy.MergeContext mergeContext)	Returns true if this single info is already fully merged (has no pending deletes, is in the same dir as the writer, and matches the current compound file setting
private RefCount<DocValuesProducer>	SegmentDocValues.newDocValuesProducer(SegmentCommitInfo si, Directory dir, long gen, FieldInfos infos)
private PendingDeletes	ReaderPool.newPendingDeletes(SegmentCommitInfo info)
private PendingDeletes	ReaderPool.newPendingDeletes(SegmentReader reader, SegmentCommitInfo info)
final int	CachingMergeContext.numDeletedDocs(SegmentCommitInfo info)
int	IndexWriter.numDeletedDocs(SegmentCommitInfo info)	Obtain the number of deleted docs for a pooled reader.
int	MergePolicy.MergeContext.numDeletedDocs(SegmentCommitInfo info)	Returns the number of deleted documents in the given segments.
final int	CachingMergeContext.numDeletesToMerge(SegmentCommitInfo info)
int	FilterMergePolicy.numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)
final int	IndexWriter.numDeletesToMerge(SegmentCommitInfo info)	Returns the number of deletes a merge would claim back if the given segment is merged.
int	MergePolicy.MergeContext.numDeletesToMerge(SegmentCommitInfo info)	Returns the number of deletes a merge would claim back if the given segment is merged.
int	MergePolicy.numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)	Returns the number of deletes that a merge would claim on the given segment.
int	NoMergePolicy.numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)
int	SoftDeletesRetentionMergePolicy.numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)
(package private) void	PendingDeletes.onNewReader(CodecReader reader, SegmentCommitInfo info)	Called once a new reader is opened for this segment ie.
(package private) void	PendingSoftDeletes.onNewReader(CodecReader reader, SegmentCommitInfo info)
private void	CheckIndex.processSegmentInfoStatusResult(CheckIndex.Status result, SegmentCommitInfo info, CheckIndex.Status.SegmentInfoStatus segmentInfoStatus)
private void	IndexWriter.publishFlushedSegment(SegmentCommitInfo newSegment, FieldInfos fieldInfos, FrozenBufferedUpdates packet, FrozenBufferedUpdates globalPacket, Sorter.DocMap sortMap)	Atomically adds the segment private delete packet and publishes the flushed segments SegmentInfo to the index writer.
(package private) static FieldInfos	IndexWriter.readFieldInfos(SegmentCommitInfo si)
boolean	SegmentInfos.remove(SegmentCommitInfo si)	Remove the provided SegmentCommitInfo.
private String	IndexWriter.segString(SegmentCommitInfo info)	Returns a string description of the specified segment, for debugging.
void	MergePolicy.OneMerge.setMergeInfo(SegmentCommitInfo info)	Expert: Sets the SegmentCommitInfo of the merged segment.
protected boolean	UpgradeIndexMergePolicy.shouldUpgradeSegment(SegmentCommitInfo si)	Returns if the given segment should be upgraded.
protected long	FilterMergePolicy.size(SegmentCommitInfo info, MergePolicy.MergeContext context)
protected long	LogByteSizeMergePolicy.size(SegmentCommitInfo info, MergePolicy.MergeContext mergeContext)
protected long	LogDocMergePolicy.size(SegmentCommitInfo info, MergePolicy.MergeContext mergeContext)
protected long	MergePolicy.size(SegmentCommitInfo info, MergePolicy.MergeContext mergeContext)	Return the byte size of the provided SegmentCommitInfo, pro-rated by percentage of non-deleted documents is set.
protected long	NoMergePolicy.size(SegmentCommitInfo info, MergePolicy.MergeContext context)
protected long	LogMergePolicy.sizeBytes(SegmentCommitInfo info, MergePolicy.MergeContext mergeContext)	Return the byte size of the provided SegmentCommitInfo, pro-rated by percentage of non-deleted documents if LogMergePolicy.setCalibrateSizeByDeletes(boolean) is set.
protected long	LogMergePolicy.sizeDocs(SegmentCommitInfo info, MergePolicy.MergeContext mergeContext)	Return the number of documents in the provided SegmentCommitInfo, pro-rated by percentage of non-deleted documents if LogMergePolicy.setCalibrateSizeByDeletes(boolean) is set.
private CheckIndex.Status.SegmentInfoStatus	CheckIndex.testSegment(SegmentInfos sis, SegmentCommitInfo info, PrintStream infoStream)
private void	CheckIndex.updateMaxSegmentName(CheckIndex.Status result, SegmentCommitInfo info)
boolean	FilterMergePolicy.useCompoundFile(SegmentInfos infos, SegmentCommitInfo mergedInfo, MergePolicy.MergeContext mergeContext)
boolean	MergePolicy.useCompoundFile(SegmentInfos infos, SegmentCommitInfo mergedInfo, MergePolicy.MergeContext mergeContext)	Returns true if a new segment (regardless of its origin) should use the compound file format.
boolean	NoMergePolicy.useCompoundFile(SegmentInfos segments, SegmentCommitInfo newSegment, MergePolicy.MergeContext mergeContext)
private void	IndexWriter.validate(SegmentCommitInfo info)

Method parameters in org.apache.lucene.index with type arguments of type SegmentCommitInfo

Modifier and Type	Method	Description
void	SegmentInfos.addAll(Iterable<SegmentCommitInfo> sis)	Appends the provided SegmentCommitInfos.
MergePolicy.MergeSpecification	FilterMergePolicy.findForcedMerges(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentCommitInfo,Boolean> segmentsToMerge, MergePolicy.MergeContext mergeContext)
MergePolicy.MergeSpecification	LogMergePolicy.findForcedMerges(SegmentInfos infos, int maxNumSegments, Map<SegmentCommitInfo,Boolean> segmentsToMerge, MergePolicy.MergeContext mergeContext)	Returns the merges necessary to merge the index down to a specified number of segments.
abstract MergePolicy.MergeSpecification	MergePolicy.findForcedMerges(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentCommitInfo,Boolean> segmentsToMerge, MergePolicy.MergeContext mergeContext)	Determine what set of merge operations is necessary in order to merge to <= the specified segment count.
MergePolicy.MergeSpecification	NoMergePolicy.findForcedMerges(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentCommitInfo,Boolean> segmentsToMerge, MergePolicy.MergeContext mergeContext)
MergePolicy.MergeSpecification	OneMergeWrappingMergePolicy.findForcedMerges(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentCommitInfo,Boolean> segmentsToMerge, MergePolicy.MergeContext mergeContext)
MergePolicy.MergeSpecification	TieredMergePolicy.findForcedMerges(SegmentInfos infos, int maxSegmentCount, Map<SegmentCommitInfo,Boolean> segmentsToMerge, MergePolicy.MergeContext mergeContext)
MergePolicy.MergeSpecification	UpgradeIndexMergePolicy.findForcedMerges(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentCommitInfo,Boolean> segmentsToMerge, MergePolicy.MergeContext mergeContext)
(package private) void	MergePolicy.OneMerge.initMergeReaders(IOFunction<SegmentCommitInfo,MergePolicy.MergeReader> readerFactory)	Sets the merge readers for this merge.
protected boolean	LogMergePolicy.isMerged(SegmentInfos infos, int maxNumSegments, Map<SegmentCommitInfo,Boolean> segmentsToMerge, MergePolicy.MergeContext mergeContext)	Returns true if the number of segments eligible for merging is less than or equal to the specified maxNumSegments.
(package private) static StandardDirectoryReader	StandardDirectoryReader.open(IndexWriter writer, IOFunction<SegmentCommitInfo,SegmentReader> readerFunction, SegmentInfos infos, boolean applyAllDeletes, boolean writeAllDeletes)	Used by near real-time search
private BufferedUpdatesStream.SegmentState[]	IndexWriter.openSegmentStates(List<SegmentCommitInfo> infos, Set<SegmentCommitInfo> alreadySeenSegments, long delGen)	Opens SegmentReader and inits SegmentState for each segment.
private BufferedUpdatesStream.SegmentState[]	IndexWriter.openSegmentStates(List<SegmentCommitInfo> infos, Set<SegmentCommitInfo> alreadySeenSegments, long delGen)	Opens SegmentReader and inits SegmentState for each segment.
private MergePolicy.MergeSpecification	IndexWriter.preparePointInTimeMerge(SegmentInfos mergingSegmentInfos, BooleanSupplier stopCollectingMergeResults, MergeTrigger trigger, IOConsumer<SegmentCommitInfo> mergeFinished)	This optimization allows a commit/getReader to wait for merges on smallish segments to reduce the eventual number of tiny segments in the commit point / NRT Reader.
(package private) void	SegmentInfos.rollbackSegmentInfos(List<SegmentCommitInfo> infos)
protected TieredMergePolicy.MergeScore	TieredMergePolicy.score(List<SegmentCommitInfo> candidate, boolean hitTooLarge, Map<SegmentCommitInfo,TieredMergePolicy.SegmentSizeAndDocs> segmentsSizes)	Expert: scores one merge; subclasses can override.
protected TieredMergePolicy.MergeScore	TieredMergePolicy.score(List<SegmentCommitInfo> candidate, boolean hitTooLarge, Map<SegmentCommitInfo,TieredMergePolicy.SegmentSizeAndDocs> segmentsSizes)	Expert: scores one merge; subclasses can override.
(package private) String	IndexWriter.segString(Iterable<SegmentCommitInfo> infos)
protected final String	MergePolicy.segString(MergePolicy.MergeContext mergeContext, Iterable<SegmentCommitInfo> infos)	Builds a String representation of the given SegmentCommitInfo instances
(package private) void	BufferedUpdatesStream.waitApplyForMerge(List<SegmentCommitInfo> mergeInfos, IndexWriter writer)	Waits only for those in-flight packets that apply to these merge segments.
(package private) boolean	ReaderPool.writeDocValuesUpdatesForMerge(List<SegmentCommitInfo> infos)	Writes all doc values updates to disk if there are any.

Constructors in org.apache.lucene.index with parameters of type SegmentCommitInfo

Modifier	Constructor	Description
private	FlushedSegment(InfoStream infoStream, SegmentCommitInfo segmentInfo, FieldInfos fieldInfos, BufferedUpdates segmentUpdates, FixedBitSet liveDocs, int delCount, Sorter.DocMap sortMap)
	FrozenBufferedUpdates(InfoStream infoStream, BufferedUpdates updates, SegmentCommitInfo privateSegment)
(package private)	PendingDeletes(SegmentCommitInfo info)
(package private)	PendingDeletes(SegmentCommitInfo info, Bits liveDocs, boolean liveDocsInitialized)
(package private)	PendingDeletes(SegmentReader reader, SegmentCommitInfo info)
(package private)	PendingSoftDeletes(String field, SegmentCommitInfo info)
(package private)	PendingSoftDeletes(String field, SegmentReader reader, SegmentCommitInfo info)
(package private)	ReadersAndUpdates(int indexCreatedVersionMajor, SegmentCommitInfo info, PendingDeletes pendingDeletes)
(package private)	SegmentCoreReaders(Directory dir, SegmentCommitInfo si, IOContext context)
(package private)	SegmentDocValuesProducer(SegmentCommitInfo si, Directory dir, FieldInfos coreInfos, FieldInfos allInfos, SegmentDocValues segDocValues)	Creates a new producer that handles updated docvalues fields
	SegmentInfoAndLevel(SegmentCommitInfo info, float level)
(package private)	SegmentReader(SegmentCommitInfo si, int createdVersionMajor, IOContext context)	Constructs a new SegmentReader with a new core.
(package private)	SegmentReader(SegmentCommitInfo si, SegmentReader sr, Bits liveDocs, Bits hardLiveDocs, int numDocs, boolean isNRT)	Create new SegmentReader sharing core from a previous SegmentReader and using the provided liveDocs, and recording whether those liveDocs were carried in ram (isNRT=true).
(package private)	SegmentSizeAndDocs(SegmentCommitInfo info, long sizeInBytes, int segDelCount)
(package private)	SegmentState(ReadersAndUpdates rld, IOConsumer<ReadersAndUpdates> onClose, SegmentCommitInfo info)

Constructor parameters in org.apache.lucene.index with type arguments of type SegmentCommitInfo

Modifier	Constructor	Description
(package private)	ApplyDeletesResult(boolean anyDeletes, List<SegmentCommitInfo> allDeleted)
	OneMerge(List<SegmentCommitInfo> segments)	Sole constructor.

Uses of SegmentCommitInfo in org.apache.lucene.internal.tests

Methods in org.apache.lucene.internal.tests that return SegmentCommitInfo

Modifier and Type	Method	Description
SegmentCommitInfo	IndexWriterAccess.newestSegment(IndexWriter iw)

Uses of SegmentCommitInfo in org.apache.lucene.misc.index

Methods in org.apache.lucene.misc.index that return SegmentCommitInfo

Modifier and Type	Method	Description
private SegmentCommitInfo	IndexSplitter.getInfo(String name)

Method parameters in org.apache.lucene.misc.index with type arguments of type SegmentCommitInfo

Modifier and Type	Method	Description
MergePolicy.MergeSpecification	BPReorderingMergePolicy.findForcedMerges(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentCommitInfo,Boolean> segmentsToMerge, MergePolicy.MergeContext mergeContext)