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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
/**
* Copyright (C) 2013-2014 MongoDB 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kQuery
#include "mongo/platform/basic.h"
#include "mongo/db/query/stage_builder.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/database.h"
#include "mongo/db/catalog/index_catalog.h"
#include "mongo/db/client.h"
#include "mongo/db/exec/and_hash.h"
#include "mongo/db/exec/and_sorted.h"
#include "mongo/db/exec/collection_scan.h"
#include "mongo/db/exec/count_scan.h"
#include "mongo/db/exec/distinct_scan.h"
#include "mongo/db/exec/ensure_sorted.h"
#include "mongo/db/exec/fetch.h"
#include "mongo/db/exec/geo_near.h"
#include "mongo/db/exec/index_scan.h"
#include "mongo/db/exec/keep_mutations.h"
#include "mongo/db/exec/limit.h"
#include "mongo/db/exec/merge_sort.h"
#include "mongo/db/exec/or.h"
#include "mongo/db/exec/projection.h"
#include "mongo/db/exec/shard_filter.h"
#include "mongo/db/exec/skip.h"
#include "mongo/db/exec/sort.h"
#include "mongo/db/exec/sort_key_generator.h"
#include "mongo/db/exec/text.h"
#include "mongo/db/index/fts_access_method.h"
#include "mongo/db/matcher/extensions_callback_real.h"
#include "mongo/db/s/collection_sharding_state.h"
#include "mongo/stdx/memory.h"
#include "mongo/util/log.h"
namespace mongo {
using std::unique_ptr;
using stdx::make_unique;
PlanStage* buildStages(OperationContext* opCtx,
Collection* collection,
const CanonicalQuery& cq,
const QuerySolution& qsol,
const QuerySolutionNode* root,
WorkingSet* ws) {
switch (root->getType()) {
case STAGE_COLLSCAN: {
const CollectionScanNode* csn = static_cast<const CollectionScanNode*>(root);
CollectionScanParams params;
params.collection = collection;
params.tailable = csn->tailable;
params.shouldTrackLatestOplogTimestamp = csn->shouldTrackLatestOplogTimestamp;
params.direction = (csn->direction == 1) ? CollectionScanParams::FORWARD
: CollectionScanParams::BACKWARD;
params.maxScan = csn->maxScan;
return new CollectionScan(opCtx, params, ws, csn->filter.get());
}
case STAGE_IXSCAN: {
const IndexScanNode* ixn = static_cast<const IndexScanNode*>(root);
if (nullptr == collection) {
warning() << "Can't ixscan null namespace";
return nullptr;
}
IndexScanParams params;
params.descriptor =
collection->getIndexCatalog()->findIndexByName(opCtx, ixn->index.name);
invariant(params.descriptor);
params.bounds = ixn->bounds;
params.direction = ixn->direction;
params.maxScan = ixn->maxScan;
params.addKeyMetadata = ixn->addKeyMetadata;
return new IndexScan(opCtx, params, ws, ixn->filter.get());
}
case STAGE_FETCH: {
const FetchNode* fn = static_cast<const FetchNode*>(root);
PlanStage* childStage = buildStages(opCtx, collection, cq, qsol, fn->children[0], ws);
if (nullptr == childStage) {
return nullptr;
}
return new FetchStage(opCtx, ws, childStage, fn->filter.get(), collection);
}
case STAGE_SORT: {
const SortNode* sn = static_cast<const SortNode*>(root);
PlanStage* childStage = buildStages(opCtx, collection, cq, qsol, sn->children[0], ws);
if (nullptr == childStage) {
return nullptr;
}
SortStageParams params;
params.collection = collection;
params.pattern = sn->pattern;
params.limit = sn->limit;
return new SortStage(opCtx, params, ws, childStage);
}
case STAGE_SORT_KEY_GENERATOR: {
const SortKeyGeneratorNode* keyGenNode = static_cast<const SortKeyGeneratorNode*>(root);
PlanStage* childStage =
buildStages(opCtx, collection, cq, qsol, keyGenNode->children[0], ws);
if (nullptr == childStage) {
return nullptr;
}
return new SortKeyGeneratorStage(
opCtx, childStage, ws, keyGenNode->sortSpec, cq.getCollator());
}
case STAGE_PROJECTION: {
const ProjectionNode* pn = static_cast<const ProjectionNode*>(root);
PlanStage* childStage = buildStages(opCtx, collection, cq, qsol, pn->children[0], ws);
if (nullptr == childStage) {
return nullptr;
}
ProjectionStageParams params;
params.projObj = pn->projection;
params.collator = cq.getCollator();
// Stuff the right data into the params depending on what proj impl we use.
if (ProjectionNode::DEFAULT == pn->projType) {
params.fullExpression = pn->fullExpression;
params.projImpl = ProjectionStageParams::NO_FAST_PATH;
} else if (ProjectionNode::COVERED_ONE_INDEX == pn->projType) {
params.projImpl = ProjectionStageParams::COVERED_ONE_INDEX;
params.coveredKeyObj = pn->coveredKeyObj;
invariant(!pn->coveredKeyObj.isEmpty());
} else {
invariant(ProjectionNode::SIMPLE_DOC == pn->projType);
params.projImpl = ProjectionStageParams::SIMPLE_DOC;
}
return new ProjectionStage(opCtx, params, ws, childStage);
}
case STAGE_LIMIT: {
const LimitNode* ln = static_cast<const LimitNode*>(root);
PlanStage* childStage = buildStages(opCtx, collection, cq, qsol, ln->children[0], ws);
if (nullptr == childStage) {
return nullptr;
}
return new LimitStage(opCtx, ln->limit, ws, childStage);
}
case STAGE_SKIP: {
const SkipNode* sn = static_cast<const SkipNode*>(root);
PlanStage* childStage = buildStages(opCtx, collection, cq, qsol, sn->children[0], ws);
if (nullptr == childStage) {
return nullptr;
}
return new SkipStage(opCtx, sn->skip, ws, childStage);
}
case STAGE_AND_HASH: {
const AndHashNode* ahn = static_cast<const AndHashNode*>(root);
auto ret = make_unique<AndHashStage>(opCtx, ws, collection);
for (size_t i = 0; i < ahn->children.size(); ++i) {
PlanStage* childStage =
buildStages(opCtx, collection, cq, qsol, ahn->children[i], ws);
if (nullptr == childStage) {
return nullptr;
}
ret->addChild(childStage);
}
return ret.release();
}
case STAGE_OR: {
const OrNode* orn = static_cast<const OrNode*>(root);
auto ret = make_unique<OrStage>(opCtx, ws, orn->dedup, orn->filter.get());
for (size_t i = 0; i < orn->children.size(); ++i) {
PlanStage* childStage =
buildStages(opCtx, collection, cq, qsol, orn->children[i], ws);
if (nullptr == childStage) {
return nullptr;
}
ret->addChild(childStage);
}
return ret.release();
}
case STAGE_AND_SORTED: {
const AndSortedNode* asn = static_cast<const AndSortedNode*>(root);
auto ret = make_unique<AndSortedStage>(opCtx, ws, collection);
for (size_t i = 0; i < asn->children.size(); ++i) {
PlanStage* childStage =
buildStages(opCtx, collection, cq, qsol, asn->children[i], ws);
if (nullptr == childStage) {
return nullptr;
}
ret->addChild(childStage);
}
return ret.release();
}
case STAGE_SORT_MERGE: {
const MergeSortNode* msn = static_cast<const MergeSortNode*>(root);
MergeSortStageParams params;
params.dedup = msn->dedup;
params.pattern = msn->sort;
params.collator = cq.getCollator();
auto ret = make_unique<MergeSortStage>(opCtx, params, ws, collection);
for (size_t i = 0; i < msn->children.size(); ++i) {
PlanStage* childStage =
buildStages(opCtx, collection, cq, qsol, msn->children[i], ws);
if (nullptr == childStage) {
return nullptr;
}
ret->addChild(childStage);
}
return ret.release();
}
case STAGE_GEO_NEAR_2D: {
const GeoNear2DNode* node = static_cast<const GeoNear2DNode*>(root);
GeoNearParams params;
params.nearQuery = node->nq;
params.baseBounds = node->baseBounds;
params.filter = node->filter.get();
params.addPointMeta = node->addPointMeta;
params.addDistMeta = node->addDistMeta;
IndexDescriptor* twoDIndex =
collection->getIndexCatalog()->findIndexByName(opCtx, node->index.name);
invariant(twoDIndex);
GeoNear2DStage* nearStage =
new GeoNear2DStage(params, opCtx, ws, collection, twoDIndex);
return nearStage;
}
case STAGE_GEO_NEAR_2DSPHERE: {
const GeoNear2DSphereNode* node = static_cast<const GeoNear2DSphereNode*>(root);
GeoNearParams params;
params.nearQuery = node->nq;
params.baseBounds = node->baseBounds;
params.filter = node->filter.get();
params.addPointMeta = node->addPointMeta;
params.addDistMeta = node->addDistMeta;
IndexDescriptor* s2Index =
collection->getIndexCatalog()->findIndexByName(opCtx, node->index.name);
invariant(s2Index);
return new GeoNear2DSphereStage(params, opCtx, ws, collection, s2Index);
}
case STAGE_TEXT: {
const TextNode* node = static_cast<const TextNode*>(root);
IndexDescriptor* desc =
collection->getIndexCatalog()->findIndexByName(opCtx, node->index.name);
invariant(desc);
const FTSAccessMethod* fam =
static_cast<FTSAccessMethod*>(collection->getIndexCatalog()->getIndex(desc));
invariant(fam);
TextStageParams params(fam->getSpec());
params.index = desc;
params.indexPrefix = node->indexPrefix;
// We assume here that node->ftsQuery is an FTSQueryImpl, not an FTSQueryNoop. In
// practice,
// this means that it is illegal to use the StageBuilder on a QuerySolution created by
// planning a query that contains "no-op" expressions. TODO: make StageBuilder::build()
// fail in this case (this improvement is being tracked by SERVER-21510).
params.query = static_cast<FTSQueryImpl&>(*node->ftsQuery);
return new TextStage(opCtx, params, ws, node->filter.get());
}
case STAGE_SHARDING_FILTER: {
const ShardingFilterNode* fn = static_cast<const ShardingFilterNode*>(root);
PlanStage* childStage = buildStages(opCtx, collection, cq, qsol, fn->children[0], ws);
if (nullptr == childStage) {
return nullptr;
}
return new ShardFilterStage(
opCtx,
CollectionShardingState::get(opCtx, collection->ns())->getMetadata(),
ws,
childStage);
}
case STAGE_KEEP_MUTATIONS: {
const KeepMutationsNode* km = static_cast<const KeepMutationsNode*>(root);
PlanStage* childStage = buildStages(opCtx, collection, cq, qsol, km->children[0], ws);
if (nullptr == childStage) {
return nullptr;
}
return new KeepMutationsStage(opCtx, km->filter.get(), ws, childStage);
}
case STAGE_DISTINCT_SCAN: {
const DistinctNode* dn = static_cast<const DistinctNode*>(root);
if (nullptr == collection) {
warning() << "Can't distinct-scan null namespace";
return nullptr;
}
DistinctParams params;
params.descriptor =
collection->getIndexCatalog()->findIndexByName(opCtx, dn->index.name);
invariant(params.descriptor);
params.direction = dn->direction;
params.bounds = dn->bounds;
params.fieldNo = dn->fieldNo;
return new DistinctScan(opCtx, params, ws);
}
case STAGE_COUNT_SCAN: {
const CountScanNode* csn = static_cast<const CountScanNode*>(root);
if (nullptr == collection) {
warning() << "Can't fast-count null namespace (collection null)";
return nullptr;
}
CountScanParams params;
params.descriptor =
collection->getIndexCatalog()->findIndexByName(opCtx, csn->index.name);
invariant(params.descriptor);
params.startKey = csn->startKey;
params.startKeyInclusive = csn->startKeyInclusive;
params.endKey = csn->endKey;
params.endKeyInclusive = csn->endKeyInclusive;
return new CountScan(opCtx, params, ws);
}
case STAGE_ENSURE_SORTED: {
const EnsureSortedNode* esn = static_cast<const EnsureSortedNode*>(root);
PlanStage* childStage = buildStages(opCtx, collection, cq, qsol, esn->children[0], ws);
if (nullptr == childStage) {
return nullptr;
}
return new EnsureSortedStage(opCtx, esn->pattern, ws, childStage);
}
case STAGE_CACHED_PLAN:
case STAGE_COUNT:
case STAGE_DELETE:
case STAGE_NOTIFY_DELETE:
case STAGE_EOF:
case STAGE_GROUP:
case STAGE_IDHACK:
case STAGE_INDEX_ITERATOR:
case STAGE_MULTI_ITERATOR:
case STAGE_MULTI_PLAN:
case STAGE_OPLOG_START:
case STAGE_PIPELINE_PROXY:
case STAGE_QUEUED_DATA:
case STAGE_SUBPLAN:
case STAGE_TEXT_OR:
case STAGE_TEXT_MATCH:
case STAGE_UNKNOWN:
case STAGE_UPDATE: {
mongoutils::str::stream ss;
root->appendToString(&ss, 0);
string nodeStr(ss);
warning() << "Can't build exec tree for node " << nodeStr << endl;
}
}
return nullptr;
}
// static (this one is used for Cached and MultiPlanStage)
bool StageBuilder::build(OperationContext* opCtx,
Collection* collection,
const CanonicalQuery& cq,
const QuerySolution& solution,
WorkingSet* wsIn,
PlanStage** rootOut) {
// Only QuerySolutions derived from queries parsed with context, or QuerySolutions derived from
// queries that disallow extensions, can be properly executed. If the query does not have
// $text/$where context (and $text/$where are allowed), then no attempt should be made to
// execute the query.
invariant(!cq.canHaveNoopMatchNodes());
if (nullptr == wsIn || nullptr == rootOut) {
return false;
}
QuerySolutionNode* solutionNode = solution.root.get();
if (nullptr == solutionNode) {
return false;
}
return nullptr != (*rootOut = buildStages(opCtx, collection, cq, solution, solutionNode, wsIn));
}
} // namespace mongo
|