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
|
/**
* 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 "mongo/s/catalog/type_collection_gen.h"
namespace mongo {
using ReshardingFields = TypeCollectionReshardingFields;
/**
* This class represents the layout and contents of documents contained in the config server's
* config.collections collection. All manipulation of documents coming from that collection
* should be done with this class.
*
* Expected config server config.collections collection format:
* {
* "_id" : "foo.bar",
* "lastmodEpoch" : ObjectId("58b6fd76132358839e409e47"),
* "lastmod" : ISODate("1970-02-19T17:02:47.296Z"),
* "key" : {
* "_id" : 1
* },
* "defaultCollation" : {
* "locale" : "fr_CA"
* },
* "unique" : false,
* "uuid" : UUID,
* "noBalance" : false,
* // Only populated if the collection is currently undergoing a resharding operation.
* "reshardingFields" : {
* "uuid" : UUID,
* "state" : CoordinatorState<kInitialized>,
* // Only populated if the collection is currently undergoing a resharding operation,
* // and this collection is the original sharded collection.
* "donorFields" : {
* "reshardingKey" : {
* "_notTheID" : 1
* }
* },
* // Only populated if this collection is the temporary resharding collection in a
* // resharding operation.
* "recipientFields" : {
* "fetchTimestamp" : Timestamp(3, 4),
* "originalNamespace" : "foo.bar",
* }
* }
* }
*
*/
class CollectionType : private CollectionTypeBase {
public:
// Make field names accessible.
static constexpr auto kDefaultCollationFieldName = kPre50CompatibleDefaultCollationFieldName;
static constexpr auto kEpochFieldName = kPre22CompatibleEpochFieldName;
static constexpr auto kKeyPatternFieldName = kPre50CompatibleKeyPatternFieldName;
static constexpr auto kUuidFieldName = kPre50CompatibleUuidFieldName;
static constexpr auto kAllowMigrationsFieldName = kPre50CompatibleAllowMigrationsFieldName;
using CollectionTypeBase::kMaxChunkSizeBytesFieldName;
using CollectionTypeBase::kNoAutoSplitFieldName;
using CollectionTypeBase::kNssFieldName;
using CollectionTypeBase::kReshardingFieldsFieldName;
using CollectionTypeBase::kSupportingLongNameFieldName;
using CollectionTypeBase::kTimeseriesFieldsFieldName;
using CollectionTypeBase::kTimestampFieldName;
using CollectionTypeBase::kUniqueFieldName;
using CollectionTypeBase::kUpdatedAtFieldName;
// Make getters and setters accessible.
using CollectionTypeBase::getMaxChunkSizeBytes;
using CollectionTypeBase::getNss;
using CollectionTypeBase::getReshardingFields;
using CollectionTypeBase::getTimeseriesFields;
using CollectionTypeBase::getTimestamp;
using CollectionTypeBase::getUnique;
using CollectionTypeBase::getUpdatedAt;
using CollectionTypeBase::setNss;
using CollectionTypeBase::setReshardingFields;
using CollectionTypeBase::setTimeseriesFields;
using CollectionTypeBase::setTimestamp;
using CollectionTypeBase::setUnique;
using CollectionTypeBase::setUpdatedAt;
using CollectionTypeBase::toBSON;
// Name of the collections collection in the config server.
static const NamespaceString ConfigNS;
CollectionType(
NamespaceString nss, OID epoch, Timestamp creationTime, Date_t updatedAt, UUID uuid);
explicit CollectionType(const BSONObj& obj);
CollectionType() = default;
std::string toString() const;
const OID& getEpoch() const {
return *getPre22CompatibleEpoch();
}
void setEpoch(OID epoch);
const UUID& getUuid() const {
return *getPre50CompatibleUuid();
}
void setUuid(UUID uuid);
const KeyPattern& getKeyPattern() const {
return *getPre50CompatibleKeyPattern();
}
void setKeyPattern(KeyPattern keyPattern);
BSONObj getDefaultCollation() const {
return getPre50CompatibleDefaultCollation().get_value_or(BSONObj());
}
void setDefaultCollation(const BSONObj& defaultCollation);
void setMaxChunkSizeBytes(int64_t value);
bool getAllowAutoSplit() const {
return !getNoAutoSplit();
}
bool getAllowBalance() const {
return !getNoBalance();
}
bool getAllowMigrations() const {
return getPre50CompatibleAllowMigrations().get_value_or(true);
}
void setAllowMigrations(bool allowMigrations) {
if (allowMigrations)
setPre50CompatibleAllowMigrations(boost::none);
else
setPre50CompatibleAllowMigrations(false);
}
SupportingLongNameStatusEnum getSupportingLongName() const;
void setSupportingLongName(SupportingLongNameStatusEnum value);
};
} // namespace mongo
|
