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
|
/**
* 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 <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "mongo/db/update/update_executor.h"
namespace mongo {
/**
* An UpdateExecutor representing a replacement-style update.
*/
class ObjectReplaceExecutor : public UpdateExecutor {
public:
/**
* Applies a replacement style update to 'applyParams.element'.
*
* If 'replacementDocContainsIdField' is false then the _id field from the original document
* will be preserved.
*
* If 'allowTopLevelDollarPrefixedFields' is true, top-level dollar-prefixed fields will be
* permitted in document updates. This is only set to true in pipeline-style updates, when we
* can be sure that there are no collisions between '$'-prefixed fieldnames and update modifiers
* like $set.
*
* This function will ignore the log mode provided in 'applyParams'. The 'oplogEntry' field
* of the returned ApplyResult is always empty.
*/
static ApplyResult applyReplacementUpdate(ApplyParams applyParams,
const BSONObj& replacementDoc,
bool replacementDocContainsIdField,
bool allowTopLevelDollarPrefixedFields = false);
/**
* Initializes the node with the document to replace with. Any zero-valued timestamps (except
* for the _id) are updated to the current time.
*/
explicit ObjectReplaceExecutor(BSONObj replacement);
/**
* Replaces the document that 'applyParams.element' belongs to with 'val'. If 'val' does not
* contain an _id, the _id from the original document is preserved. 'applyParams.element' must
* be the root of the document. Always returns a result stating that indexes are affected when
* the replacement is not a noop.
*/
ApplyResult applyUpdate(ApplyParams applyParams) const final;
Value serialize() const final {
return Value(_replacementDoc);
}
const BSONObj& getReplacement() const {
return _replacementDoc;
}
void setReplacement(BSONObj doc) {
_replacementDoc = std::move(doc);
}
private:
BSONObj _replacementDoc;
// True if '_replacementDoc' contains an _id.
bool _containsId;
};
} // namespace mongo
|
