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
188
189
190
191
192
193
|
/**
* Copyright (C) 2012 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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/db/range_arithmetic.h"
#include "mongo/s/catalog/type_chunk.h"
#include "mongo/s/chunk_version.h"
#include "mongo/s/shard_key_pattern.h"
namespace mongo {
class ChunkType;
/**
* The collection metadata has metadata information about a collection, in particular the
* sharding information. It's main goal in life is to be capable of answering if a certain
* document belongs to it or not. (In some scenarios such as chunk migration, a given
* document is in a shard but cannot be accessed.)
*
* To build a collection from config data, please check the MetadataLoader. The methods
* here allow building a new incarnation of a collection's metadata based on an existing
* one (e.g, we're splitting in a given collection.).
*
* This class is immutable once constructed.
*/
class CollectionMetadata {
public:
/**
* The main way to construct CollectionMetadata is through MetadataLoader or clone() methods.
*/
CollectionMetadata(const BSONObj& keyPattern,
ChunkVersion collectionVersion,
ChunkVersion shardVersion,
RangeMap shardChunksMap);
~CollectionMetadata();
/**
* Returns a new metadata's instance based on 'this's state;
*/
std::unique_ptr<CollectionMetadata> clone() const;
/**
* Returns true if the document key 'key' is a valid instance of a shard key for this
* metadata. The 'key' must contain exactly the same fields as the shard key pattern.
*/
bool isValidKey(const BSONObj& key) const;
/**
* Returns true if the document key 'key' belongs to this chunkset. Recall that documents of
* an in-flight chunk migration may be present and should not be considered part of the
* collection / chunkset yet. Key must be the full shard key.
*/
bool keyBelongsToMe(const BSONObj& key) const;
/**
* Given a key 'lookupKey' in the shard key range, get the next chunk which overlaps or is
* greater than this key. Returns true if a chunk exists, false otherwise.
*
* Passing a key that is not a valid shard key for this range results in undefined behavior.
*/
bool getNextChunk(const BSONObj& lookupKey, ChunkType* chunk) const;
/**
* Given a chunk identifying key "chunkMinKey", finds a different chunk if one exists.
*/
bool getDifferentChunk(const BSONObj& chunkMinKey, ChunkType* differentChunk) const;
/**
* Validates that the passed-in chunk's bounds exactly match a chunk in the metadata cache.
*/
Status checkChunkIsValid(const ChunkType& chunk);
/**
* Returns true if the argument range overlaps any chunk.
*/
bool rangeOverlapsChunk(ChunkRange const& range);
/**
* Given a key in the shard key range, get the next range which overlaps or is greater than
* this key.
*
* This allows us to do the following to iterate over all orphan ranges:
*
* KeyRange range;
* BSONObj lookupKey = metadata->getMinKey();
* boost::optional<KeyRange> range;
* while((range = metadata->getNextOrphanRange(receiveMap, lookupKey))) {
* lookupKey = range->maxKey;
* }
*
* @param lookupKey passing a key that does not belong to this metadata is undefined.
* @param receiveMap is an extra set of chunks not considered orphaned.
* @param orphanRange the output range. Note that the NS is not set.
*/
boost::optional<KeyRange> getNextOrphanRange(RangeMap const& receiveMap,
BSONObj const& lookupKey) const;
ChunkVersion getCollVersion() const {
return _collVersion;
}
ChunkVersion getShardVersion() const {
return _shardVersion;
}
const RangeMap& getChunks() const {
return _chunksMap;
}
const BSONObj& getKeyPattern() const {
return _shardKeyPattern.toBSON();
}
const std::vector<std::unique_ptr<FieldRef>>& getKeyPatternFields() const {
return _shardKeyPattern.getKeyPatternFields();
}
BSONObj getMinKey() const;
BSONObj getMaxKey() const;
std::size_t getNumChunks() const {
return _chunksMap.size();
}
/**
* BSON output of the basic metadata information (chunk and shard version).
*/
void toBSONBasic(BSONObjBuilder& bb) const;
/**
* BSON output of the chunks metadata into a BSONArray
*/
void toBSONChunks(BSONArrayBuilder& bb) const;
/**
* String output of the collection and shard versions.
*/
std::string toStringBasic() const;
private:
/**
* Builds _rangesMap from the contents of _chunksMap.
*/
void _buildRangesMap();
// Shard key pattern for the collection
ShardKeyPattern _shardKeyPattern;
// a version for this collection that identifies the collection incarnation (ie, a
// dropped and recreated collection with the same name would have a different version)
ChunkVersion _collVersion;
// highest ChunkVersion for which this metadata's information is accurate
ChunkVersion _shardVersion;
// Map of chunks tracked by this shard
RangeMap _chunksMap;
// A second map from a min key into a range of contiguous chunks. The map is redundant
// w.r.t. _chunkMap but we expect high chunk contiguity, especially in small
// installations.
RangeMap _rangesMap;
};
} // namespace mongo
|
