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
|
/**
* 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/platform/basic.h"
#include "mongo/db/catalog/clustered_collection_util.h"
#include "mongo/db/namespace_string.h"
#include "mongo/logv2/log.h"
#include "mongo/util/represent_as.h"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kDefault
namespace mongo {
namespace clustered_util {
static constexpr StringData kDefaultClusteredIndexName = "_id_"_sd;
void ensureClusteredIndexName(ClusteredIndexSpec& indexSpec) {
if (!indexSpec.getName()) {
auto clusterKey = indexSpec.getKey().firstElement().fieldNameStringData();
if (clusterKey == "_id") {
indexSpec.setName(kDefaultClusteredIndexName);
} else {
indexSpec.setName(StringData(clusterKey + "_1"));
}
}
}
ClusteredCollectionInfo makeCanonicalClusteredInfoForLegacyFormat() {
auto indexSpec = ClusteredIndexSpec{BSON("_id" << 1), true /* unique */};
indexSpec.setName(kDefaultClusteredIndexName);
return ClusteredCollectionInfo(std::move(indexSpec), true /* legacy */);
}
ClusteredCollectionInfo makeDefaultClusteredIdIndex() {
auto indexSpec = ClusteredIndexSpec{BSON("_id" << 1), true /* unique */};
indexSpec.setName(kDefaultClusteredIndexName);
return makeCanonicalClusteredInfo(indexSpec);
}
ClusteredCollectionInfo makeCanonicalClusteredInfo(ClusteredIndexSpec indexSpec) {
ensureClusteredIndexName(indexSpec);
return ClusteredCollectionInfo(std::move(indexSpec), false);
}
boost::optional<ClusteredCollectionInfo> parseClusteredInfo(const BSONElement& elem) {
uassert(5979702,
"'clusteredIndex' has to be a boolean or object.",
elem.type() == mongo::Bool || elem.type() == mongo::Object);
bool isLegacyFormat = elem.type() == mongo::Bool;
if (isLegacyFormat) {
// Legacy format implies the collection was created with format {clusteredIndex: <bool>}.
// The legacy format is maintained for backward compatibility with time series buckets
// collection creation.
if (!elem.Bool()) {
// clusteredIndex was specified as false.
return boost::none;
}
return makeCanonicalClusteredInfoForLegacyFormat();
}
auto indexSpec = ClusteredIndexSpec::parse(
IDLParserContext{"ClusteredUtil::parseClusteredInfo"}, elem.Obj());
ensureClusteredIndexName(indexSpec);
return makeCanonicalClusteredInfo(std::move(indexSpec));
}
boost::optional<ClusteredCollectionInfo> createClusteredInfoForNewCollection(
const BSONObj& indexSpec) {
if (!indexSpec["clustered"]) {
return boost::none;
}
auto filteredIndexSpec = indexSpec.removeField("clustered"_sd);
auto clusteredIndexSpec = ClusteredIndexSpec::parse(
IDLParserContext{"ClusteredUtil::createClusteredInfoForNewCollection"}, filteredIndexSpec);
ensureClusteredIndexName(clusteredIndexSpec);
return makeCanonicalClusteredInfo(std::move(clusteredIndexSpec));
};
bool requiresLegacyFormat(const NamespaceString& nss) {
return nss.isTimeseriesBucketsCollection() || nss.isChangeStreamPreImagesCollection();
}
BSONObj formatClusterKeyForListIndexes(const ClusteredCollectionInfo& collInfo,
const BSONObj& collation) {
BSONObjBuilder bob;
collInfo.getIndexSpec().serialize(&bob);
if (!collation.isEmpty()) {
bob.append("collation", collation);
}
bob.append("clustered", true);
return bob.obj();
}
bool isClusteredOnId(const boost::optional<ClusteredCollectionInfo>& collInfo) {
return matchesClusterKey(BSON("_id" << 1), collInfo);
}
bool matchesClusterKey(const BSONObj& keyPatternObj,
const boost::optional<ClusteredCollectionInfo>& collInfo) {
if (!collInfo) {
return false;
}
const auto nFields = keyPatternObj.nFields();
invariant(nFields > 0);
if (nFields > 1) {
// Clustered key cannot be compound.
return false;
}
if (!keyPatternObj.firstElement().isNumber()) {
// Clustered index can't be of any special type.
return false;
}
return keyPatternObj.firstElement().fieldNameStringData() ==
collInfo->getIndexSpec().getKey().firstElement().fieldNameStringData();
}
StringData getClusterKeyFieldName(const ClusteredIndexSpec& indexSpec) {
return indexSpec.getKey().firstElement().fieldNameStringData();
}
BSONObj getSortPattern(const ClusteredIndexSpec& indexSpec) {
return indexSpec.getKey();
}
} // namespace clustered_util
} // namespace mongo
|
