|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.index.MergePolicy org.apache.lucene.index.UpgradeIndexMergePolicy
public class UpgradeIndexMergePolicy
This MergePolicy
is used for upgrading all existing segments of
an index when calling IndexWriter.optimize()
.
All other methods delegate to the base MergePolicy
given 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. Optimize does no longer really optimize
it is just used to "optimize" older segment versions away.
In general one would use IndexUpgrader
, but for a fully customizeable upgrade,
you can use this like any other MergePolicy
and call IndexWriter.optimize()
:
IndexWriterConfig iwc = new IndexWriterConfig(Version.LUCENE_XX, new KeywordAnalyzer()); iwc.setMergePolicy(new UpgradeIndexMergePolicy(iwc.getMergePolicy())); IndexWriter w = new IndexWriter(dir, iwc); w.optimize(); w.close();
Warning: This merge policy may reorder documents if the index was partially
upgraded before calling optimize (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 full optimize instead. Please note, the
delegate MergePolicy
may also reorder documents.
IndexUpgrader
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.index.MergePolicy |
---|
MergePolicy.MergeAbortedException, MergePolicy.MergeException, MergePolicy.MergeSpecification, MergePolicy.OneMerge |
Field Summary | |
---|---|
protected MergePolicy |
base
|
Fields inherited from class org.apache.lucene.index.MergePolicy |
---|
writer |
Constructor Summary | |
---|---|
UpgradeIndexMergePolicy(MergePolicy base)
Wrap the given MergePolicy and intercept optimize requests to
only upgrade segments written with previous Lucene versions. |
Method Summary | |
---|---|
void |
close()
Release all resources for the policy. |
MergePolicy.MergeSpecification |
findMerges(SegmentInfos segmentInfos)
Determine what set of merge operations are now necessary on the index. |
MergePolicy.MergeSpecification |
findMergesForOptimize(SegmentInfos segmentInfos,
int maxSegmentCount,
Map<SegmentInfo,Boolean> segmentsToOptimize)
Determine what set of merge operations is necessary in order to optimize the index. |
MergePolicy.MergeSpecification |
findMergesToExpungeDeletes(SegmentInfos segmentInfos)
Determine what set of merge operations is necessary in order to expunge all deletes from the index. |
void |
setIndexWriter(IndexWriter writer)
Sets the IndexWriter to use by this merge policy. |
protected boolean |
shouldUpgradeSegment(SegmentInfo si)
Returns if the given segment should be upgraded. |
String |
toString()
|
boolean |
useCompoundFile(SegmentInfos segments,
SegmentInfo newSegment)
Returns true if a new segment (regardless of its origin) should use the compound file format. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final MergePolicy base
Constructor Detail |
---|
public UpgradeIndexMergePolicy(MergePolicy base)
MergePolicy
and intercept optimize requests to
only upgrade segments written with previous Lucene versions.
Method Detail |
---|
protected boolean shouldUpgradeSegment(SegmentInfo si)
!Constants.LUCENE_MAIN_VERSION.equals(si.getVersion())
,
so all segments created with a different version number than this Lucene version will
get upgraded.
public void setIndexWriter(IndexWriter writer)
MergePolicy
IndexWriter
to 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.AlreadySetException
is thrown.
setIndexWriter
in class MergePolicy
SetOnce
public MergePolicy.MergeSpecification findMerges(SegmentInfos segmentInfos) throws CorruptIndexException, IOException
MergePolicy
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.
findMerges
in class MergePolicy
segmentInfos
- the total set of segments in the index
CorruptIndexException
IOException
public MergePolicy.MergeSpecification findMergesForOptimize(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentInfo,Boolean> segmentsToOptimize) throws CorruptIndexException, IOException
MergePolicy
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.
findMergesForOptimize
in class MergePolicy
segmentInfos
- the total set of segments in the indexmaxSegmentCount
- 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. If the value is True for a
given SegmentInfo, that means this segment was
an original segment present in the
to-be-optimized index; else, it was a segment
produced by a cascaded merge.
CorruptIndexException
IOException
public MergePolicy.MergeSpecification findMergesToExpungeDeletes(SegmentInfos segmentInfos) throws CorruptIndexException, IOException
MergePolicy
findMergesToExpungeDeletes
in class MergePolicy
segmentInfos
- the total set of segments in the index
CorruptIndexException
IOException
public boolean useCompoundFile(SegmentInfos segments, SegmentInfo newSegment) throws IOException
MergePolicy
useCompoundFile
in class MergePolicy
IOException
public void close()
MergePolicy
close
in interface Closeable
close
in class MergePolicy
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |