Class SegmentWriteState

Holder class for common parameters used during write.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
System.Object
SegmentWriteState
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public class SegmentWriteState

Constructors

| Improve this Doc View Source

SegmentWriteState(SegmentWriteState, String)

Create a shallow copy of SegmentWriteState with a new segment suffix.

Declaration
public SegmentWriteState(SegmentWriteState state, string segmentSuffix)
Parameters
Type Name Description
SegmentWriteState state
System.String segmentSuffix
| Improve this Doc View Source

SegmentWriteState(InfoStream, Directory, SegmentInfo, FieldInfos, Int32, BufferedUpdates, IOContext)

Sole constructor.

Declaration
public SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, int termIndexInterval, BufferedUpdates segUpdates, IOContext context)
Parameters
Type Name Description
InfoStream infoStream
Directory directory
SegmentInfo segmentInfo
FieldInfos fieldInfos
System.Int32 termIndexInterval
BufferedUpdates segUpdates
IOContext context
| Improve this Doc View Source

SegmentWriteState(InfoStream, Directory, SegmentInfo, FieldInfos, Int32, BufferedUpdates, IOContext, String)

Constructor which takes segment suffix.

Declaration
public SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, int termIndexInterval, BufferedUpdates segUpdates, IOContext context, string segmentSuffix)
Parameters
Type Name Description
InfoStream infoStream
Directory directory
SegmentInfo segmentInfo
FieldInfos fieldInfos
System.Int32 termIndexInterval
BufferedUpdates segUpdates
IOContext context
System.String segmentSuffix
See Also

Properties

| Improve this Doc View Source

Context

IOContext for all writes; you should pass this to CreateOutput(String, IOContext).

Declaration
public IOContext Context { get; }
Property Value
Type Description
IOContext
| Improve this Doc View Source

DelCountOnFlush

Number of deleted documents set while flushing the segment.

Declaration
public int DelCountOnFlush { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Directory

Directory where this segment will be written to.

Declaration
public Directory Directory { get; }
Property Value
Type Description
Directory
| Improve this Doc View Source

FieldInfos

FieldInfos describing all fields in this segment.

Declaration
public FieldInfos FieldInfos { get; }
Property Value
Type Description
FieldInfos
| Improve this Doc View Source

InfoStream

InfoStream used for debugging messages.

Declaration
public InfoStream InfoStream { get; }
Property Value
Type Description
InfoStream
| Improve this Doc View Source

LiveDocs

IMutableBits recording live documents; this is only set if there is one or more deleted documents.

Declaration
public IMutableBits LiveDocs { get; set; }
Property Value
Type Description
IMutableBits
| Improve this Doc View Source

SegmentInfo

SegmentInfo describing this segment.

Declaration
public SegmentInfo SegmentInfo { get; }
Property Value
Type Description
SegmentInfo
| Improve this Doc View Source

SegmentSuffix

Unique suffix for any postings files written for this segment. PerFieldPostingsFormat sets this for each of the postings formats it wraps. If you create a new PostingsFormat then any files you write/read must be derived using this suffix (use SegmentFileName(String, String, String)).

Declaration
public string SegmentSuffix { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SegUpdates

Deletes and updates to apply while we are flushing the segment. A Term is enrolled in here if it was deleted/updated at one point, and it's mapped to the docIDUpto, meaning any docID < docIDUpto containing this term should be deleted/updated.

Declaration
public BufferedUpdates SegUpdates { get; }
Property Value
Type Description
BufferedUpdates
| Improve this Doc View Source

TermIndexInterval

Expert: The fraction of terms in the "dictionary" which should be stored in RAM. Smaller values use more memory, but make searching slightly faster, while larger values use less memory and make searching slightly slower. Searching is typically not dominated by dictionary lookup, so tweaking this is rarely useful.

Declaration
public int TermIndexInterval { get; set; }
Property Value
Type Description
System.Int32