Package org.apache.lucene.index
Class UpgradeIndexMergePolicy
- java.lang.Object
-
- org.apache.lucene.index.MergePolicy
-
- org.apache.lucene.index.UpgradeIndexMergePolicy
-
- All Implemented Interfaces:
Closeable,AutoCloseable
public class UpgradeIndexMergePolicy extends MergePolicy
ThisMergePolicyis used for upgrading all existing segments of an index when callingIndexWriter.forceMerge(int). All other methods delegate to the baseMergePolicygiven to the constructor. This allows for an as-cheap-as possible upgrade of an older index by only upgrading segments that are created by previous Lucene versions. forceMerge does no longer really merge; it is just used to "forceMerge" older segment versions away.In general one would use
IndexUpgrader, but for a fully customizeable upgrade, you can use this like any otherMergePolicyand callIndexWriter.forceMerge(int):IndexWriterConfig iwc = new IndexWriterConfig(Version.LUCENE_XX, new KeywordAnalyzer()); iwc.setMergePolicy(new UpgradeIndexMergePolicy(iwc.getMergePolicy())); IndexWriter w = new IndexWriter(dir, iwc); w.forceMerge(1); w.close();
Warning: This merge policy may reorder documents if the index was partially upgraded before calling forceMerge (e.g., documents were added). If your application relies on "monotonicity" of doc IDs (which means that the order in which the documents were added to the index is preserved), do a forceMerge(1) instead. Please note, the delegate
MergePolicymay also reorder documents.- See Also:
IndexUpgrader- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.MergePolicy
MergePolicy.MergeAbortedException, MergePolicy.MergeException, MergePolicy.MergeSpecification, MergePolicy.OneMerge
-
-
Field Summary
Fields Modifier and Type Field Description protected MergePolicybase-
Fields inherited from class org.apache.lucene.index.MergePolicy
writer
-
-
Constructor Summary
Constructors Constructor Description UpgradeIndexMergePolicy(MergePolicy base)Wrap the givenMergePolicyand intercept forceMerge requests to only upgrade segments written with previous Lucene versions.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Release all resources for the policy.MergePolicy.MergeSpecificationfindForcedDeletesMerges(SegmentInfos segmentInfos)Determine what set of merge operations is necessary in order to expunge all deletes from the index.MergePolicy.MergeSpecificationfindForcedMerges(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentInfo,Boolean> segmentsToMerge)Determine what set of merge operations is necessary in order to merge to <= the specified segment count.MergePolicy.MergeSpecificationfindMerges(SegmentInfos segmentInfos)Determine what set of merge operations are now necessary on the index.voidsetIndexWriter(IndexWriter writer)Sets theIndexWriterto use by this merge policy.protected booleanshouldUpgradeSegment(SegmentInfo si)Returns if the given segment should be upgraded.StringtoString()booleanuseCompoundFile(SegmentInfos segments, SegmentInfo newSegment)Returns true if a new segment (regardless of its origin) should use the compound file format.
-
-
-
Field Detail
-
base
protected final MergePolicy base
-
-
Constructor Detail
-
UpgradeIndexMergePolicy
public UpgradeIndexMergePolicy(MergePolicy base)
Wrap the givenMergePolicyand intercept forceMerge requests to only upgrade segments written with previous Lucene versions.
-
-
Method Detail
-
shouldUpgradeSegment
protected boolean shouldUpgradeSegment(SegmentInfo si)
Returns if the given segment should be upgraded. The default implementation will return!Constants.LUCENE_MAIN_VERSION.equals(si.getVersion()), so all segments created with a different version number than this Lucene version will get upgraded.
-
setIndexWriter
public void setIndexWriter(IndexWriter writer)
Description copied from class:MergePolicySets theIndexWriterto use by this merge policy. This method is allowed to be called only once, and is usually set by IndexWriter. If it is called more than once,SetOnce.AlreadySetExceptionis thrown.- Overrides:
setIndexWriterin classMergePolicy- See Also:
SetOnce
-
findMerges
public MergePolicy.MergeSpecification findMerges(SegmentInfos segmentInfos) throws CorruptIndexException, IOException
Description copied from class:MergePolicyDetermine what set of merge operations are now necessary on the index.IndexWritercalls this whenever there is a change to the segments. This call is always synchronized on theIndexWriterinstance so only one thread at a time will call this method.- Specified by:
findMergesin classMergePolicy- Parameters:
segmentInfos- the total set of segments in the index- Throws:
CorruptIndexExceptionIOException
-
findForcedMerges
public MergePolicy.MergeSpecification findForcedMerges(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentInfo,Boolean> segmentsToMerge) throws CorruptIndexException, IOException
Description copied from class:MergePolicyDetermine what set of merge operations is necessary in order to merge to <= the specified segment count.IndexWritercalls this when itsIndexWriter.forceMerge(int)method is called. This call is always synchronized on theIndexWriterinstance so only one thread at a time will call this method.- Specified by:
findForcedMergesin classMergePolicy- Parameters:
segmentInfos- the total set of segments in the indexmaxSegmentCount- requested maximum number of segments in the index (currently this is always 1)segmentsToMerge- contains the specific SegmentInfo instances that must be merged away. This may be a subset of all SegmentInfos. If the value is True for a given SegmentInfo, that means this segment was an original segment present in the to-be-merged index; else, it was a segment produced by a cascaded merge.- Throws:
CorruptIndexExceptionIOException
-
findForcedDeletesMerges
public MergePolicy.MergeSpecification findForcedDeletesMerges(SegmentInfos segmentInfos) throws CorruptIndexException, IOException
Description copied from class:MergePolicyDetermine what set of merge operations is necessary in order to expunge all deletes from the index.- Specified by:
findForcedDeletesMergesin classMergePolicy- Parameters:
segmentInfos- the total set of segments in the index- Throws:
CorruptIndexExceptionIOException
-
useCompoundFile
public boolean useCompoundFile(SegmentInfos segments, SegmentInfo newSegment) throws IOException
Description copied from class:MergePolicyReturns true if a new segment (regardless of its origin) should use the compound file format.- Specified by:
useCompoundFilein classMergePolicy- Throws:
IOException
-
close
public void close()
Description copied from class:MergePolicyRelease all resources for the policy.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classMergePolicy
-
-