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
|
/**
* Copyright (C) 2020-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 <boost/optional.hpp>
#include <vector>
#include "mongo/bson/bsonelement.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/pipeline/aggregate_command_gen.h"
#include "mongo/db/pipeline/exchange_spec_gen.h"
#include "mongo/db/pipeline/legacy_runtime_constants_gen.h"
#include "mongo/db/pipeline/plan_executor_pipeline.h"
#include "mongo/db/query/explain_options.h"
#include "mongo/db/write_concern_options.h"
namespace mongo {
template <typename T>
class StatusWith;
class Document;
class AggregateCommandRequest;
class OperationContext;
namespace aggregation_request_helper {
/**
* Helpers to serialize/deserialize AggregateCommandRequest.
*/
static constexpr StringData kBatchSizeField = "batchSize"_sd;
static constexpr long long kDefaultBatchSize = 101;
/**
* Create a new instance of AggregateCommandRequest by parsing the raw command object. Throws an
* exception 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.
*
* If we are parsing a request for an explained aggregation with an explain verbosity provided,
* then 'explainVerbosity' contains this information. In this case, 'cmdObj' may not itself
* contain the explain specifier. Otherwise, 'explainVerbosity' should be boost::none.
*/
AggregateCommandRequest parseFromBSON(OperationContext* opCtx,
NamespaceString nss,
const BSONObj& cmdObj,
boost::optional<ExplainOptions::Verbosity> explainVerbosity,
bool apiStrict);
StatusWith<AggregateCommandRequest> parseFromBSONForTests(
NamespaceString nss,
const BSONObj& cmdObj,
boost::optional<ExplainOptions::Verbosity> explainVerbosity = boost::none,
bool apiStrict = false);
/**
* Convenience overload which constructs the request's NamespaceString from the given database
* name and command object.
*/
AggregateCommandRequest parseFromBSON(OperationContext* opCtx,
const DatabaseName& dbName,
const BSONObj& cmdObj,
boost::optional<ExplainOptions::Verbosity> explainVerbosity,
bool apiStrict);
StatusWith<AggregateCommandRequest> parseFromBSONForTests(
const DatabaseName& dbName,
const BSONObj& cmdObj,
boost::optional<ExplainOptions::Verbosity> explainVerbosity = boost::none,
bool apiStrict = false);
/*
* The first field in 'cmdObj' must be a string representing a valid collection name, or the
* number 1. In the latter case, returns a reserved namespace that does not represent a user
* collection. See 'NamespaceString::makeCollectionlessAggregateNSS()'.
*/
NamespaceString parseNs(const DatabaseName& dbName, const BSONObj& cmdObj);
/**
* 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.
*
* The explain option is not serialized. The preferred way to send an explain is with the explain
* command, like: {explain: {aggregate: ...}, ...}, explain options are not part of the aggregate
* command object.
*/
Document serializeToCommandDoc(const AggregateCommandRequest& request);
BSONObj serializeToCommandObj(const AggregateCommandRequest& request);
/**
* Validates if 'AggregateCommandRequest' specs complies with API versioning. Throws uassert in case
* of any failure.
*/
void validateRequestForAPIVersion(const OperationContext* opCtx,
const AggregateCommandRequest& request);
/**
* Validates if 'AggregateCommandRequest' sets the "isClusterQueryWithoutShardKeyCmd" field then the
* request must have been fromMongos.
*/
void validateRequestFromClusterQueryWithoutShardKey(const AggregateCommandRequest& request);
/**
* Returns the type of resumable scan required by this aggregation, if applicable. Otherwise returns
* ResumableScanType::kNone.
*/
PlanExecutorPipeline::ResumableScanType getResumableScanType(const AggregateCommandRequest& request,
bool isChangeStream);
} // namespace aggregation_request_helper
/**
* Custom serializers/deserializers for AggregateCommandRequest.
*
* IMPORTANT: The method should not be modified, as API version input/output guarantees could
* break because of it.
*/
boost::optional<mongo::ExplainOptions::Verbosity> parseExplainModeFromBSON(
const BSONElement& explainElem);
/**
* IMPORTANT: The method should not be modified, as API version input/output guarantees could
* break because of it.
*/
void serializeExplainToBSON(const mongo::ExplainOptions::Verbosity& explain,
StringData fieldName,
BSONObjBuilder* builder);
/**
* IMPORTANT: The method should not be modified, as API version input/output guarantees could
* break because of it.
*/
mongo::SimpleCursorOptions parseAggregateCursorFromBSON(const BSONElement& cursorElem);
/**
* IMPORTANT: The method should not be modified, as API version input/output guarantees could
* break because of it.
*/
void serializeAggregateCursorToBSON(const SimpleCursorOptions& cursor,
StringData fieldName,
BSONObjBuilder* builder);
/**
* Parse an aggregation pipeline definition from 'pipelineElem'.
*
* IMPORTANT: The method should not be modified, as API version input/output guarantees could
* break because of it.
*/
static std::vector<BSONObj> parsePipelineFromBSON(const BSONElement& pipelineElem) {
std::vector<BSONObj> pipeline;
uassert(ErrorCodes::TypeMismatch,
"'pipeline' option must be specified as an array",
!pipelineElem.eoo() && pipelineElem.type() == BSONType::Array);
for (auto elem : pipelineElem.Obj()) {
uassert(ErrorCodes::TypeMismatch,
"Each element of the 'pipeline' array must be an object",
elem.type() == BSONType::Object);
pipeline.push_back(elem.embeddedObject().getOwned());
}
return pipeline;
}
} // namespace mongo
|
