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
|
/**
* 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.
*/
#pragma once
#include <boost/intrusive_ptr.hpp>
#include <boost/optional.hpp>
#include <memory>
#include <vector>
#include "mongo/db/pipeline/document_source.h"
#include "mongo/db/pipeline/lite_parsed_document_source.h"
#include "mongo/db/pipeline/lite_parsed_pipeline.h"
#include "mongo/db/pipeline/pipeline.h"
namespace mongo {
class BSONElement;
class TeeBuffer;
class DocumentSourceTeeConsumer;
class ExpressionContext;
class NamespaceString;
/**
* A $facet stage contains multiple sub-pipelines. Each input to the $facet stage will feed into
* each of the sub-pipelines. The $facet stage is blocking, and outputs only one document,
* containing an array of results for each sub-pipeline.
*
* For example, {$facet: {facetA: [{$skip: 1}], facetB: [{$limit: 1}]}} would describe a $facet
* stage which will produce a document like the following:
* {facetA: [<all input documents except the first one>], facetB: [<the first document>]}.
*/
class DocumentSourceFacet final : public DocumentSource {
public:
static constexpr StringData kStageName = "$facet"_sd;
struct FacetPipeline {
FacetPipeline(std::string name, std::unique_ptr<Pipeline, PipelineDeleter> pipeline)
: name(std::move(name)), pipeline(std::move(pipeline)) {}
std::string name;
std::unique_ptr<Pipeline, PipelineDeleter> pipeline;
};
class LiteParsed final : public LiteParsedDocumentSourceNestedPipelines {
public:
static std::unique_ptr<LiteParsed> parse(const NamespaceString& nss,
const BSONElement& spec);
LiteParsed(std::string parseTimeName, std::vector<LiteParsedPipeline> pipelines)
: LiteParsedDocumentSourceNestedPipelines(
std::move(parseTimeName), boost::none, std::move(pipelines)) {}
PrivilegeVector requiredPrivileges(bool isMongos,
bool bypassDocumentValidation) const override final {
PrivilegeVector requiredPrivileges;
for (auto&& pipeline : _pipelines) {
Privilege::addPrivilegesToPrivilegeVector(
&requiredPrivileges,
pipeline.requiredPrivileges(isMongos, bypassDocumentValidation));
}
return requiredPrivileges;
}
};
static boost::intrusive_ptr<DocumentSource> createFromBson(
BSONElement elem, const boost::intrusive_ptr<ExpressionContext>& pExpCtx);
static boost::intrusive_ptr<DocumentSourceFacet> create(
std::vector<FacetPipeline> facetPipelines,
const boost::intrusive_ptr<ExpressionContext>& expCtx,
size_t bufferSizeBytes = internalQueryFacetBufferSizeBytes.load(),
size_t maxOutputDocBytes = internalQueryFacetMaxOutputDocSizeBytes.load());
/**
* Optimizes inner pipelines.
*/
boost::intrusive_ptr<DocumentSource> optimize() final;
/**
* Takes a union of all sub-pipelines, and adds them to 'deps'.
*/
DepsTracker::State getDependencies(DepsTracker* deps) const final;
const char* getSourceName() const final {
return DocumentSourceFacet::kStageName.rawData();
}
/**
* Sets 'source' as the source of '_teeBuffer'.
*/
void setSource(DocumentSource* source) final;
/**
* The $facet stage must be run on the merging shard.
*
* TODO SERVER-24154: Should be smarter about splitting so that parts of the sub-pipelines can
* potentially be run in parallel on multiple shards.
*/
boost::optional<DistributedPlanLogic> distributedPlanLogic() final {
// {shardsStage, mergingStage, sortPattern}
return DistributedPlanLogic{nullptr, this, boost::none};
}
const std::vector<FacetPipeline>& getFacetPipelines() const {
return _facets;
}
auto& getFacetPipelines() {
return _facets;
}
// The following are overridden just to forward calls to sub-pipelines.
void addInvolvedCollections(stdx::unordered_set<NamespaceString>* involvedNssSet) const final;
void detachFromOperationContext() final;
void reattachToOperationContext(OperationContext* opCtx) final;
StageConstraints constraints(Pipeline::SplitState pipeState) const final;
bool usedDisk() final;
protected:
/**
* Blocking call. Will consume all input and produces one output document.
*/
GetNextResult doGetNext() final;
void doDispose() final;
private:
DocumentSourceFacet(std::vector<FacetPipeline> facetPipelines,
const boost::intrusive_ptr<ExpressionContext>& expCtx,
size_t bufferSizeBytes,
size_t maxOutputDocBytes);
Value serialize(boost::optional<ExplainOptions::Verbosity> explain = boost::none) const final;
boost::intrusive_ptr<TeeBuffer> _teeBuffer;
std::vector<FacetPipeline> _facets;
const size_t _maxOutputDocSizeBytes;
bool _done = false;
};
} // namespace mongo
|
