Lucene.Net
3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
|
Expert: a MergePolicy determines the sequence of primitive merge operations to be used for overall merge and optimize operations. More...
Inherits IDisposable.
Inherited by Lucene.Net.Index.LogMergePolicy.
Classes | |
class | MergeAbortedException |
class | MergeException |
Exception thrown if there are any problems while executing a merge. More... | |
class | MergeSpecification |
A MergeSpecification instance provides the information necessary to perform multiple merges. It simply contains a list of OneMerge instances. More... | |
class | OneMerge |
OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment. The merge spec includes the subset of segments to be merged as well as whether the new segment should use the compound file format. More... | |
Public Member Functions | |
abstract MergeSpecification | FindMerges (SegmentInfos segmentInfos) |
Determine what set of merge operations are now necessary on the index. IndexWriter calls this whenever there is a change to the segments. This call is always synchronized on the IndexWriter instance so only one thread at a time will call this method. | |
abstract MergeSpecification | FindMergesForOptimize (SegmentInfos segmentInfos, int maxSegmentCount, ISet< SegmentInfo > segmentsToOptimize) |
Determine what set of merge operations is necessary in order to optimize the index. IndexWriter calls this when its IndexWriter.Optimize() method is called. This call is always synchronized on the IndexWriter instance so only one thread at a time will call this method. | |
abstract MergeSpecification | FindMergesToExpungeDeletes (SegmentInfos segmentInfos) |
Determine what set of merge operations is necessary in order to expunge all deletes from the index. | |
void | Close () |
Release all resources for the policy. | |
void | Dispose () |
Release all resources for the policy. | |
abstract bool | UseCompoundFile (SegmentInfos segments, SegmentInfo newSegment) |
Returns true if a newly flushed (not from merge) segment should use the compound file format. | |
abstract bool | UseCompoundDocStore (SegmentInfos segments) |
Returns true if the doc store files should use the compound file format. | |
Protected Member Functions | |
MergePolicy (IndexWriter writer) | |
abstract void | Dispose (bool disposing) |
Expert: a MergePolicy determines the sequence of primitive merge operations to be used for overall merge and optimize operations.
Whenever the segments in an index have been altered by IndexWriter, either the addition of a newly flushed segment, addition of many segments from addIndexes* calls, or a previous merge that may now need to cascade, IndexWriter invokes FindMerges to give the MergePolicy a chance to pick merges that are now required. This method returns a MergeSpecification instance describing the set of merges that should be done, or null if no merges are necessary. When IndexWriter.optimize is called, it calls FindMergesForOptimize and the MergePolicy should then return the necessary merges.
Note that the policy can return more than one merge at a time. In this case, if the writer is using SerialMergeScheduler , the merges will be run sequentially but if it is using ConcurrentMergeScheduler they will be run concurrently.
The default MergePolicy is LogByteSizeMergePolicy .
NOTE: This API is new and still experimental (subject to change suddenly in the next release)
NOTE: This class typically requires access to package-private APIs (e.g. SegmentInfos
) to do its job; if you implement your own MergePolicy, you'll need to put it in package Lucene.Net.Index in order to use these APIs.
Definition at line 61 of file MergePolicy.cs.
|
protected |
Definition at line 243 of file MergePolicy.cs.
void Lucene.Net.Index.MergePolicy.Close | ( | ) |
Release all resources for the policy.
Definition at line 286 of file MergePolicy.cs.
void Lucene.Net.Index.MergePolicy.Dispose | ( | ) |
Release all resources for the policy.
Definition at line 292 of file MergePolicy.cs.
|
protectedpure virtual |
Implemented in Lucene.Net.Index.LogByteSizeMergePolicy, and Lucene.Net.Index.LogDocMergePolicy.
|
pure virtual |
Determine what set of merge operations are now necessary on the index. IndexWriter calls this whenever there is a change to the segments. This call is always synchronized on the IndexWriter instance so only one thread at a time will call this method.
segmentInfos | the total set of segments in the index |
Implemented in Lucene.Net.Index.LogMergePolicy.
|
pure virtual |
Determine what set of merge operations is necessary in order to optimize the index. IndexWriter calls this when its IndexWriter.Optimize() method is called. This call is always synchronized on the IndexWriter instance so only one thread at a time will call this method.
segmentInfos | the total set of segments in the index |
maxSegmentCount | requested maximum number of segments in the index (currently this is always 1) |
segmentsToOptimize | contains the specific SegmentInfo instances that must be merged away. This may be a subset of all SegmentInfos. |
Implemented in Lucene.Net.Index.LogMergePolicy.
|
pure virtual |
Determine what set of merge operations is necessary in order to expunge all deletes from the index.
segmentInfos | the total set of segments in the index |
Implemented in Lucene.Net.Index.LogMergePolicy.
|
pure virtual |
Returns true if the doc store files should use the compound file format.
Implemented in Lucene.Net.Index.LogMergePolicy.
|
pure virtual |
Returns true if a newly flushed (not from merge) segment should use the compound file format.
Implemented in Lucene.Net.Index.LogMergePolicy.