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
|
/**
* 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kQuery
#include "mongo/platform/basic.h"
#include "mongo/db/pipeline/document_source_geo_near.h"
#include "mongo/db/pipeline/document.h"
#include "mongo/db/pipeline/document_source_sort.h"
#include "mongo/db/pipeline/lite_parsed_document_source.h"
#include "mongo/util/log.h"
namespace mongo {
using boost::intrusive_ptr;
constexpr StringData DocumentSourceGeoNear::kKeyFieldName;
constexpr const char* DocumentSourceGeoNear::kStageName;
REGISTER_DOCUMENT_SOURCE(geoNear,
LiteParsedDocumentSourceDefault::parse,
DocumentSourceGeoNear::createFromBson);
Value DocumentSourceGeoNear::serialize(boost::optional<ExplainOptions::Verbosity> explain) const {
MutableDocument result;
if (keyFieldPath) {
result.setField(kKeyFieldName, Value(keyFieldPath->fullPath()));
}
if (coordsIsArray) {
result.setField("near", Value(BSONArray(coords)));
} else {
result.setField("near", Value(coords));
}
result.setField("distanceField", Value(distanceField->fullPath()));
if (maxDistance) {
result.setField("maxDistance", Value(*maxDistance));
}
if (minDistance) {
result.setField("minDistance", Value(*minDistance));
}
result.setField("query", Value(query));
result.setField("spherical", Value(spherical));
if (distanceMultiplier) {
result.setField("distanceMultiplier", Value(*distanceMultiplier));
}
if (includeLocs)
result.setField("includeLocs", Value(includeLocs->fullPath()));
return Value(DOC(getSourceName() << result.freeze()));
}
intrusive_ptr<DocumentSourceGeoNear> DocumentSourceGeoNear::create(
const intrusive_ptr<ExpressionContext>& pCtx) {
intrusive_ptr<DocumentSourceGeoNear> source(new DocumentSourceGeoNear(pCtx));
return source;
}
intrusive_ptr<DocumentSource> DocumentSourceGeoNear::createFromBson(
BSONElement elem, const intrusive_ptr<ExpressionContext>& pCtx) {
intrusive_ptr<DocumentSourceGeoNear> out = new DocumentSourceGeoNear(pCtx);
out->parseOptions(elem.embeddedObjectUserCheck());
return out;
}
void DocumentSourceGeoNear::parseOptions(BSONObj options) {
// First, check for explicitly-disallowed fields.
// The old geoNear command used to accept a collation. We explicitly ban it here, since the
// $geoNear stage should respect the collation associated with the entire pipeline.
uassert(40227,
"$geoNear does not accept the 'collation' parameter. Instead, specify a collation "
"for the entire aggregation command.",
!options["collation"]);
// The following fields were present in older versions but are no longer supported.
uassert(50858,
"$geoNear no longer supports the 'limit' parameter. Use a $limit stage instead.",
!options["limit"]);
uassert(50857,
"$geoNear no longer supports the 'num' parameter. Use a $limit stage instead.",
!options["num"]);
uassert(50856, "$geoNear no longer supports the 'start' argument.", !options["start"]);
// The "near" and "distanceField" parameters are required.
uassert(16605,
"$geoNear requires a 'near' option as an Array",
options["near"].isABSONObj()); // Array or Object (Object is deprecated)
coordsIsArray = options["near"].type() == Array;
coords = options["near"].embeddedObject().getOwned();
uassert(16606,
"$geoNear requires a 'distanceField' option as a String",
options["distanceField"].type() == String);
distanceField.reset(new FieldPath(options["distanceField"].str()));
// The remaining fields are optional.
if (auto maxDistElem = options["maxDistance"]) {
uassert(ErrorCodes::TypeMismatch,
"maxDistance must be a number",
isNumericBSONType(maxDistElem.type()));
maxDistance = options["maxDistance"].numberDouble();
uassert(ErrorCodes::BadValue, "maxDistance must be nonnegative", *maxDistance >= 0);
}
if (auto minDistElem = options["minDistance"]) {
uassert(ErrorCodes::TypeMismatch,
"minDistance must be a number",
isNumericBSONType(minDistElem.type()));
minDistance = options["minDistance"].numberDouble();
uassert(ErrorCodes::BadValue, "minDistance must be nonnegative", *minDistance >= 0);
}
if (auto distMultElem = options["distanceMultiplier"]) {
uassert(ErrorCodes::TypeMismatch,
"distanceMultiplier must be a number",
isNumericBSONType(distMultElem.type()));
distanceMultiplier = options["distanceMultiplier"].numberDouble();
uassert(ErrorCodes::BadValue,
"distanceMultiplier must be nonnegative",
*distanceMultiplier >= 0);
}
if (auto queryElem = options["query"]) {
uassert(ErrorCodes::TypeMismatch,
"query must be an object",
queryElem.type() == BSONType::Object);
query = queryElem.embeddedObject().getOwned();
}
spherical = options["spherical"].trueValue();
if (options.hasField("includeLocs")) {
uassert(16607,
"$geoNear requires that 'includeLocs' option is a String",
options["includeLocs"].type() == String);
includeLocs = FieldPath(options["includeLocs"].str());
}
if (options.hasField("uniqueDocs"))
warning() << "ignoring deprecated uniqueDocs option in $geoNear aggregation stage";
if (auto keyElt = options[kKeyFieldName]) {
uassert(ErrorCodes::TypeMismatch,
str::stream() << "$geoNear parameter '" << DocumentSourceGeoNear::kKeyFieldName
<< "' must be of type string but found type: "
<< typeName(keyElt.type()),
keyElt.type() == BSONType::String);
const auto keyFieldStr = keyElt.valueStringData();
uassert(ErrorCodes::BadValue,
str::stream() << "$geoNear parameter '" << DocumentSourceGeoNear::kKeyFieldName
<< "' cannot be the empty string",
!keyFieldStr.empty());
keyFieldPath = FieldPath(keyFieldStr);
}
}
BSONObj DocumentSourceGeoNear::asNearQuery(StringData nearFieldName) const {
BSONObjBuilder queryBuilder;
queryBuilder.appendElements(query);
BSONObjBuilder nearBuilder(queryBuilder.subobjStart(nearFieldName));
if (spherical) {
if (coordsIsArray) {
nearBuilder.appendArray("$nearSphere", coords);
} else {
nearBuilder.append("$nearSphere", coords);
}
} else {
if (coordsIsArray) {
nearBuilder.appendArray("$near", coords);
} else {
nearBuilder.append("$near", coords);
}
}
if (minDistance) {
nearBuilder.append("$minDistance", *minDistance);
}
if (maxDistance) {
nearBuilder.append("$maxDistance", *maxDistance);
}
nearBuilder.doneFast();
return queryBuilder.obj();
}
bool DocumentSourceGeoNear::needsGeoNearPoint() const {
return static_cast<bool>(includeLocs);
}
DepsTracker::State DocumentSourceGeoNear::getDependencies(DepsTracker* deps) const {
// TODO (SERVER-35424): Implement better dependency tracking. For example, 'distanceField' is
// produced by this stage, and we could inform the query system that it need not include it in
// its response. For now, assume that we require the entire document as well as the appropriate
// geoNear metadata.
deps->setNeedsMetadata(DepsTracker::MetadataType::GEO_NEAR_DISTANCE, true);
deps->setNeedsMetadata(DepsTracker::MetadataType::GEO_NEAR_POINT, needsGeoNearPoint());
deps->needWholeDocument = true;
return DepsTracker::State::EXHAUSTIVE_FIELDS;
}
DocumentSourceGeoNear::DocumentSourceGeoNear(const intrusive_ptr<ExpressionContext>& pExpCtx)
: DocumentSource(pExpCtx), coordsIsArray(false), spherical(false) {}
NeedsMergerDocumentSource::MergingLogic DocumentSourceGeoNear::mergingLogic() {
return {nullptr, BSON(distanceField->fullPath() << 1)};
}
} // namespace mongo
|
