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
|
/**
* Copyright (C) 2023-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/exec/delete_stage.h"
#include "mongo/db/exec/plan_stats.h"
#include "mongo/db/exec/requires_collection_stage.h"
#include "mongo/db/exec/timeseries/bucket_unpacker.h"
#include "mongo/db/exec/update_stage.h"
namespace mongo {
struct TimeseriesModifyParams {
TimeseriesModifyParams(const DeleteStageParams* deleteParams)
: isUpdate(false),
isMulti(deleteParams->isMulti),
fromMigrate(deleteParams->fromMigrate),
isExplain(deleteParams->isExplain),
returnDeleted(deleteParams->returnDeleted),
stmtId(deleteParams->stmtId),
canonicalQuery(deleteParams->canonicalQuery) {}
TimeseriesModifyParams(const UpdateStageParams* updateParams)
: isUpdate(true),
isMulti(updateParams->request->isMulti()),
fromMigrate(updateParams->request->source() == OperationSource::kFromMigrate),
isExplain(updateParams->request->explain()),
canonicalQuery(updateParams->canonicalQuery),
isFromOplogApplication(updateParams->request->isFromOplogApplication()),
updateDriver(updateParams->driver) {
tassert(7314203,
"timeseries updates should only have one stmtId",
updateParams->request->getStmtIds().size() == 1);
stmtId = updateParams->request->getStmtIds().front();
}
// Is this an update or a delete operation?
bool isUpdate;
// Is this a multi update/delete?
bool isMulti;
// Is this command part of a migrate operation that is essentially like a no-op when the
// cluster is observed by an external client.
bool fromMigrate;
// Are we explaining a command rather than actually executing it?
bool isExplain;
// Should we return the deleted document?
bool returnDeleted = false;
// The stmtId for this particular command.
StmtId stmtId = kUninitializedStmtId;
// The parsed query predicate for this command. Not owned here.
CanonicalQuery* canonicalQuery;
// True if this command was triggered by the application of an oplog entry.
bool isFromOplogApplication = false;
// Contains the logic for applying mods to documents. Only present for updates. Not owned. Must
// outlive the TimeseriesModifyStage.
UpdateDriver* updateDriver = nullptr;
};
/**
* Unpacks time-series bucket documents and writes the modified documents.
*
* The stage processes one bucket at a time, unpacking all the measurements and writing the output
* bucket in a single doWork() call.
*/
class TimeseriesModifyStage final : public RequiresWritableCollectionStage {
public:
static const char* kStageType;
TimeseriesModifyStage(ExpressionContext* expCtx,
TimeseriesModifyParams&& params,
WorkingSet* ws,
std::unique_ptr<PlanStage> child,
const ScopedCollectionAcquisition& coll,
BucketUnpacker bucketUnpacker,
std::unique_ptr<MatchExpression> residualPredicate);
StageType stageType() const {
return STAGE_TIMESERIES_MODIFY;
}
bool isEOF() final;
std::unique_ptr<PlanStageStats> getStats();
const SpecificStats* getSpecificStats() const {
return &_specificStats;
}
PlanStage::StageState doWork(WorkingSetID* id);
bool containsDotsAndDollarsField() const {
return _params.isUpdate && _params.updateDriver->containsDotsAndDollarsField();
}
protected:
void doSaveStateRequiresCollection() final {
_preWriteFilter.saveState();
}
void doRestoreStateRequiresCollection() final;
private:
bool _isMultiWrite() const {
return _params.isMulti;
}
bool _isSingletonWrite() const {
return !_isMultiWrite();
}
/**
* Builds insert requests based on the measurements needing to be updated.
*/
std::pair<std::vector<BSONObj>, std::vector<write_ops::InsertCommandRequest>> _buildInsertOps(
const std::vector<BSONObj>& matchedMeasurements,
std::vector<BSONObj>& unchangedMeasurements);
/**
* Writes the modifications to a bucket.
*
* Returns the pair of (whether the write was successful, the stage state to propagate).
*/
template <typename F>
std::pair<bool, PlanStage::StageState> _writeToTimeseriesBuckets(
ScopeGuard<F>& bucketFreer,
WorkingSetID bucketWsmId,
std::vector<BSONObj>&& unchangedMeasurements,
const std::vector<BSONObj>& modifiedMeasurements,
bool bucketFromMigrate);
/**
* Helper to set up state to retry 'bucketId' after yielding and establishing a new storage
* snapshot.
*/
void _retryBucket(WorkingSetID bucketId);
template <typename F>
std::pair<boost::optional<PlanStage::StageState>, bool> _checkIfWritingToOrphanedBucket(
ScopeGuard<F>& bucketFreer, WorkingSetID id);
/**
* Gets the next bucket to process.
*/
PlanStage::StageState _getNextBucket(WorkingSetID& id);
/**
* Prepares returning a deleted measurement.
*/
void _prepareToReturnDeletedMeasurement(WorkingSetID& out, BSONObj measurement);
TimeseriesModifyParams _params;
WorkingSet* _ws;
//
// Main execution machinery data structures.
//
BucketUnpacker _bucketUnpacker;
// Determines the measurements to modify in this bucket, and by inverse, those to keep
// unmodified. This predicate can be null if we have a meta-only or empty predicate on singleton
// deletes or updates.
std::unique_ptr<MatchExpression> _residualPredicate;
/**
* This member is used to check whether the write should be performed, and if so, any other
* behavior that should be done as part of the write (e.g. skipping it because it affects an
* orphan document). A yield cannot happen between the check and the write, so the checks are
* embedded in the stage.
*
* It's refreshed after yielding and reacquiring the locks.
*/
write_stage_common::PreWriteFilter _preWriteFilter;
TimeseriesModifyStats _specificStats{};
// A pending retry to get to after a NEED_YIELD propagation and a new storage snapshot is
// established. This can be set when a write fails or when a fetch fails.
WorkingSetID _retryBucketId = WorkingSet::INVALID_ID;
// Stores the deleted document when a deleteOne with returnDeleted: true is requested and we
// need to yield.
boost::optional<BSONObj> _deletedMeasurementToReturn = boost::none;
};
} // namespace mongo
|
