Basic tool and API to check the health of an index and
write a new segments file that removes reference to
problematic segments.
As this tool checks every byte in the index, on a large
index it can take quite a long time to run.
WARNING: this tool and API is new and
experimental and is subject to suddenly change in the
next release. Please make a complete backup of your
index before using this to fix your index!
The CheckIndex..::..Status type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CheckIndex..::..Status | Initializes a new instance of the CheckIndex..::..Status class |
Methods
| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
 | cantOpenSegments | True if we were unable to open the segments_N file. |
| clean | True if no problems were found with the index. |
| dir | Directory index is in. |
| missingSegments | True if we were unable to locate and load the segments_N file. |
| missingSegmentVersion | True if we were unable to read the version number from segments_N file. |
| numBadSegments | How many bad segments were found. |
| numSegments | Number of segments in the index. |
| partial | True if we checked only specific segments ({@link
#CheckIndex(List)}) was called with non-null
argument).
|
| segmentFormat | String description of the version of the index. |
| segmentInfos | List of {@link SegmentInfoStatus} instances, detailing status of each segment. |
| segmentsChecked | Empty unless you passed specific segments list to check as optional 3rd argument. |
| segmentsFileName | Name of latest segments_N file in the index. |
| toolOutOfDate | True if the index was created with a newer version of Lucene than the CheckIndex tool. |
| totLoseDocCount | How many documents will be lost to bad segments. |
| userData | Holds the userData of the last commit in the index |
