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
|
/**
* 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 <boost/optional.hpp>
#include <string>
#include "mongo/db/jsobj.h"
#include "mongo/db/keypattern.h"
#include "mongo/db/namespace_string.h"
#include "mongo/s/chunk_version.h"
#include "mongo/util/uuid.h"
namespace mongo {
class CollectionType;
class Status;
template <typename T>
class StatusWith;
/**
* This class represents the layout and contents of documents contained in the shard server's
* config.collections collection. All manipulation of documents coming from that collection should
* be done with this class.
*
* Expected shard server config.collections collection format:
* {
* "_id" : "foo.bar",
* "uuid" : UUID, // optional in 3.6
* "epoch" : ObjectId("58b6fd76132358839e409e47"), // will remove when UUID becomes available
* "key" : {
* "_id" : 1
* },
* "defaultCollation" : {
* "locale" : "fr_CA"
* },
* "unique" : false,
* "refreshing" : true, // optional
* "lastRefreshedCollectionVersion" : Timestamp(1, 0), // optional
* "enterCriticalSectionCounter" : 4 // optional
* }
*
* enterCriticalSectionCounter is currently just an OpObserver signal, thus otherwise ignored here.
*/
class ShardCollectionType {
public:
static const BSONField<std::string> ns; // "_id"
static const BSONField<UUID> uuid;
static const BSONField<OID> epoch;
static const BSONField<BSONObj> keyPattern;
static const BSONField<BSONObj> defaultCollation;
static const BSONField<bool> unique;
static const BSONField<bool> refreshing;
static const BSONField<Date_t> lastRefreshedCollectionVersion;
static const BSONField<int> enterCriticalSectionCounter;
ShardCollectionType(NamespaceString nss,
boost::optional<UUID> uuid,
OID epoch,
const KeyPattern& keyPattern,
const BSONObj& defaultCollation,
bool unique);
/**
* Constructs a new ShardCollectionType object from BSON. Also does validation of the contents.
*/
static StatusWith<ShardCollectionType> fromBSON(const BSONObj& source);
/**
* Returns the BSON representation of this shard collection type object.
*/
BSONObj toBSON() const;
/**
* Returns a std::string representation of the current internal state.
*/
std::string toString() const;
const NamespaceString& getNss() const {
return _nss;
}
void setNss(NamespaceString nss);
const boost::optional<UUID> getUUID() const {
return _uuid;
}
void setUUID(UUID uuid);
const OID& getEpoch() const {
return _epoch;
}
void setEpoch(OID epoch);
const KeyPattern& getKeyPattern() const {
return _keyPattern;
}
void setKeyPattern(const KeyPattern& keyPattern);
const BSONObj& getDefaultCollation() const {
return _defaultCollation;
}
void setDefaultCollation(const BSONObj& collation) {
_defaultCollation = collation.getOwned();
}
bool getUnique() const {
return _unique;
}
void setUnique(bool unique) {
_unique = unique;
}
bool hasRefreshing() const {
return _refreshing.is_initialized();
}
bool getRefreshing() const;
void setRefreshing(bool refreshing) {
_refreshing = refreshing;
}
bool hasLastRefreshedCollectionVersion() const {
return _lastRefreshedCollectionVersion.is_initialized();
}
const ChunkVersion& getLastRefreshedCollectionVersion() const;
void setLastRefreshedCollectionVersion(const ChunkVersion& version) {
_lastRefreshedCollectionVersion = version;
}
private:
// The full namespace (with the database prefix).
NamespaceString _nss;
// The UUID of the collection, if known.
boost::optional<UUID> _uuid;
// Uniquely identifies this instance of the collection, in case of drop/create.
OID _epoch;
// Sharding key. If collection is dropped, this is no longer required.
KeyPattern _keyPattern;
// Optional collection default collation. If empty, implies simple collation.
BSONObj _defaultCollation;
// Uniqueness of the sharding key.
bool _unique;
// Refresh fields set by primaries and used by shard secondaries to safely refresh chunk
// metadata. '_refreshing' indicates whether the chunks collection is currently being updated,
// which means read results won't provide a complete view of the chunk metadata.
// '_lastRefreshedCollectionVersion' indicates the collection version of the last complete chunk
// metadata refresh, and is used to indicate a refresh occurred if the value is different than
// when the caller last checked -- because 'refreshing' will be false both before and after a
// refresh occurs.
boost::optional<bool> _refreshing{boost::none};
boost::optional<ChunkVersion> _lastRefreshedCollectionVersion{boost::none};
};
} // namespace mongo
|
