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
|
/**
* 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 DocumentSourceUnwind final : public DocumentSource {
public:
// virtuals from DocumentSource
GetNextResult getNext() final;
const char* getSourceName() const final;
Value serialize(boost::optional<ExplainOptions::Verbosity> explain = boost::none) const final;
BSONObjSet getOutputSorts() final;
/**
* Returns the unwound path, and the 'includeArrayIndex' path, if specified.
*/
GetModPathsReturn getModifiedPaths() const final;
StageConstraints constraints(Pipeline::SplitState pipeState) const final {
StageConstraints constraints(StreamType::kStreaming,
PositionRequirement::kNone,
HostTypeRequirement::kNone,
DiskUseRequirement::kNoDiskUse,
FacetRequirement::kAllowed,
TransactionRequirement::kAllowed);
constraints.canSwapWithMatch = true;
return constraints;
}
DepsTracker::State getDependencies(DepsTracker* deps) const final;
/**
* Creates a new $unwind DocumentSource from a BSON specification.
*/
static boost::intrusive_ptr<DocumentSource> createFromBson(
BSONElement elem, const boost::intrusive_ptr<ExpressionContext>& pExpCtx);
static boost::intrusive_ptr<DocumentSourceUnwind> create(
const boost::intrusive_ptr<ExpressionContext>& expCtx,
const std::string& path,
bool includeNullIfEmptyOrMissing,
const boost::optional<std::string>& includeArrayIndex);
std::string getUnwindPath() const {
return _unwindPath.fullPath();
}
bool preserveNullAndEmptyArrays() const {
return _preserveNullAndEmptyArrays;
}
const boost::optional<FieldPath>& indexPath() const {
return _indexPath;
}
private:
DocumentSourceUnwind(const boost::intrusive_ptr<ExpressionContext>& pExpCtx,
const FieldPath& fieldPath,
bool includeNullIfEmptyOrMissing,
const boost::optional<FieldPath>& includeArrayIndex);
// Configuration state.
const FieldPath _unwindPath;
// Documents that have a nullish value, or an empty array for the field '_unwindPath', will pass
// through the $unwind stage unmodified if '_preserveNullAndEmptyArrays' is true.
const bool _preserveNullAndEmptyArrays;
// If set, the $unwind stage will include the array index in the specified path, overwriting any
// existing value, setting to null when the value was a non-array or empty array.
const boost::optional<FieldPath> _indexPath;
// Iteration state.
class Unwinder;
std::unique_ptr<Unwinder> _unwinder;
};
} // namespace mongo
|
