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
|
/**
* 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 "mongo/db/pipeline/document_source_out_gen.h"
#include "mongo/db/pipeline/document_source_writer.h"
namespace mongo {
/**
* Implementation for the $out aggregation stage.
*/
class DocumentSourceOut final : public DocumentSourceWriter<BSONObj> {
public:
static constexpr StringData kStageName = "$out"_sd;
/**
* A "lite parsed" $out stage is similar to other stages involving foreign collections except in
* some cases the foreign collection is allowed to be sharded.
*/
class LiteParsed final : public LiteParsedDocumentSourceForeignCollection {
public:
using LiteParsedDocumentSourceForeignCollection::LiteParsedDocumentSourceForeignCollection;
static std::unique_ptr<LiteParsed> parse(const NamespaceString& nss,
const BSONElement& spec);
bool allowShardedForeignCollection(NamespaceString nss,
bool inMultiDocumentTransaction) const final {
return _foreignNss != nss;
}
bool allowedToPassthroughFromMongos() const final {
return false;
}
PrivilegeVector requiredPrivileges(bool isMongos, bool bypassDocumentValidation) const {
ActionSet actions{ActionType::insert, ActionType::remove};
if (bypassDocumentValidation) {
actions.addAction(ActionType::bypassDocumentValidation);
}
return {Privilege(ResourcePattern::forExactNamespace(_foreignNss), actions)};
}
ReadConcernSupportResult supportsReadConcern(repl::ReadConcernLevel level,
bool isImplicitDefault) const final {
return {
{level == repl::ReadConcernLevel::kLinearizableReadConcern,
{ErrorCodes::InvalidOptions,
"{} cannot be used with a 'linearizable' read concern level"_format(kStageName)}},
Status::OK()};
}
};
~DocumentSourceOut() override;
StageConstraints constraints(Pipeline::SplitState pipeState) const final override {
return {StreamType::kStreaming,
PositionRequirement::kLast,
HostTypeRequirement::kPrimaryShard,
DiskUseRequirement::kWritesPersistentData,
FacetRequirement::kNotAllowed,
TransactionRequirement::kNotAllowed,
LookupRequirement::kNotAllowed,
UnionRequirement::kNotAllowed};
}
Value serialize(SerializationOptions opts = SerializationOptions()) const final override;
/**
* Creates a new $out stage from the given arguments.
*/
static boost::intrusive_ptr<DocumentSource> create(
NamespaceString outputNs,
const boost::intrusive_ptr<ExpressionContext>& expCtx,
boost::optional<TimeseriesOptions> timeseries = boost::none);
/**
* Parses a $out stage from the user-supplied BSON.
*/
static boost::intrusive_ptr<DocumentSource> createFromBson(
BSONElement elem, const boost::intrusive_ptr<ExpressionContext>& pExpCtx);
const char* getSourceName() const final override {
return kStageName.rawData();
}
void addVariableRefs(std::set<Variables::Id>* refs) const final {}
private:
DocumentSourceOut(NamespaceString outputNs,
boost::optional<TimeseriesOptions> timeseries,
const boost::intrusive_ptr<ExpressionContext>& expCtx)
: DocumentSourceWriter(kStageName.rawData(), std::move(outputNs), expCtx),
_timeseries(std::move(timeseries)) {}
static DocumentSourceOutSpec parseOutSpecAndResolveTargetNamespace(
const BSONElement& spec, const DatabaseName& defaultDB);
void initialize() override;
void finalize() override;
void spill(BatchedCommandRequest&& bcr, BatchedObjects&& batch) override {
DocumentSourceWriteBlock writeBlock(pExpCtx->opCtx);
auto insertCommand = bcr.extractInsertRequest();
insertCommand->setDocuments(std::move(batch));
auto targetEpoch = boost::none;
if (_timeseries) {
uassertStatusOK(pExpCtx->mongoProcessInterface->insertTimeseries(
pExpCtx,
_tempNs.getTimeseriesViewNamespace(),
std::move(insertCommand),
_writeConcern,
targetEpoch));
} else {
uassertStatusOK(pExpCtx->mongoProcessInterface->insert(
pExpCtx, _tempNs, std::move(insertCommand), _writeConcern, targetEpoch));
}
}
std::pair<BSONObj, int> makeBatchObject(Document&& doc) const override {
auto obj = doc.toBson();
tassert(6628900, "_writeSizeEstimator should be initialized", _writeSizeEstimator);
return {obj, _writeSizeEstimator->estimateInsertSizeBytes(obj)};
}
BatchedCommandRequest initializeBatchedWriteRequest() const override;
void waitWhileFailPointEnabled() override;
/**
* Determines if an error exists with the user input and existing collections.
* The function will error if:
* 1. The user provides the 'timeseries' field, but a non time-series collection or view exists
* in that namespace.
* 2. The user provides the 'timeseries' field with a specification that does not match an
* existing time-series collection. The function will replace the value of '_timeseries' if the
* user does not provide the 'timeseries' field, but a time-series collection exists.
*/
boost::optional<TimeseriesOptions> validateTimeseries();
NamespaceString makeBucketNsIfTimeseries(const NamespaceString& ns);
// Holds on to the original collection options and index specs so we can check they didn't
// change during computation.
BSONObj _originalOutOptions;
std::list<BSONObj> _originalIndexes;
// The temporary namespace for the $out writes.
NamespaceString _tempNs;
// Set if $out is writing to a time-series collection. This is how $out determines if it is
// writing to a time-series collection or not.
boost::optional<TimeseriesOptions> _timeseries;
// Set to true if the stage has not initialized or the view was successfully created.
// Used by the destructor to determine if the "real" buckets collection should be destroyed.
bool _timeseriesStateConsistent = true;
};
} // namespace mongo
|
