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
|
/**
* 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/exec/working_set.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/matcher/expression.h"
#include "mongo/util/string_map.h"
namespace mongo {
class ProjectionExec {
public:
/**
* A .find() projection can have an array operation, either an elemMatch or positional (or
* neither).
*/
enum ArrayOpType {
ARRAY_OP_NORMAL = 0,
ARRAY_OP_ELEM_MATCH,
ARRAY_OP_POSITIONAL
};
/**
* Projections based on data computed while answering a query, or other metadata about a
* document / query.
*/
enum MetaProjection {
META_TEXT_SCORE,
META_GEONEAR_DIST,
META_GEONEAR_POINT,
META_DISKLOC,
META_IX_KEY,
};
/**
* TODO: document why we like StringMap so much here
*/
typedef StringMap<ProjectionExec*> FieldMap;
typedef StringMap<MatchExpression*> Matchers;
typedef StringMap<MetaProjection> MetaMap;
ProjectionExec(const BSONObj& spec, const MatchExpression* queryExpression);
~ProjectionExec();
/**
* Apply this projection to the 'member'. Changes the type to OWNED_OBJ.
*/
Status transform(WorkingSetMember* member) const;
/**
* Apply this projection to the object 'in'.
* 'this' must be a simple inclusion/exclusion projection.
*
* Upon success, 'out' is set to the new object and Status::OK() is returned.
* Otherwise, returns an error Status and *out is not mutated.
*/
Status transform(const BSONObj& in, BSONObj* out) const;
private:
//
// Initialization
//
ProjectionExec();
/**
* Add 'field' as a field name that is included or excluded as part of the projection.
*/
void add(const string& field, bool include);
/**
* Add 'field' as a field name that is sliced as part of the projection.
*/
void add(const string& field, int skip, int limit);
//
// Execution
//
/**
* Apply the projection that 'this' represents to the object 'in'. 'details' is the result
* of a match evaluation of the full query on the object 'in'. This is only required
* if the projection is positional.
*
* If the projection is successfully computed, returns Status::OK() and stuff the result in
* 'bob'.
* Otherwise, returns error.
*/
Status transform(const BSONObj& in,
BSONObjBuilder* bob,
const MatchDetails* details = NULL) const;
/**
* See transform(...) above.
*/
bool transformRequiresDetails() const {
return ARRAY_OP_POSITIONAL == _arrayOpType;
}
/**
* Is the full document required to compute this projection?
*/
bool requiresDocument() const {
return _include || _hasNonSimple || _hasDottedField;
}
/**
* Appends the element 'e' to the builder 'bob', possibly descending into sub-fields of 'e'
* if needed.
*/
Status append(BSONObjBuilder* bob,
const BSONElement& elt,
const MatchDetails* details = NULL,
const ArrayOpType arrayOpType = ARRAY_OP_NORMAL) const;
// XXX document
void appendArray(BSONObjBuilder* bob, const BSONObj& array, bool nested = false) const;
// True if default at this level is to include.
bool _include;
// True if this level can't be skipped or included without recursing.
bool _special;
// We must group projections with common prefixes together.
// TODO: benchmark vector<pair> vs map
// XXX: document
FieldMap _fields;
// The raw projection spec. that is passed into init(...)
BSONObj _source;
// Should we include the _id field?
bool _includeID;
// Arguments from the $slice operator.
int _skip;
int _limit;
// Used for $elemMatch and positional operator ($)
Matchers _matchers;
// The matchers above point into BSONObjs and this is where those objs live.
vector<BSONObj> _elemMatchObjs;
ArrayOpType _arrayOpType;
// Is there an elemMatch or positional operator?
bool _hasNonSimple;
// Is there a projection over a dotted field?
bool _hasDottedField;
// The full query expression. Used when we need MatchDetails.
const MatchExpression* _queryExpression;
// Projections that aren't sourced from the document or index keys.
MetaMap _meta;
// Do we have a returnKey projection? If so we *only* output the index key metadata. If
// it's not found we output nothing.
bool _hasReturnKey;
};
} // namespace mongo
|
