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
|
/**
* 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 "mongo/db/pipeline/document_source.h"
#include "mongo/db/pipeline/field_path.h"
namespace mongo {
class DocumentSourceGeoNear : public DocumentSource, public SplittableDocumentSource {
public:
static const long long kDefaultLimit;
static constexpr StringData kKeyFieldName = "key"_sd;
// virtuals from DocumentSource
GetNextResult getNext() final;
const char* getSourceName() const final;
/**
* Attempts to combine with a subsequent limit stage, setting the internal limit field
* as a result.
*/
Pipeline::SourceContainer::iterator doOptimizeAt(Pipeline::SourceContainer::iterator itr,
Pipeline::SourceContainer* container) final;
StageConstraints constraints(Pipeline::SplitState pipeState) const final {
StageConstraints constraints(StreamType::kStreaming,
PositionRequirement::kFirst,
HostTypeRequirement::kAnyShard,
DiskUseRequirement::kNoDiskUse,
FacetRequirement::kNotAllowed);
constraints.requiresInputDocSource = false;
return constraints;
}
Value serialize(boost::optional<ExplainOptions::Verbosity> explain = boost::none) const final;
BSONObjSet getOutputSorts() final {
return SimpleBSONObjComparator::kInstance.makeBSONObjSet(
{BSON(distanceField->fullPath() << -1)});
}
// Virtuals for SplittableDocumentSource
boost::intrusive_ptr<DocumentSource> getShardSource() final;
std::list<boost::intrusive_ptr<DocumentSource>> getMergeSources() final;
static boost::intrusive_ptr<DocumentSource> createFromBson(
BSONElement elem, const boost::intrusive_ptr<ExpressionContext>& pCtx);
static char geoNearName[];
long long getLimit() {
return limit;
}
BSONObj getQuery() const {
return query;
};
// this should only be used for testing
static boost::intrusive_ptr<DocumentSourceGeoNear> create(
const boost::intrusive_ptr<ExpressionContext>& pCtx);
private:
explicit DocumentSourceGeoNear(const boost::intrusive_ptr<ExpressionContext>& pExpCtx);
void parseOptions(BSONObj options);
BSONObj buildGeoNearCmd() const;
void runCommand();
// These fields describe the command to run.
// coords and distanceField are required, rest are optional
BSONObj coords; // "near" option, but near is a reserved keyword on windows
bool coordsIsArray;
std::unique_ptr<FieldPath> distanceField; // Using unique_ptr because FieldPath can't be empty
long long limit;
double maxDistance;
double minDistance;
BSONObj query;
bool spherical;
double distanceMultiplier;
std::unique_ptr<FieldPath> includeLocs;
// The field path over which the command should run, extracted from the 'key' parameter passed
// by the user. Or the empty string the user did not provide a 'key'.
std::string keyFieldPath;
// these fields are used while processing the results
BSONObj cmdOutput;
std::unique_ptr<BSONObjIterator> resultsIterator; // iterator over cmdOutput["results"]
};
} // namespace mongo
|
