Class CheckIndex.Status

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

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
CheckIndex.Status
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 Status

Properties

| Improve this Doc View Source

CantOpenSegments

True if we were unable to open the segments_N file.

Declaration
public bool CantOpenSegments { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Clean

True if no problems were found with the index.

Declaration
public bool Clean { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Dir

Directory index is in.

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

MaxSegmentName

The greatest segment name.

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

MissingSegments

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

Declaration
public bool MissingSegments { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

MissingSegmentVersion

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

Declaration
public bool MissingSegmentVersion { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

NumBadSegments

How many bad segments were found.

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

NumSegments

Number of segments in the index.

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

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
System.Boolean
| Improve this Doc View Source

SegmentInfos

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

Declaration
public IList<CheckIndex.Status.SegmentInfoStatus> SegmentInfos { get; }
Property Value
Type Description
System.Collections.Generic.IList<CheckIndex.Status.SegmentInfoStatus>
| Improve this Doc View Source

SegmentsChecked

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

Declaration
public IList<string> SegmentsChecked { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>
See Also
| Improve this Doc View Source

SegmentsFileName

Name of latest segments_N file in the index.

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

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
System.Boolean
| Improve this Doc View Source

TotLoseDocCount

How many documents will be lost to bad segments.

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

UserData

Holds the userData of the last commit in the index

Declaration
public IDictionary<string, string> UserData { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.String>
| Improve this Doc View Source

ValidCounter

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

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