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
|
/**
* 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.
*/
#pragma once
#include <set>
#include "mongo/bson/bsonobj.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/ops/write_ops_gen.h"
namespace mongo::timeseries {
/**
* Returns true if the given query only modifies the time-series collection's given metaField, false
* otherwise.
*/
bool queryOnlyDependsOnMetaField(OperationContext* opCtx,
const NamespaceString& ns,
const BSONObj& query,
boost::optional<StringData> metaField,
const LegacyRuntimeConstants& runtimeConstants,
const boost::optional<BSONObj>& letParams);
/**
* Returns true if the given query, represented by its dependent fields, only modifies the
* time-series collection's given metaField, false otherwise.
*/
bool queryOnlyDependsOnMetaField(boost::optional<StringData> metaField,
const std::set<std::string>& dependencyFieldNames);
/**
* Returns true if the given update modification only modifies the time-series collection's given
* metaField, false otherwise. Requires that the update is not a delta update, and throws an
* exception if the update is not an update document (e.g. is a pipeline update or a replacement
* document).
*/
bool updateOnlyModifiesMetaField(OperationContext* opCtx,
const write_ops::UpdateModification& updateMod,
StringData metaField);
/**
* Translates the given query on the time-series collection to a query on the time-series
* collection's underlying buckets collection. Creates and returns a translated query document where
* all occurrences of metaField in query are replaced with the literal "meta". Requires that the
* given metaField is not empty.
*/
BSONObj translateQuery(const BSONObj& query, StringData metaField);
/**
* Translates the given update on the time-series collection to an update on the time-series
* collection's underlying buckets collection. Creates and returns a translated UpdateModification
* where all occurrences of metaField in updateMod are replaced with the literal "meta". Requires
* that updateMod is an update document and that the given metaField is not empty.
*/
write_ops::UpdateModification translateUpdate(const write_ops::UpdateModification& updateMod,
StringData metaField);
/**
* Returns the function to use to count the number of documents updated or deleted.
*/
std::function<size_t(const BSONObj&)> numMeasurementsForBucketCounter(StringData timeField);
} // namespace mongo::timeseries
|
