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
|
/**
* Copyright (C) 2012-2015 MongoDB 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 <boost/optional.hpp>
#include <string>
#include "mongo/db/jsobj.h"
#include "mongo/s/chunk_version.h"
namespace mongo {
class BSONObj;
class Status;
template<typename T> class StatusWith;
/**
* This class represents the layout and contents of documents contained in the
* config.chunks collection. All manipulation of documents coming from that
* collection should be done with this class.
*/
class ChunkType {
public:
// Name of the chunks collection in the config server.
static const std::string ConfigNS;
// Field names and types in the chunks collection type.
static const BSONField<std::string> name;
static const BSONField<std::string> ns;
static const BSONField<BSONObj> min;
static const BSONField<BSONObj> max;
static const BSONField<BSONArray> version;
static const BSONField<std::string> shard;
static const BSONField<bool> jumbo;
static const BSONField<Date_t> DEPRECATED_lastmod;
static const BSONField<OID> DEPRECATED_epoch;
/**
* Constructs a new ChunkType object from BSON.
* Also does validation of the contents.
*/
static StatusWith<ChunkType> fromBSON(const BSONObj& source);
/**
* Returns OK if all fields have been set. Otherwise returns NoSuchKey
* and information about the first field that is missing.
*/
Status validate() const;
/**
* Returns the BSON representation of the entry.
*/
BSONObj toBSON() const;
/**
* Returns a std::string representation of the current internal state.
*/
std::string toString() const;
const std::string& getName() const { return _name.get(); }
void setName(const std::string& name);
const std::string& getNS() const { return _ns.get(); }
void setNS(const std::string& name);
const BSONObj& getMin() const { return _min.get(); }
void setMin(const BSONObj& min);
const BSONObj& getMax() const { return _max.get(); }
void setMax(const BSONObj& max);
bool isVersionSet() const { return _version.is_initialized(); }
const ChunkVersion& getVersion() const { return _version.get(); }
void setVersion(const ChunkVersion& version);
const std::string& getShard() const { return _shard.get(); }
void setShard(const std::string& shard);
bool getJumbo() const { return _jumbo.get_value_or(false); }
void setJumbo(bool jumbo);
private:
// Convention: (M)andatory, (O)ptional, (S)pecial rule.
// (M) chunk's id
boost::optional<std::string> _name;
// (M) collection this chunk is in
boost::optional<std::string> _ns;
// (M) first key of the range, inclusive
boost::optional<BSONObj> _min;
// (M) last key of the range, non-inclusive
boost::optional<BSONObj> _max;
// (M) version of this chunk
boost::optional<ChunkVersion> _version;
// (M) shard this chunk lives in
boost::optional<std::string> _shard;
// (O) too big to move?
boost::optional<bool> _jumbo;
};
} // namespace mongo
|
