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
|
/**
* Copyright (C) 2021-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.
*/
#include "mongo/db/timeseries/timeseries_update_delete_util.h"
#include "mongo/db/exec/bucket_unpacker.h"
#include "mongo/db/timeseries/timeseries_constants.h"
namespace mongo::timeseries {
namespace {
/**
* Returns whether the given document is a replacement document.
*/
bool isDocReplacement(const BSONObj& doc) {
return doc.isEmpty() || (doc.firstElementFieldNameStringData().find("$") == std::string::npos);
}
/**
* Returns whether the given metaField is the first element of the dotted path in the given
* field.
*/
bool isMetaFieldFirstElementOfDottedPathField(StringData field, StringData metaField) {
return field.substr(0, field.find('.')) == metaField;
}
/**
* Returns a string where the substring leading up to "." in the given field is replaced with
* "meta". If there is no "." in the given field, returns "meta".
*/
std::string getRenamedField(StringData field) {
size_t dotIndex = field.find('.');
return dotIndex != std::string::npos ? "meta" + field.substr(dotIndex, field.size() - dotIndex)
: "meta";
}
void assertQueryFieldIsMetaField(bool isMetaField, StringData metaField) {
uassert(ErrorCodes::InvalidOptions,
fmt::format("Cannot perform an update or delete on a time-series collection "
"when querying on a field that is not the metaField '{}'",
metaField),
isMetaField);
}
void assertUpdateFieldIsMetaField(bool isMetaField, StringData metaField) {
uassert(ErrorCodes::InvalidOptions,
fmt::format("Cannot perform an update on a time-series collection which updates a "
"field that is not the metaField '{}'",
metaField),
isMetaField);
}
/**
* Recurses through the mutablebson element query and replaces any occurrences of the metaField with
* "meta" accounting for queries that may be in dot notation. isTopLevelField is set for elements
* which contain a top-level field name, and parentIsArray is set for elements with an array as a
* parent.
*/
void replaceQueryMetaFieldName(mutablebson::Element elem,
StringData metaField,
bool isTopLevelField = true,
bool parentIsArray = false) {
auto fieldName = elem.getFieldName();
uassert(ErrorCodes::InvalidOptions,
"Cannot use $expr when performing an update or delete on a time-series collection",
fieldName != "$expr");
uassert(ErrorCodes::InvalidOptions,
"Cannot use $where when performing an update or delete on a time-series collection",
fieldName != "$where");
// Replace any occurences of the metaField in the top-level required fields of the JSON Schema
// object with "meta".
if (fieldName == "$jsonSchema") {
mutablebson::Element requiredElem = elem.findFirstChildNamed("required");
if (requiredElem.ok()) {
for (auto subElem = requiredElem.leftChild(); subElem.ok();
subElem = subElem.rightSibling()) {
assertQueryFieldIsMetaField(subElem.isType(BSONType::String) &&
subElem.getValueString() == metaField,
metaField);
invariantStatusOK(
subElem.setValueString(getRenamedField(subElem.getValueString())));
}
}
mutablebson::Element propertiesElem = elem.findFirstChildNamed("properties");
if (propertiesElem.ok()) {
for (auto property = propertiesElem.leftChild(); property.ok();
property = property.rightSibling()) {
assertQueryFieldIsMetaField(property.getFieldName() == metaField, metaField);
invariantStatusOK(property.rename(getRenamedField(property.getFieldName())));
}
}
return;
}
if (isTopLevelField && (fieldName.empty() || fieldName[0] != '$')) {
assertQueryFieldIsMetaField(isMetaFieldFirstElementOfDottedPathField(fieldName, metaField),
metaField);
invariantStatusOK(elem.rename(getRenamedField(fieldName)));
}
isTopLevelField = parentIsArray && elem.isType(BSONType::Object);
parentIsArray = elem.isType(BSONType::Array);
for (auto child = elem.leftChild(); child.ok(); child = child.rightSibling()) {
replaceQueryMetaFieldName(child, metaField, isTopLevelField, parentIsArray);
}
}
} // namespace
BSONObj translateQuery(const BSONObj& query, StringData metaField) {
invariant(!metaField.empty());
mutablebson::Document queryDoc(query);
for (auto queryElem = queryDoc.root().leftChild(); queryElem.ok();
queryElem = queryElem.rightSibling()) {
replaceQueryMetaFieldName(queryElem, metaField);
}
return queryDoc.getObject();
}
write_ops::UpdateModification translateUpdate(const write_ops::UpdateModification& updateMod,
StringData metaField) {
invariant(!metaField.empty());
invariant(updateMod.type() != write_ops::UpdateModification::Type::kDelta);
uassert(ErrorCodes::InvalidOptions,
"Cannot perform an update on a time-series collection using a pipeline update",
updateMod.type() != write_ops::UpdateModification::Type::kPipeline);
const auto& document = updateMod.getUpdateClassic();
uassert(ErrorCodes::InvalidOptions,
"Cannot perform an update on a time-series collection using a replacement document",
!isDocReplacement(document));
// Make a mutable copy of the update document in order to replace all occurrences of the
// metaField with "meta".
mutablebson::Document updateDoc{document};
// updateDoc = { <updateOperator> : { <field1>: <value1>, ... },
// <updateOperator> : { <field1>: <value1>, ... },
// ... }
// updateDoc.root() = <updateOperator> : { <field1>: <value1>, ... },
// <updateOperator> : { <field1>: <value1>, ... },
// ...
for (auto updatePair = updateDoc.root().leftChild(); updatePair.ok();
updatePair = updatePair.rightSibling()) {
// updatePair = <updateOperator> : { <field1>: <value1>, ... }
// Check each field that is being modified by the update operator and replace it if it is
// the metaField.
for (auto fieldValuePair = updatePair.leftChild(); fieldValuePair.ok();
fieldValuePair = fieldValuePair.rightSibling()) {
auto fieldName = fieldValuePair.getFieldName();
assertUpdateFieldIsMetaField(
isMetaFieldFirstElementOfDottedPathField(fieldName, metaField), metaField);
invariantStatusOK(fieldValuePair.rename(getRenamedField(fieldName)));
// If this is a $rename, we also need to translate the value.
if (updatePair.getFieldName() == "$rename") {
assertUpdateFieldIsMetaField(fieldValuePair.isType(BSONType::String) &&
isMetaFieldFirstElementOfDottedPathField(
fieldValuePair.getValueString(), metaField),
metaField);
invariantStatusOK(fieldValuePair.setValueString(
getRenamedField(fieldValuePair.getValueString())));
}
}
}
return write_ops::UpdateModification::parseFromClassicUpdate(updateDoc.getObject());
}
std::function<size_t(const BSONObj&)> numMeasurementsForBucketCounter(StringData timeField) {
return [timeField = timeField.toString()](const BSONObj& bucket) {
return BucketUnpacker::computeMeasurementCount(bucket, timeField);
};
}
} // namespace mongo::timeseries
|
