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
|
/**
* Copyright (C) 2019-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/bson/mutable/element.h"
#include "mongo/db/exec/document_value/value.h"
#include "mongo/db/field_ref_set.h"
#include "mongo/db/update/update_node_visitor.h"
#include "mongo/db/update_index_data.h"
namespace mongo {
class CollatorInterface;
class FieldRef;
/**
* Provides an interface for applying an update to a document.
*/
class UpdateExecutor {
public:
/**
* The parameters required by UpdateExecutor::applyUpdate.
*/
struct ApplyParams {
/**
* Enum indicating whether/what kind of oplog entry should be returned in the ApplyResult
* by the update executor.
*/
enum class LogMode {
// Indicates that no oplog entry should be produced.
kDoNotGenerateOplogEntry,
// Indicates that the update executor should produce an oplog entry. Only the $v: 1
// format or replacement-style format may be used, however.
kGenerateOnlyV1OplogEntry,
// Indicates that the update executor should produce an oplog entry, and may use any
// format.
kGenerateOplogEntry
};
ApplyParams(mutablebson::Element element, const FieldRefSet& immutablePaths)
: element(element), immutablePaths(immutablePaths) {}
// The element to update.
mutablebson::Element element;
// 'applyUpdate' will uassert if it modifies an immutable path.
const FieldRefSet& immutablePaths;
// If there was a positional ($) element in the update expression, 'matchedField' is the
// index of the array element that caused the query to match the document.
StringData matchedField;
// True if the update is being applied to a document to be inserted.
bool insert = false;
// This is provided because some modifiers may ignore certain errors when the update is from
// replication.
bool fromOplogApplication = false;
// If true, UpdateNode::apply ensures that modified elements do not violate depth or DBRef
// constraints.
bool validateForStorage = true;
// Used to determine whether indexes are affected.
const UpdateIndexData* indexData = nullptr;
// Indicates whether/what type of oplog entry should be produced by the update executor.
// If 'logMode' indicates an oplog entry should be produced but the update turns out to be
// a noop, an oplog entry may not be produced.
LogMode logMode = LogMode::kDoNotGenerateOplogEntry;
// If provided, UpdateNode::apply will populate this with a path to each modified field.
FieldRefSetWithStorage* modifiedPaths = nullptr;
};
/**
* The outputs of apply().
*/
struct ApplyResult {
static ApplyResult noopResult() {
ApplyResult applyResult;
applyResult.indexesAffected = false;
applyResult.noop = true;
return applyResult;
}
bool indexesAffected = true;
bool noop = false;
// The oplog entry to log. This is only populated if the operation is not considered a
// noop and if the 'logMode' provided in ApplyParams indicates that an oplog entry should
// be generated.
BSONObj oplogEntry;
};
UpdateExecutor() = default;
virtual ~UpdateExecutor() = default;
virtual Value serialize() const = 0;
virtual void setCollator(const CollatorInterface* collator){};
/**
* Applies the update to 'applyParams.element'. Returns an ApplyResult specifying whether the
* operation was a no-op and whether indexes are affected.
*/
virtual ApplyResult applyUpdate(ApplyParams applyParams) const = 0;
};
} // namespace mongo
|
