1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/**
* Copyright (C) 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/db/diskloc.h"
#include "mongo/db/exec/plan_stage.h"
#include "mongo/db/fts/fts_index_format.h"
#include "mongo/db/fts/fts_matcher.h"
#include "mongo/db/fts/fts_query.h"
#include "mongo/db/fts/fts_spec.h"
#include "mongo/db/fts/fts_util.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/matcher/expression.h"
#include "mongo/platform/unordered_map.h"
#include <map>
#include <queue>
#include <vector>
namespace mongo {
using fts::FTSIndexFormat;
using fts::FTSMatcher;
using fts::FTSQuery;
using fts::FTSSpec;
using fts::MAX_WEIGHT;
struct TextStageParams {
TextStageParams(const FTSSpec& s) : spec(s) {}
// Text index descriptor. IndexCatalog owns this.
IndexDescriptor* index;
// Index spec.
FTSSpec spec;
// Index keys that precede the "text" index key.
BSONObj indexPrefix;
// The text query.
FTSQuery query;
};
/**
* Implements a blocking stage that returns text search results.
*
* Prerequisites: None; is a leaf node.
* Output type: LOC_AND_OBJ_UNOWNED.
*/
class TextStage : public PlanStage {
public:
/**
* The text stage has a few 'states' it transitions between.
*/
enum State {
// 1. Initialize the index scans we use to retrieve term/score info.
INIT_SCANS,
// 2. Read the terms/scores from the text index.
READING_TERMS,
// 3. Return results to our parent.
RETURNING_RESULTS,
// 4. Done.
DONE,
};
TextStage(const TextStageParams& params, WorkingSet* ws, const MatchExpression* filter);
virtual ~TextStage();
virtual StageState work(WorkingSetID* out);
virtual bool isEOF();
virtual void prepareToYield();
virtual void recoverFromYield();
virtual void invalidate(const DiskLoc& dl, InvalidationType type);
PlanStageStats* getStats();
static const char* kStageType;
private:
/**
* Initializes sub-scanners.
*/
StageState initScans(WorkingSetID* out);
/**
* Helper for buffering results array. Returns NEED_TIME (if any results were produced),
* IS_EOF, or FAILURE.
*/
StageState readFromSubScanners(WorkingSetID* out);
/**
* Helper called from readFromSubScanners to update aggregate score with a new-found (term,
* score) pair for this document. Also rejects documents that don't match this stage's
* filter.
*/
void addTerm(const BSONObj& key, const DiskLoc& loc);
/**
* Possibly return a result. FYI, this may perform a fetch directly if it is needed to
* evaluate all filters.
*/
StageState returnResults(WorkingSetID* out);
// Parameters of this text stage.
TextStageParams _params;
// Text-specific phrase and negated term matcher.
FTSMatcher _ftsMatcher;
// Working set. Not owned by us.
WorkingSet* _ws;
// Filter. Not owned by us.
const MatchExpression* _filter;
// Stats.
CommonStats _commonStats;
TextStats _specificStats;
// What state are we in? See the State enum above.
State _internalState;
// Used in INIT_SCANS and READING_TERMS. The index scans we're using to retrieve text
// terms.
OwnedPointerVector<PlanStage> _scanners;
// Which _scanners are we currently reading from?
size_t _currentIndexScanner;
// Temporary score data filled out by sub-scans. Used in READING_TERMS and
// RETURNING_RESULTS.
// Maps from diskloc -> aggregate score for doc.
typedef unordered_map<DiskLoc, double, DiskLoc::Hasher> ScoreMap;
ScoreMap _scores;
ScoreMap::const_iterator _scoreIterator;
};
} // namespace mongo
|
