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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
/**
* 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/curop.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/logical_session_id.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/query/explain.h"
#include "mongo/util/mongoutils/str.h"
namespace mongo {
namespace str = mongoutils::str;
class FieldRef;
class UpdateLifecycle;
class UpdateRequest {
public:
enum ReturnDocOption {
// Return no document.
RETURN_NONE,
// Return the document as it was before the update. If the update results in an insert,
// no document will be returned.
RETURN_OLD,
// Return the document as it is after the update.
RETURN_NEW
};
inline UpdateRequest(const NamespaceString& nsString)
: _nsString(nsString),
_god(false),
_upsert(false),
_multi(false),
_fromMigration(false),
_fromOplogApplication(false),
_lifecycle(NULL),
_isExplain(false),
_returnDocs(ReturnDocOption::RETURN_NONE),
_yieldPolicy(PlanExecutor::NO_YIELD) {}
const NamespaceString& getNamespaceString() const {
return _nsString;
}
inline void setQuery(const BSONObj& query) {
_query = query;
}
inline const BSONObj& getQuery() const {
return _query;
}
inline void setProj(const BSONObj& proj) {
_proj = proj;
}
inline const BSONObj& getProj() const {
return _proj;
}
inline void setSort(const BSONObj& sort) {
_sort = sort;
}
inline const BSONObj& getSort() const {
return _sort;
}
inline void setCollation(const BSONObj& collation) {
_collation = collation;
}
inline const BSONObj& getCollation() const {
return _collation;
}
inline void setUpdates(const BSONObj& updates) {
_updates = updates;
}
inline const BSONObj& getUpdates() const {
return _updates;
}
inline void setArrayFilters(const std::vector<BSONObj>& arrayFilters) {
_arrayFilters = arrayFilters;
}
inline const std::vector<BSONObj>& getArrayFilters() const {
return _arrayFilters;
}
// Please see documentation on the private members matching these names for
// explanations of the following fields.
inline void setGod(bool value = true) {
_god = value;
}
bool isGod() const {
return _god;
}
inline void setUpsert(bool value = true) {
_upsert = value;
}
bool isUpsert() const {
return _upsert;
}
inline void setMulti(bool value = true) {
_multi = value;
}
bool isMulti() const {
return _multi;
}
inline void setFromMigration(bool value = true) {
_fromMigration = value;
}
bool isFromMigration() const {
return _fromMigration;
}
inline void setFromOplogApplication(bool value = true) {
_fromOplogApplication = value;
}
bool isFromOplogApplication() const {
return _fromOplogApplication;
}
inline void setLifecycle(UpdateLifecycle* value) {
_lifecycle = value;
}
inline UpdateLifecycle* getLifecycle() const {
return _lifecycle;
}
inline void setExplain(bool value = true) {
_isExplain = value;
}
inline bool isExplain() const {
return _isExplain;
}
inline void setReturnDocs(ReturnDocOption value) {
_returnDocs = value;
}
inline bool shouldReturnOldDocs() const {
return _returnDocs == ReturnDocOption::RETURN_OLD;
}
inline bool shouldReturnNewDocs() const {
return _returnDocs == ReturnDocOption::RETURN_NEW;
}
inline bool shouldReturnAnyDocs() const {
return shouldReturnOldDocs() || shouldReturnNewDocs();
}
inline void setYieldPolicy(PlanExecutor::YieldPolicy yieldPolicy) {
_yieldPolicy = yieldPolicy;
}
inline PlanExecutor::YieldPolicy getYieldPolicy() const {
return _yieldPolicy;
}
inline void setStmtId(StmtId stmtId) {
_stmtId = std::move(stmtId);
}
inline StmtId getStmtId() const {
return _stmtId;
}
const std::string toString() const {
StringBuilder builder;
builder << " query: " << _query;
builder << " projection: " << _proj;
builder << " sort: " << _sort;
builder << " collation: " << _collation;
builder << " updates: " << _updates;
builder << " stmtId: " << _stmtId;
builder << " arrayFilters: [";
bool first = true;
for (auto arrayFilter : _arrayFilters) {
if (!first) {
builder << ", ";
}
first = false;
builder << arrayFilter;
}
builder << "]";
builder << " god: " << _god;
builder << " upsert: " << _upsert;
builder << " multi: " << _multi;
builder << " fromMigration: " << _fromMigration;
builder << " fromOplogApplication: " << _fromOplogApplication;
builder << " isExplain: " << _isExplain;
return builder.str();
}
private:
const NamespaceString& _nsString;
// Contains the query that selects documents to update.
BSONObj _query;
// Contains the projection information.
BSONObj _proj;
// Contains the sort order information.
BSONObj _sort;
// Contains the collation information.
BSONObj _collation;
// Contains the modifiers to apply to matched objects, or a replacement document.
BSONObj _updates;
// Filters to specify which array elements should be updated.
std::vector<BSONObj> _arrayFilters;
// The statement id of this request.
StmtId _stmtId = kUninitializedStmtId;
// Flags controlling the update.
// God bypasses _id checking and index generation. It is only used on behalf of system
// updates, never user updates.
bool _god;
// True if this should insert if no matching document is found.
bool _upsert;
// True if this update is allowed to affect more than one document.
bool _multi;
// True if this update is on behalf of a chunk migration.
bool _fromMigration;
// True if this update was triggered by the application of an oplog entry.
bool _fromOplogApplication;
// The lifecycle data, and events used during the update request.
UpdateLifecycle* _lifecycle;
// Whether or not we are requesting an explained update. Explained updates are read-only.
bool _isExplain;
// Specifies which version of the documents to return, if any.
//
// RETURN_NONE (default): Never return any documents, old or new.
// RETURN_OLD: Return ADVANCED when a matching document is encountered, and the value of
// the document before it was updated. If there were no matches, return
// IS_EOF instead (even in case of an upsert).
// RETURN_NEW: Return ADVANCED when a matching document is encountered, and the value of
// the document after being updated. If an upsert was specified and it
// resulted in an insert, return the inserted document.
//
// This allows findAndModify to execute an update and retrieve the resulting document
// without another query before or after the update.
ReturnDocOption _returnDocs;
// Whether or not the update should yield. Defaults to NO_YIELD.
PlanExecutor::YieldPolicy _yieldPolicy;
};
} // namespace mongo
|