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
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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.
*/
#include "mongo/db/exec/text.h"
#include <memory>
#include <vector>
#include "mongo/db/exec/fetch.h"
#include "mongo/db/exec/filter.h"
#include "mongo/db/exec/index_scan.h"
#include "mongo/db/exec/or.h"
#include "mongo/db/exec/scoped_timer.h"
#include "mongo/db/exec/text_match.h"
#include "mongo/db/exec/text_or.h"
#include "mongo/db/exec/working_set.h"
#include "mongo/db/fts/fts_index_format.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/query/internal_plans.h"
namespace mongo {
using std::string;
using std::unique_ptr;
using std::vector;
using fts::FTSIndexFormat;
using fts::MAX_WEIGHT;
const char* TextStage::kStageType = "TEXT";
TextStage::TextStage(OperationContext* opCtx,
const TextStageParams& params,
WorkingSet* ws,
const MatchExpression* filter)
: PlanStage(kStageType, opCtx), _params(params) {
_children.emplace_back(buildTextTree(opCtx, ws, filter, params.wantTextScore));
_specificStats.indexPrefix = _params.indexPrefix;
_specificStats.indexName = _params.index->indexName();
_specificStats.parsedTextQuery = _params.query.toBSON();
_specificStats.textIndexVersion = _params.index->infoObj()["textIndexVersion"].numberInt();
}
bool TextStage::isEOF() {
return child()->isEOF();
}
PlanStage::StageState TextStage::doWork(WorkingSetID* out) {
if (isEOF()) {
return PlanStage::IS_EOF;
}
return child()->work(out);
}
unique_ptr<PlanStageStats> TextStage::getStats() {
_commonStats.isEOF = isEOF();
unique_ptr<PlanStageStats> ret = std::make_unique<PlanStageStats>(_commonStats, STAGE_TEXT);
ret->specific = std::make_unique<TextStats>(_specificStats);
ret->children.emplace_back(child()->getStats());
return ret;
}
const SpecificStats* TextStage::getSpecificStats() const {
return &_specificStats;
}
unique_ptr<PlanStage> TextStage::buildTextTree(OperationContext* opCtx,
WorkingSet* ws,
const MatchExpression* filter,
bool wantTextScore) const {
const auto* collection = _params.index->getCollection();
// Get all the index scans for each term in our query.
std::vector<std::unique_ptr<PlanStage>> indexScanList;
for (const auto& term : _params.query.getTermsForBounds()) {
IndexScanParams ixparams(opCtx, _params.index);
ixparams.bounds.startKey = FTSIndexFormat::getIndexKey(
MAX_WEIGHT, term, _params.indexPrefix, _params.spec.getTextIndexVersion());
ixparams.bounds.endKey = FTSIndexFormat::getIndexKey(
0, term, _params.indexPrefix, _params.spec.getTextIndexVersion());
ixparams.bounds.boundInclusion = BoundInclusion::kIncludeBothStartAndEndKeys;
ixparams.bounds.isSimpleRange = true;
ixparams.direction = -1;
ixparams.shouldDedup = _params.index->isMultikey();
indexScanList.push_back(std::make_unique<IndexScan>(opCtx, ixparams, ws, nullptr));
}
// Build the union of the index scans as a TEXT_OR or an OR stage, depending on whether the
// projection requires the "textScore" $meta field.
std::unique_ptr<PlanStage> textMatchStage;
if (wantTextScore) {
// We use a TEXT_OR stage to get the union of the results from the index scans and then
// compute their text scores. This is a blocking operation.
auto textScorer =
std::make_unique<TextOrStage>(opCtx, _params.spec, ws, filter, collection);
textScorer->addChildren(std::move(indexScanList));
textMatchStage = std::make_unique<TextMatchStage>(
opCtx, std::move(textScorer), _params.query, _params.spec, ws);
} else {
// Because we don't need the text score, we can use a non-blocking OR stage to get the union
// of the index scans.
auto textSearcher = std::make_unique<OrStage>(opCtx, ws, true, filter);
textSearcher->addChildren(std::move(indexScanList));
// Unlike the TEXT_OR stage, the OR stage does not fetch the documents that it outputs. We
// add our own FETCH stage to satisfy the requirement of the TEXT_MATCH stage that its
// WorkingSetMember inputs have fetched data.
const MatchExpression* emptyFilter = nullptr;
auto fetchStage = std::make_unique<FetchStage>(
opCtx, ws, textSearcher.release(), emptyFilter, collection);
textMatchStage = std::make_unique<TextMatchStage>(
opCtx, std::move(fetchStage), _params.query, _params.spec, ws);
}
return textMatchStage;
}
} // namespace mongo
|
