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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
|
// Tests that an aggregation pipeline can be optimized away and the query can be answered using
// just the query layer if the pipeline has only one $cursor source, or if the pipeline can be
// collapsed into a single $cursor source pipeline. The resulting cursor in this case will look
// like what the client would have gotten from find command.
//
// Relies on the pipeline stages to be collapsed into a single $cursor stage, so pipelines cannot be
// wrapped into a facet stage to not prevent this optimization. Also, this test is not prepared to
// handle explain output for sharded collections.
// This test makes assumptions about how the explain output will be formatted, so cannot be run when
// pipeline optimization is disabled.
// @tags: [
// assumes_unsharded_collection,
// do_not_wrap_aggregations_in_facets,
// requires_pipeline_optimization,
// requires_profiling,
// ]
(function() {
"use strict";
load("jstests/aggregation/extras/utils.js"); // For 'orderedArrayEq' and 'arrayEq'.
load("jstests/concurrency/fsm_workload_helpers/server_types.js"); // For isWiredTiger.
load("jstests/libs/analyze_plan.js"); // For 'aggPlanHasStage' and other explain helpers.
load("jstests/libs/fixture_helpers.js"); // For 'isMongos' and 'isSharded'.
const coll = db.optimize_away_pipeline;
coll.drop();
assert.commandWorked(coll.insert({_id: 1, x: 10}));
assert.commandWorked(coll.insert({_id: 2, x: 20}));
assert.commandWorked(coll.insert({_id: 3, x: 30}));
// Asserts that the give pipeline has *not* been optimized away and the request is answered
// using the aggregation module. There should be pipeline stages present in the explain output.
// The functions also asserts that a query stage passed in the 'stage' argument is present in
// the explain output. If 'expectedResult' is provided, the pipeline is executed and the
// returned result as validated agains the expected result without respecting the order of the
// documents. If 'preserveResultOrder' is 'true' - the order is respected.
//
// If 'optimizedAwayStages' is non-null, then it should contain a list of agg plan stages that
// should *not* be present in the pipeline, since their execution was pushed down into the query
// layer. The test will verify that this pushdown is reflected in explain output.
function assertPipelineUsesAggregation({
pipeline = [],
pipelineOptions = {},
expectedStages = null,
expectedResult = null,
preserveResultOrder = false,
optimizedAwayStages = null
} = {}) {
const explainOutput = coll.explain().aggregate(pipeline, pipelineOptions);
assert(isAggregationPlan(explainOutput), explainOutput);
assert(!isQueryPlan(explainOutput), explainOutput);
if (optimizedAwayStages) {
for (let stage of optimizedAwayStages) {
assert(!aggPlanHasStage(explainOutput, stage), explainOutput);
}
}
let cursor = getAggPlanStage(explainOutput, "$cursor");
if (cursor) {
cursor = cursor.$cursor;
} else {
cursor = getAggPlanStage(explainOutput, "$geoNearCursor").$geoNearCursor;
}
assert(cursor, explainOutput);
assert(cursor.queryPlanner.optimizedPipeline === undefined, explainOutput);
if (expectedStages) {
for (let expectedStage of expectedStages) {
assert(aggPlanHasStage(explainOutput, expectedStage), explainOutput);
}
}
if (expectedResult) {
const actualResult = coll.aggregate(pipeline, pipelineOptions).toArray();
assert(preserveResultOrder ? orderedArrayEq(actualResult, expectedResult)
: arrayEq(actualResult, expectedResult));
}
return explainOutput;
}
// Asserts that the give pipeline has been optimized away and the request is answered using
// just the query module. There should be no pipeline stages present in the explain output.
// The functions also asserts that a query stage passed in the 'stage' argument is present in
// the explain output. If 'expectedResult' is provided, the pipeline is executed and the
// returned result as validated agains the expected result without respecting the order of the
// documents. If 'preserveResultOrder' is 'true' - the order is respected.
function assertPipelineDoesNotUseAggregation({
pipeline = [],
pipelineOptions = {},
expectedStages = null,
expectedResult = null,
preserveResultOrder = false
} = {}) {
const explainOutput = coll.explain().aggregate(pipeline, pipelineOptions);
assert(!isAggregationPlan(explainOutput), explainOutput);
assert(isQueryPlan(explainOutput), explainOutput);
if (explainOutput.hasOwnProperty("shards")) {
Object.keys(explainOutput.shards)
.forEach((shard) =>
assert(explainOutput.shards[shard].queryPlanner.optimizedPipeline === true,
explainOutput));
} else {
assert(explainOutput.queryPlanner.optimizedPipeline === true, explainOutput);
}
if (expectedStages) {
for (let expectedStage of expectedStages) {
assert(planHasStage(db, explainOutput, expectedStage), explainOutput);
}
}
if (expectedResult) {
const actualResult = coll.aggregate(pipeline, pipelineOptions).toArray();
assert(preserveResultOrder ? orderedArrayEq(actualResult, expectedResult)
: arrayEq(actualResult, expectedResult));
}
return explainOutput;
}
// Test that getMore works with the optimized query.
function testGetMore({command = null, expectedResult = null} = {}) {
const documents =
new DBCommandCursor(db, assert.commandWorked(db.runCommand(command)), 1 /* batchsize */)
.toArray();
assert(arrayEq(documents, expectedResult));
}
let explainOutput;
// Basic pipelines.
// Test basic scenarios when a pipeline has a single $cursor stage or can be collapsed into a
// single cursor stage.
assertPipelineDoesNotUseAggregation({
pipeline: [],
expectedStages: ["COLLSCAN"],
expectedResult: [{_id: 1, x: 10}, {_id: 2, x: 20}, {_id: 3, x: 30}]
});
assertPipelineDoesNotUseAggregation(
{pipeline: [{$match: {x: 20}}], expectedStage: "COLLSCAN", expectedResult: [{_id: 2, x: 20}]});
// Pipelines with a collation.
// Test a simple pipeline with a case-insensitive collation.
assert.commandWorked(coll.insert({_id: 4, x: 40, b: "abc"}));
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {b: "ABC"}}],
pipelineOptions: {collation: {locale: "en_US", strength: 2}},
expectedStages: ["COLLSCAN"],
expectedResult: [{_id: 4, x: 40, b: "abc"}]
});
assert.commandWorked(coll.deleteOne({_id: 4}));
// Pipelines with covered queries.
// We can collapse a covered query into a single $cursor when $project and $sort are present and
// the latter is near the front of the pipeline. Skip this test in sharded modes as we cannot
// correctly handle explain output in plan analyzer helper functions.
assert.commandWorked(coll.createIndex({x: 1}));
assertPipelineDoesNotUseAggregation({
pipeline: [{$sort: {x: 1}}, {$project: {x: 1, _id: 0}}],
expectedStages: ["IXSCAN"],
expectedResult: [{x: 10}, {x: 20}, {x: 30}],
preserveResultOrder: true
});
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: {$gte: 20}}}, {$sort: {x: 1}}, {$project: {x: 1, _id: 0}}],
expectedStages: ["IXSCAN"],
expectedResult: [{x: 20}, {x: 30}],
preserveResultOrder: true
});
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: {$gte: 20}}}, {$sort: {x: 1}}, {$limit: 1}, {$project: {x: 1, _id: 0}}],
expectedStages: ["IXSCAN"],
expectedResult: [{x: 20}]
});
assert.commandWorked(coll.dropIndexes());
assert.commandWorked(coll.insert({_id: 4, x: 40, a: {b: "ab1"}}));
assertPipelineDoesNotUseAggregation({
pipeline: [{$project: {x: 1, _id: 0}}],
expectedStages: ["COLLSCAN", "PROJECTION_SIMPLE"],
expectedResult: [{x: 10}, {x: 20}, {x: 30}, {x: 40}]
});
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: 20}}, {$project: {x: 1, _id: 0}}],
expectedStages: ["COLLSCAN", "PROJECTION_SIMPLE"],
expectedResult: [{x: 20}]
});
assertPipelineDoesNotUseAggregation({
pipeline: [{$project: {x: 1, "a.b": 1, _id: 0}}],
expectedStages: ["COLLSCAN", "PROJECTION_DEFAULT"],
expectedResult: [{x: 10}, {x: 20}, {x: 30}, {x: 40, a: {b: "ab1"}}]
});
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: 40}}, {$project: {"a.b": 1, _id: 0}}],
expectedStages: ["COLLSCAN", "PROJECTION_DEFAULT"],
expectedResult: [{a: {b: "ab1"}}]
});
// We can collapse a $project stage if it has a complex pipeline expression.
assertPipelineDoesNotUseAggregation({
pipeline: [{$project: {x: {$substr: ["$y", 0, 1]}, _id: 0}}],
expectedStages: ["COLLSCAN", "PROJECTION_DEFAULT"]
});
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: 20}}, {$project: {x: {$substr: ["$y", 0, 1]}, _id: 0}}],
expectedStages: ["COLLSCAN", "PROJECTION_DEFAULT"]
});
assert.commandWorked(coll.deleteOne({_id: 4}));
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: {$gte: 20}}}, {$skip: 1}],
expectedStages: ["COLLSCAN", "SKIP"],
expectedResult: [{_id: 3, x: 30}]
});
// Pipelines which cannot be optimized away.
// We cannot optimize away a pipeline if there are stages which have no equivalent in the
// find command.
assertPipelineUsesAggregation({
pipeline: [{$match: {x: {$gte: 20}}}, {$count: "count"}],
expectedStages: ["COLLSCAN"],
expectedResult: [{count: 2}]
});
assertPipelineUsesAggregation({
pipeline: [{$match: {x: {$gte: 20}}}, {$group: {_id: "null", s: {$sum: "$x"}}}],
expectedStages: ["COLLSCAN"],
expectedResult: [{_id: "null", s: 50}]
});
// Test that we can optimize away a pipeline with a $text search predicate.
assert.commandWorked(coll.createIndex({y: "text"}));
assertPipelineDoesNotUseAggregation(
{pipeline: [{$match: {$text: {$search: "abc"}}}], expectedStages: ["IXSCAN"]});
// Test that $match, $sort, and $project all get answered by the PlanStage layer for a $text query.
assertPipelineDoesNotUseAggregation({
pipeline:
[{$match: {$text: {$search: "abc"}}}, {$sort: {sortField: 1}}, {$project: {a: 1, b: 1}}],
expectedStages: ["TEXT_MATCH", "SORT", "PROJECTION_SIMPLE"],
optimizedAwayStages: ["$match", "$sort", "$project"]
});
assert.commandWorked(coll.dropIndexes());
// We cannot optimize away geo near queries.
assert.commandWorked(coll.createIndex({"y": "2d"}));
assertPipelineUsesAggregation({
pipeline: [{$geoNear: {near: [0, 0], distanceField: "y", spherical: true}}],
expectedStages: ["GEO_NEAR_2D"],
});
assert.commandWorked(coll.dropIndexes());
// Test cases around pushdown of $limit.
assert.commandWorked(coll.createIndex({x: 1}));
// A lone $limit pipeline can be optimized away.
assertPipelineDoesNotUseAggregation({
pipeline: [{$limit: 1}],
expectedStages: ["COLLSCAN", "LIMIT"],
});
// $match followed by $limit can be optimized away.
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: 20}}, {$limit: 1}],
expectedStages: ["IXSCAN", "LIMIT"],
expectedResult: [{_id: 2, x: 20}],
});
// $limit followed by $match cannot be fully optimized away. The $limit is pushed down, but the
// $match is executed in the agg layer.
assertPipelineUsesAggregation({
pipeline: [{$limit: 1}, {$match: {x: 20}}],
expectedStages: ["COLLSCAN", "LIMIT"],
optimizedAwayStages: ["$limit"],
});
// $match, $project, $limit can be optimized away when the projection is covered.
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: {$gte: 20}}}, {$project: {_id: 0, x: 1}}, {$limit: 1}],
expectedStages: ["IXSCAN", "PROJECTION_COVERED", "LIMIT"],
expectedResult: [{x: 20}],
});
// $match, $project, and $limit can be optimized away.
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: {$gte: 20}}}, {$project: {_id: 0, x: 1, y: 1}}, {$limit: 1}],
expectedStages: ["IXSCAN", "FETCH", "LIMIT", "PROJECTION_SIMPLE"],
expectedResult: [{x: 20}],
optimizedAwayStages: ["$limit", "$project"],
});
// $match, $project, $limit, $sort cannot be optimized away because the $limit comes before the
// $sort.
assertPipelineUsesAggregation({
pipeline: [{$match: {x: {$gte: 20}}}, {$project: {_id: 0, x: 1}}, {$limit: 1}, {$sort: {x: 1}}],
expectedStages: ["IXSCAN", "PROJECTION_COVERED", "LIMIT"],
expectedResult: [{x: 20}],
optimizedAwayStages: ["$project", "$limit"],
});
// $match, $sort, $limit can be optimized away.
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: {$gte: 20}}}, {$sort: {x: -1}}, {$limit: 2}],
expectedStages: ["IXSCAN", "LIMIT"],
expectedResult: [{_id: 3, x: 30}, {_id: 2, x: 20}],
});
// $match, $sort, $limit, $project can be optimized away.
assertPipelineDoesNotUseAggregation({
pipeline:
[{$match: {x: {$gte: 20}}}, {$sort: {x: -1}}, {$limit: 2}, {$project: {_id: 0, x: 1}}],
expectedStages: ["IXSCAN", "PROJECTION_COVERED", "LIMIT"],
expectedResult: [{x: 30}, {x: 20}],
});
// $match, $sort, $project, $limit can be optimized away.
assertPipelineDoesNotUseAggregation({
pipeline:
[{$match: {x: {$gte: 20}}}, {$sort: {x: -1}}, {$project: {_id: 0, x: 1}}, {$limit: 2}],
expectedStages: ["IXSCAN", "PROJECTION_COVERED", "LIMIT"],
expectedResult: [{x: 30}, {x: 20}],
});
// $match, $sort, $limit, $project can be optimized away, where limits must swap and combine to
// enable pushdown.
assertPipelineDoesNotUseAggregation({
pipeline: [
{$match: {x: {$gte: 20}}},
{$sort: {x: -1}},
{$limit: 3},
{$project: {_id: 0, x: 1}},
{$limit: 2}
],
expectedStages: ["IXSCAN", "PROJECTION_COVERED", "LIMIT"],
expectedResult: [{x: 30}, {x: 20}],
});
// For $sort, $limit, $group, the $sort and $limit can be pushed down, but $group cannot.
assertPipelineUsesAggregation({
pipeline: [{$sort: {x: 1}}, {$limit: 2}, {$group: {_id: null, s: {$sum: "$x"}}}],
expectedStages: ["IXSCAN", "PROJECTION_COVERED", "LIMIT"],
expectedResult: [{_id: null, s: 30}],
optimizedAwayStages: ["$sort", "$limit"],
});
// Test that $limit can be pushed down before a group, but it prohibits the DISTINCT_SCAN
// optimization.
assertPipelineUsesAggregation({
pipeline: [{$group: {_id: "$x"}}],
expectedStages: ["DISTINCT_SCAN", "PROJECTION_COVERED"],
expectedResult: [{_id: 10}, {_id: 20}, {_id: 30}],
});
assertPipelineUsesAggregation({
pipeline: [{$limit: 2}, {$group: {_id: "$x"}}],
expectedStages: ["COLLSCAN", "LIMIT"],
optimizedAwayStages: ["$limit"],
});
assertPipelineUsesAggregation({
pipeline: [{$sort: {x: 1}}, {$group: {_id: "$x"}}],
expectedStages: ["DISTINCT_SCAN", "PROJECTION_COVERED"],
expectedResult: [{_id: 10}, {_id: 20}, {_id: 30}],
optimizedAwayStages: ["$sort"],
});
assertPipelineUsesAggregation({
pipeline: [{$sort: {x: 1}}, {$limit: 2}, {$group: {_id: "$x"}}],
expectedResult: [{_id: 10}, {_id: 20}],
expectedStages: ["IXSCAN", "LIMIT"],
optimizedAwayStages: ["$sort", "$limit"],
});
// $limit after a group has no effect on our ability to produce a DISTINCT_SCAN plan.
assertPipelineUsesAggregation({
pipeline: [{$group: {_id: "$x"}}, {$sort: {_id: 1}}, {$limit: 2}],
expectedStages: ["DISTINCT_SCAN", "PROJECTION_COVERED"],
expectedResult: [{_id: 10}, {_id: 20}],
});
// For $limit, $project, $limit, we can optimize away both $limit stages.
let pipeline = [{$match: {x: {$gte: 0}}}, {$limit: 2}, {$project: {_id: 0, x: 1}}, {$limit: 1}];
assertPipelineDoesNotUseAggregation({
pipeline: pipeline,
expectedStages: ["IXSCAN", "PROJECTION_COVERED", "LIMIT"],
});
// Make sure that we end up using the smaller limit of 1.
let explain = coll.explain().aggregate(pipeline);
let limitStage = getAggPlanStage(explain, "LIMIT");
assert.neq(null, limitStage, explain);
assert.eq(1, limitStage.limitAmount, explain);
// We can optimize away interleaved $limit and $skip after a project.
pipeline = [
{$match: {x: {$gte: 0}}},
{$project: {_id: 0, x: 1}},
{$skip: 20},
{$limit: 15},
{$skip: 10},
{$limit: 7}
];
assertPipelineDoesNotUseAggregation({
pipeline: pipeline,
expectedStages: ["IXSCAN", "PROJECTION_COVERED", "LIMIT", "SKIP"],
optimizedAwayStages: ["$match", "$limit", "$skip"],
});
explain = coll.explain().aggregate(pipeline);
let skipStage = getAggPlanStage(explain, "SKIP");
assert.neq(null, skipStage, explain);
assert.eq(30, skipStage.skipAmount, explain);
limitStage = getAggPlanStage(explain, "LIMIT");
assert.neq(null, limitStage, explain);
assert.eq(5, limitStage.limitAmount, explain);
assert.commandWorked(coll.dropIndexes());
// $sort can be optimized away even if there is no index to provide the sort.
assertPipelineDoesNotUseAggregation({
pipeline: [
{$sort: {x: -1}},
],
expectedStages: ["COLLSCAN", "SORT"],
expectedResult: [{_id: 3, x: 30}, {_id: 2, x: 20}, {_id: 1, x: 10}],
});
// $match, $sort, $limit can be optimized away even if there is no index to provide the sort.
assertPipelineDoesNotUseAggregation({
pipeline: [{$match: {x: {$gte: 0}}}, {$sort: {x: -1}}, {$limit: 1}],
expectedStages: ["COLLSCAN", "SORT"],
expectedResult: [{_id: 3, x: 30}],
});
// $match, $sort, $project, $limit can be optimized away.
assertPipelineDoesNotUseAggregation({
pipeline:
[{$match: {x: {$gte: 20}}}, {$sort: {x: -1}}, {$project: {_id: 0, x: 1}}, {$limit: 2}],
expectedStages: ["COLLSCAN", "SORT", "PROJECTION_SIMPLE"],
expectedResult: [{x: 30}, {x: 20}],
});
// Test a case where there is a projection that can be covered by an index, but a blocking sort is
// still required. In this case, the entire pipeline can be optimized away.
assert.commandWorked(coll.createIndex({y: 1, x: 1}));
assertPipelineDoesNotUseAggregation({
pipeline: [
{$match: {y: {$gt: 0}, x: {$gte: 20}}},
{$sort: {x: -1}},
{$project: {_id: 0, y: 1, x: 1}},
{$limit: 2}
],
expectedStages: ["IXSCAN", "SORT", "PROJECTION_COVERED"],
expectedResult: [],
});
assert.commandWorked(coll.dropIndexes());
// Test that even if we don't have a projection stage at the front of the pipeline but there is a
// finite dependency set, a projection representing this dependency set is pushed down.
pipeline = [{$group: {_id: "$a", b: {$sum: "$b"}}}];
assertPipelineUsesAggregation({
pipeline: pipeline,
expectedStages: ["COLLSCAN", "PROJECTION_SIMPLE"],
});
explain = coll.explain().aggregate(pipeline);
let projStage = getAggPlanStage(explain, "PROJECTION_SIMPLE");
assert.neq(null, projStage, explain);
function assertTransformByShape(expected, actual, message) {
assert.eq(Object.keys(expected).sort(), Object.keys(actual).sort(), message);
for (let key in expected) {
assert.eq(expected[key], actual[key]);
}
}
assertTransformByShape({a: 1, b: 1, _id: 0}, projStage.transformBy, explain);
// Similar as above, but with $addFields stage at the front of the pipeline.
pipeline = [{$addFields: {z: "abc"}}, {$group: {_id: "$a", b: {$sum: "$b"}}}];
assertPipelineUsesAggregation({
pipeline: pipeline,
expectedStages: ["COLLSCAN", "PROJECTION_SIMPLE"],
});
explain = coll.explain().aggregate(pipeline);
projStage = getAggPlanStage(explain, "PROJECTION_SIMPLE");
assert.neq(null, projStage, explain);
assertTransformByShape({a: 1, b: 1, _id: 0}, projStage.transformBy, explain);
// We generate a projection stage from dependency analysis, even if the pipeline begins with an
// exclusion projection.
pipeline = [{$project: {c: 0}}, {$group: {_id: "$a", b: {$sum: "$b"}}}];
assertPipelineUsesAggregation({
pipeline: pipeline,
expectedStages: ["COLLSCAN", "PROJECTION_SIMPLE", "$project"],
});
explain = coll.explain().aggregate(pipeline);
projStage = getAggPlanStage(explain, "PROJECTION_SIMPLE");
assert.neq(null, projStage, explain);
assertTransformByShape({a: 1, b: 1, _id: 0}, projStage.transformBy, explain);
// Similar as above, but with a field 'a' presented both in the finite dependency set, and in the
// exclusion projection at the front of the pipeline.
pipeline = [{$project: {a: 0}}, {$group: {_id: "$a", b: {$sum: "$b"}}}];
assertPipelineUsesAggregation({
pipeline: pipeline,
expectedStages: ["COLLSCAN", "PROJECTION_SIMPLE", "$project"],
});
explain = coll.explain().aggregate(pipeline);
projStage = getAggPlanStage(explain, "PROJECTION_SIMPLE");
assert.neq(null, projStage, explain);
assertTransformByShape({a: 1, b: 1, _id: 0}, projStage.transformBy, explain);
// Test that an exclusion projection at the front of the pipeline is not pushed down, if there no
// finite dependency set.
pipeline = [{$project: {x: 0}}];
assertPipelineUsesAggregation({pipeline: pipeline, expectedStages: ["COLLSCAN"]});
explain = coll.explain().aggregate(pipeline);
assert(!planHasStage(db, explain, "PROJECTION_SIMPLE"), explain);
assert(!planHasStage(db, explain, "PROJECTION_DEFAULT"), explain);
// getMore cases.
// Test getMore on a collection with an optimized away pipeline.
testGetMore({
command: {aggregate: coll.getName(), pipeline: [], cursor: {batchSize: 1}},
expectedResult: [{_id: 1, x: 10}, {_id: 2, x: 20}, {_id: 3, x: 30}]
});
testGetMore({
command:
{aggregate: coll.getName(), pipeline: [{$match: {x: {$gte: 20}}}], cursor: {batchSize: 1}},
expectedResult: [{_id: 2, x: 20}, {_id: 3, x: 30}]
});
testGetMore({
command: {
aggregate: coll.getName(),
pipeline: [{$match: {x: {$gte: 20}}}, {$project: {x: 1, _id: 0}}],
cursor: {batchSize: 1}
},
expectedResult: [{x: 20}, {x: 30}]
});
// Test getMore on a view with an optimized away pipeline. Since views cannot be created when
// imlicit sharded collection mode is on, this test will be run only on a non-sharded
// collection.
let view;
if (!FixtureHelpers.isSharded(coll)) {
view = db.optimize_away_pipeline_view;
view.drop();
assert.commandWorked(db.createView(view.getName(), coll.getName(), []));
testGetMore({
command: {find: view.getName(), filter: {}, batchSize: 1},
expectedResult: [{_id: 1, x: 10}, {_id: 2, x: 20}, {_id: 3, x: 30}]
});
}
// Test getMore puts a correct namespace into profile data for a colletion with optimized away
// pipeline. Cannot be run on mongos as profiling can be enabled only on mongod. Also profiling
// is supported on WiredTiger only.
if (!FixtureHelpers.isMongos(db) && isWiredTiger(db)) {
db.system.profile.drop();
db.setProfilingLevel(2);
testGetMore({
command: {
aggregate: coll.getName(),
pipeline: [{$match: {x: 10}}],
cursor: {batchSize: 1},
comment: 'optimize_away_pipeline'
},
expectedResult: [{_id: 1, x: 10}]
});
db.setProfilingLevel(0);
let profile = db.system.profile.find({}, {op: 1, ns: 1}).sort({ts: 1}).toArray();
assert(
arrayEq(profile,
[{op: "command", ns: coll.getFullName()}, {op: "getmore", ns: coll.getFullName()}]),
profile);
// Test getMore puts a correct namespace into profile data for a view with an optimized away
// pipeline.
if (!FixtureHelpers.isSharded(coll)) {
db.system.profile.drop();
db.setProfilingLevel(2);
testGetMore({
command: {
find: view.getName(),
filter: {x: 10},
batchSize: 1,
comment: 'optimize_away_pipeline'
},
expectedResult: [{_id: 1, x: 10}]
});
db.setProfilingLevel(0);
profile = db.system.profile.find({}, {op: 1, ns: 1}).sort({ts: 1}).toArray();
assert(arrayEq(
profile,
[{op: "query", ns: view.getFullName()}, {op: "getmore", ns: view.getFullName()}]));
}
}
}());
|