Class CheckIndex.Status

Returned from DoCheckIndex() detailing the health and status of the index.

Note

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

Inheritance
object
CheckIndex.Status
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public class CheckIndex.Status

Properties

CantOpenSegments

True if we were unable to open the segments_N file.

Declaration
public bool CantOpenSegments { get; }
Property Value
Type Description
bool

Clean

True if no problems were found with the index.

Declaration
public bool Clean { get; }
Property Value
Type Description
bool

Dir

Directory index is in.

Declaration
public Directory Dir { get; }
Property Value
Type Description
Directory

MaxSegmentName

The greatest segment name.

Declaration
public int MaxSegmentName { get; }
Property Value
Type Description
int

MissingSegmentVersion

True if we were unable to read the version number from segments_N file.

Declaration
public bool MissingSegmentVersion { get; }
Property Value
Type Description
bool

MissingSegments

True if we were unable to locate and load the segments_N file.

Declaration
public bool MissingSegments { get; }
Property Value
Type Description
bool

NumBadSegments

How many bad segments were found.

Declaration
public int NumBadSegments { get; }
Property Value
Type Description
int

NumSegments

Number of segments in the index.

Declaration
public int NumSegments { get; }
Property Value
Type Description
int

Partial

True if we checked only specific segments (DoCheckIndex(IList<string>) was called with non-null argument).

Declaration
public bool Partial { get; }
Property Value
Type Description
bool

SegmentInfos

List of CheckIndex.Status.SegmentInfoStatus instances, detailing status of each segment.

Declaration
public IList<CheckIndex.Status.SegmentInfoStatus> SegmentInfos { get; }
Property Value
Type Description
IList<CheckIndex.Status.SegmentInfoStatus>

SegmentsChecked

Empty unless you passed specific segments list to check as optional 3rd argument.

Declaration
public IList<string> SegmentsChecked { get; }
Property Value
Type Description
IList<string>
See Also

SegmentsFileName

Name of latest segments_N file in the index.

Declaration
public string SegmentsFileName { get; }
Property Value
Type Description
string

ToolOutOfDate

True if the index was created with a newer version of Lucene than the CheckIndex tool.

Declaration
public bool ToolOutOfDate { get; }
Property Value
Type Description
bool

TotLoseDocCount

How many documents will be lost to bad segments.

Declaration
public int TotLoseDocCount { get; }
Property Value
Type Description
int

UserData

Holds the userData of the last commit in the index

Declaration
public IDictionary<string, string> UserData { get; }
Property Value
Type Description
IDictionary<string, string>

ValidCounter

Whether the Counter is greater than any of the segments' names.

Declaration
public bool ValidCounter { get; }
Property Value
Type Description
bool