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
|
/**
* Copyright (C) 2016 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.
*/
#pragma once
#include <boost/optional.hpp>
#include <vector>
#include "mongo/bson/bsonelement.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/db/namespace_string.h"
namespace mongo {
template <typename T>
class StatusWith;
class Document;
/**
* Represents the user-supplied options to the aggregate command.
*/
class AggregationRequest {
public:
static const StringData kCommandName;
static const StringData kCursorName;
static const StringData kBatchSizeName;
static const StringData kFromRouterName;
static const StringData kPipelineName;
static const StringData kCollationName;
static const StringData kExplainName;
static const StringData kAllowDiskUseName;
static const StringData kHintName;
static const long long kDefaultBatchSize;
/**
* Create a new instance of AggregationRequest by parsing the raw command object. Returns a
* non-OK status if a required field was missing, if there was an unrecognized field name or if
* there was a bad value for one of the fields.
*/
static StatusWith<AggregationRequest> parseFromBSON(NamespaceString nss, const BSONObj& cmdObj);
/**
* Constructs an AggregationRequest over the given namespace with the given pipeline. All
* options aside from the pipeline assume their default values.
*/
AggregationRequest(NamespaceString nss, std::vector<BSONObj> pipeline);
/**
* Serializes the options to a Document. Note that this serialization includes the original
* pipeline object, as specified. Callers will likely want to override this field with a
* serialization of a parsed and optimized Pipeline object.
*/
Document serializeToCommandObj() const;
//
// Getters.
//
long long getBatchSize() const {
return _batchSize;
}
const NamespaceString& getNamespaceString() const {
return _nss;
}
/**
* An unparsed version of the pipeline. All BSONObjs are owned.
*/
const std::vector<BSONObj>& getPipeline() const {
return _pipeline;
}
bool isExplain() const {
return _explain;
}
bool isFromRouter() const {
return _fromRouter;
}
bool shouldAllowDiskUse() const {
return _allowDiskUse;
}
bool shouldBypassDocumentValidation() const {
return _bypassDocumentValidation;
}
/**
* Returns an empty object if no collation was specified.
*/
BSONObj getCollation() const {
return _collation;
}
BSONObj getHint() const {
return _hint;
}
//
// Setters for optional fields.
//
/**
* Negative batchSize is illegal but batchSize of 0 is allowed.
*/
void setBatchSize(long long batchSize) {
uassert(40203, "batchSize must be non-negative", batchSize >= 0);
_batchSize = batchSize;
}
void setCollation(BSONObj collation) {
_collation = collation.getOwned();
}
void setHint(BSONObj hint) {
_hint = hint.getOwned();
}
void setExplain(bool isExplain) {
_explain = isExplain;
}
void setAllowDiskUse(bool allowDiskUse) {
_allowDiskUse = allowDiskUse;
}
void setFromRouter(bool isFromRouter) {
_fromRouter = isFromRouter;
}
void setBypassDocumentValidation(bool shouldBypassDocumentValidation) {
_bypassDocumentValidation = shouldBypassDocumentValidation;
}
private:
// Required fields.
const NamespaceString _nss;
// An unparsed version of the pipeline.
const std::vector<BSONObj> _pipeline;
long long _batchSize;
// Optional fields.
// An owned copy of the user-specified collation object, or an empty object if no collation was
// specified.
BSONObj _collation;
// The hint provided, if any. If the hint was by index key pattern, the value of '_hint' is
// the key pattern hinted. If the hint was by index name, the value of '_hint' is
// {$hint: <String>}, where <String> is the index name hinted.
BSONObj _hint;
bool _explain = false;
bool _allowDiskUse = false;
bool _fromRouter = false;
bool _bypassDocumentValidation = false;
};
} // namespace mongo
|
