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
|
/**
* 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.
*/
#pragma once
#include <cstdint>
#include "mongo/base/string_data.h"
namespace mongo {
/**
* This type acts as an identifier for a node in a query plan tree, such as a 'QuerySolution' tree
* or an 'sbe::PlanStage' tree.
*
* An id of 0 is used to represent the absence of an explicitly assigned id.
*/
using PlanNodeId = uint32_t;
static constexpr PlanNodeId kEmptyPlanNodeId = 0u;
/**
* These map to implementations of the PlanStage interface, all of which live in db/exec/. These
* stage types are shared between Classic and SBE.
*/
enum StageType {
STAGE_AND_HASH,
STAGE_AND_SORTED,
STAGE_BATCHED_DELETE,
STAGE_CACHED_PLAN,
STAGE_COLLSCAN,
STAGE_COLUMN_SCAN,
// A virtual scan stage that simulates a collection scan and doesn't depend on underlying
// storage.
STAGE_VIRTUAL_SCAN,
// This stage sits at the root of the query tree and counts up the number of results
// returned by its child.
STAGE_COUNT,
// If we're running a .count(), the query is fully covered by one ixscan, and the ixscan is
// from one key to another, we can just skip through the keys without bothering to examine
// them.
STAGE_COUNT_SCAN,
STAGE_DELETE,
// If we're running a distinct, we only care about one value for each key. The distinct
// scan stage is an ixscan with some key-skipping behvaior that only distinct uses.
STAGE_DISTINCT_SCAN,
STAGE_EOF,
STAGE_FETCH,
// The two $geoNear impls imply a fetch+sort and must be stages.
STAGE_GEO_NEAR_2D,
STAGE_GEO_NEAR_2DSPHERE,
STAGE_IDHACK,
STAGE_IXSCAN,
STAGE_LIMIT,
STAGE_MOCK,
// Implements iterating over one or more RecordStore::Cursor.
STAGE_MULTI_ITERATOR,
STAGE_MULTI_PLAN,
STAGE_OR,
// Projection has three alternate implementations.
STAGE_PROJECTION_DEFAULT,
STAGE_PROJECTION_COVERED,
STAGE_PROJECTION_SIMPLE,
STAGE_QUEUED_DATA,
STAGE_RECORD_STORE_FAST_COUNT,
STAGE_RETURN_KEY,
STAGE_SAMPLE_FROM_TIMESERIES_BUCKET,
STAGE_SHARDING_FILTER,
STAGE_SKIP,
STAGE_SORT_DEFAULT,
STAGE_SORT_SIMPLE,
STAGE_SORT_KEY_GENERATOR,
STAGE_SORT_MERGE,
STAGE_SPOOL,
STAGE_SUBPLAN,
// Stages for running text search.
STAGE_TEXT_OR,
STAGE_TEXT_MATCH,
// Stage for modifying bucket documents in a time-series bucket collection.
STAGE_TIMESERIES_MODIFY,
// Stage for choosing between two alternate plans based on an initial trial period.
STAGE_TRIAL,
STAGE_UNKNOWN,
STAGE_UNPACK_TIMESERIES_BUCKET,
STAGE_UPDATE,
// Stages for DocumentSources.
STAGE_GROUP,
STAGE_EQ_LOOKUP,
STAGE_SENTINEL,
};
inline bool isProjectionStageType(StageType stageType) {
switch (stageType) {
case STAGE_PROJECTION_COVERED:
case STAGE_PROJECTION_DEFAULT:
case STAGE_PROJECTION_SIMPLE:
return true;
default:
return false;
}
}
inline bool isSortStageType(StageType stageType) {
switch (stageType) {
case STAGE_SORT_DEFAULT:
case STAGE_SORT_SIMPLE:
return true;
default:
return false;
}
}
StringData stageTypeToString(StageType stageType);
/**
* Returns the explain() stage type string for a STAGE_COLLSCAN stage that is performing a clustered
* collection scan in SBE, to match Classic's explain() output.
*/
StringData sbeClusteredCollectionScanToString();
} // namespace mongo
|
