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
|
/**
* 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 <string>
#include <boost/optional.hpp>
#include "mongo/db/index/multikey_paths.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/storage/key_string.h"
#include "mongo/util/uuid.h"
namespace mongo {
struct MultikeyPathInfo {
NamespaceString nss;
UUID collectionUUID;
std::string indexName;
KeyStringSet multikeyMetadataKeys;
MultikeyPaths multikeyPaths;
};
using WorkerMultikeyPathInfo = std::vector<MultikeyPathInfo>;
/**
* An OperationContext decoration that tracks which indexes should be made multikey. This is used
* by IndexCatalogEntryImpl::setMultikey() to track what indexes should be set as multikey during
* secondary oplog application. This both marks if the multikey path information should be tracked
* instead of set immediately and saves the multikey path information for later if needed.
*/
class MultikeyPathTracker {
public:
static const OperationContext::Decoration<MultikeyPathTracker> get;
/**
* Returns a string representation of MultikeyPaths for logging.
*/
static std::string dumpMultikeyPaths(const MultikeyPaths& multikeyPaths);
static void mergeMultikeyPaths(MultikeyPaths* toMergeInto, const MultikeyPaths& newPaths);
/**
* Return true iff the child's paths are a subset of the parent.
*/
static bool covers(const MultikeyPaths& parent, const MultikeyPaths& child);
// Decoration requires a default constructor.
MultikeyPathTracker() = default;
/**
* Appends the provided multikey path information to the list of indexes to set as multikey
* after the current replication batch finishes.
* Must call startTrackingMultikeyPathInfo() first.
*/
void addMultikeyPathInfo(MultikeyPathInfo info);
/**
* Clears out any multikey path information that has been appended.
* Must call stopTrackingMultikeyPathInfo() first if tracking was previously started.
*/
void clear();
/**
* Returns the multikey path information that has been saved.
*/
const WorkerMultikeyPathInfo& getMultikeyPathInfo() const;
/**
* Returns the multikey path information for the given inputs, or boost::none if none exist.
*/
boost::optional<MultikeyPaths> getMultikeyPathInfo(const NamespaceString& nss,
const std::string& indexName);
/**
* Specifies that we should track multikey path information on this MultikeyPathTracker. This is
* only expected to be called during oplog application on secondaries. We cannot simply check
* 'canAcceptWritesFor' because background index builds use their own OperationContext and
* cannot store their multikey path info here.
*/
void startTrackingMultikeyPathInfo();
/**
* Specifies to stop tracking multikey path information.
*/
void stopTrackingMultikeyPathInfo();
/**
* Returns if we've called startTrackingMultikeyPathInfo() and not yet called
* stopTrackingMultikeyPathInfo().
*/
bool isTrackingMultikeyPathInfo() const;
/**
* Returns a boolean representing whether or not any multikey path information
* has been appended to the list of indexes to set as multikey.
*/
bool isEmpty() const;
private:
WorkerMultikeyPathInfo _multikeyPathInfo;
bool _trackMultikeyPathInfo = false;
};
} // namespace mongo
|
