Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
LogMergePolicy.h
Go to the documentation of this file.
1
2// Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3// Distributable under the terms of either the Apache License (Version 2.0)
4// or the GNU Lesser General Public License.
6
7#ifndef LOGMERGEPOLICY_H
8#define LOGMERGEPOLICY_H
9
10#include "MergePolicy.h"
11
12namespace Lucene {
13
24class LPPAPI LogMergePolicy : public MergePolicy {
25public:
27 virtual ~LogMergePolicy();
28
30
31protected:
32 int32_t mergeFactor;
33
34 double noCFSRatio;
35
39
40public:
43 static const double LEVEL_LOG_SPAN;
44
46 static const int32_t DEFAULT_MERGE_FACTOR;
47
50 static const int32_t DEFAULT_MAX_MERGE_DOCS;
51
54 static const double DEFAULT_NO_CFS_RATIO;
55
56 int64_t minMergeSize;
57 int64_t maxMergeSize;
58 int32_t maxMergeDocs;
59
60public:
62 double getNoCFSRatio();
63
66 void setNoCFSRatio(double noCFSRatio);
67
70 int32_t getMergeFactor();
71
77 void setMergeFactor(int32_t mergeFactor);
78
80 virtual bool useCompoundFile(const SegmentInfosPtr& segments, const SegmentInfoPtr& newSegment);
81
83 void setUseCompoundFile(bool useCompoundFile);
84
88
90 virtual bool useCompoundDocStore(const SegmentInfosPtr& segments);
91
94 void setUseCompoundDocStore(bool useCompoundDocStore);
95
99
102 void setCalibrateSizeByDeletes(bool calibrateSizeByDeletes);
103
107
109 virtual void close();
110
115 virtual MergeSpecificationPtr findMergesForOptimize(const SegmentInfosPtr& segmentInfos, int32_t maxSegmentCount, SetSegmentInfo segmentsToOptimize);
116
120
126
135 void setMaxMergeDocs(int32_t maxMergeDocs);
136
140
141protected:
142 bool verbose();
143 void message(const String& message);
144
145 virtual int64_t size(const SegmentInfoPtr& info) = 0;
146
147 int64_t sizeDocs(const SegmentInfoPtr& info);
148 int64_t sizeBytes(const SegmentInfoPtr& info);
149
150 bool isOptimized(const SegmentInfosPtr& infos, int32_t maxNumSegments, SetSegmentInfo segmentsToOptimize);
151
154 bool isOptimized(const SegmentInfoPtr& info);
155
156 OneMergePtr makeOneMerge(const SegmentInfosPtr& infos, const SegmentInfosPtr& infosToMerge);
157};
158
159}
160
161#endif
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
This class implements a MergePolicy that tries to merge segments into levels of exponentially increas...
Definition LogMergePolicy.h:24
virtual void close()
Release all resources for the policy.
bool getUseCompoundFile()
Returns true if newly flushed and newly merge segments are written in compound file format.
virtual bool useCompoundFile(const SegmentInfosPtr &segments, const SegmentInfoPtr &newSegment)
Returns true if a newly flushed (not from merge) segment should use the compound file format.
bool isOptimized(const SegmentInfoPtr &info)
Returns true if this single info is optimized (has no pending norms or deletes, is in the same dir as...
int64_t sizeBytes(const SegmentInfoPtr &info)
int32_t mergeFactor
Definition LogMergePolicy.h:32
bool _useCompoundDocStore
Definition LogMergePolicy.h:38
virtual MergeSpecificationPtr findMergesToExpungeDeletes(const SegmentInfosPtr &segmentInfos)
Finds merges necessary to expunge all deletes from the index. We simply merge adjacent segments that ...
OneMergePtr makeOneMerge(const SegmentInfosPtr &infos, const SegmentInfosPtr &infosToMerge)
static const int32_t DEFAULT_MERGE_FACTOR
Default merge factor, which is how many segments are merged at a time.
Definition LogMergePolicy.h:46
static const double LEVEL_LOG_SPAN
Defines the allowed range of log(size) for each level. A level is computed by taking the max segment ...
Definition LogMergePolicy.h:43
bool getUseCompoundDocStore()
Returns true if newly flushed and newly merge doc store segment files (term vectors and stored fields...
void setCalibrateSizeByDeletes(bool calibrateSizeByDeletes)
Sets whether the segment size should be calibrated by the number of deletes when choosing segments fo...
LogMergePolicy(const IndexWriterPtr &writer)
int64_t maxMergeSize
Definition LogMergePolicy.h:57
int64_t minMergeSize
Definition LogMergePolicy.h:56
double noCFSRatio
Definition LogMergePolicy.h:34
void setUseCompoundFile(bool useCompoundFile)
Sets whether compound file format should be used for newly flushed and newly merged segments.
int32_t getMergeFactor()
Returns the number of segments that are merged at once and also controls the total number of segments...
bool isOptimized(const SegmentInfosPtr &infos, int32_t maxNumSegments, SetSegmentInfo segmentsToOptimize)
virtual bool useCompoundDocStore(const SegmentInfosPtr &segments)
Returns true if the doc store files should use the compound file format.
virtual MergeSpecificationPtr findMergesForOptimize(const SegmentInfosPtr &segmentInfos, int32_t maxSegmentCount, SetSegmentInfo segmentsToOptimize)
Returns the merges necessary to optimize the index. This merge policy defines "optimized" to mean onl...
void setUseCompoundDocStore(bool useCompoundDocStore)
Sets whether compound file format should be used for newly flushed and newly merged doc store segment...
bool _useCompoundFile
Definition LogMergePolicy.h:37
void message(const String &message)
int32_t maxMergeDocs
Definition LogMergePolicy.h:58
virtual int64_t size(const SegmentInfoPtr &info)=0
bool calibrateSizeByDeletes
Definition LogMergePolicy.h:36
void setMaxMergeDocs(int32_t maxMergeDocs)
Determines the largest segment (measured by document count) that may be merged with other segments....
void setNoCFSRatio(double noCFSRatio)
If a merged segment will be more than this percentage of the total size of the index,...
static const int32_t DEFAULT_MAX_MERGE_DOCS
Default maximum segment size. A segment of this size or larger will never be merged.
Definition LogMergePolicy.h:50
bool getCalibrateSizeByDeletes()
Returns true if the segment size should be calibrated by the number of deletes when choosing segments...
void setMergeFactor(int32_t mergeFactor)
Determines how often segment indices are merged by addDocument(). With smaller values,...
virtual MergeSpecificationPtr findMerges(const SegmentInfosPtr &segmentInfos)
Checks if any merges are now necessary and returns a MergePolicy.MergeSpecification if so....
int32_t getMaxMergeDocs()
Returns the largest segment (measured by document count) that may be merged with other segments.
static const double DEFAULT_NO_CFS_RATIO
Default noCFSRatio. If a merge's size is >= 10% of the index, then we disable compound file for it.
Definition LogMergePolicy.h:54
int64_t sizeDocs(const SegmentInfoPtr &info)
A MergePolicy determines the sequence of primitive merge operations to be used for overall merge and ...
Definition MergePolicy.h:32
Definition AbstractAllTermDocs.h:12
boost::shared_ptr< OneMerge > OneMergePtr
Definition LuceneTypes.h:192
boost::shared_ptr< MergeSpecification > MergeSpecificationPtr
Definition LuceneTypes.h:176
boost::shared_ptr< SegmentInfo > SegmentInfoPtr
Definition LuceneTypes.h:208
boost::shared_ptr< SegmentInfos > SegmentInfosPtr
Definition LuceneTypes.h:210
boost::shared_ptr< IndexWriter > IndexWriterPtr
Definition LuceneTypes.h:160

clucene.sourceforge.net