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
|
/**
* 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 <vector>
#include "mongo/db/jsobj.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/shard_id.h"
namespace mongo {
struct BSONArray;
class BSONObj;
class Status;
template <typename T>
class StatusWith;
/**
* This class represents the layout and contents of documents contained in the
* config.shards collection. All manipulation of documents coming from that
* collection should be done with this class.
*/
class ShardType {
public:
enum class ShardState : int {
kNotShardAware = 0,
kShardAware,
};
// Field names and types in the shards collection type.
static const BSONField<std::string> name;
static const BSONField<std::string> host;
static const BSONField<bool> draining;
static const BSONField<long long> maxSizeMB;
static const BSONField<BSONArray> tags;
static const BSONField<ShardState> state;
static const BSONField<Timestamp> topologyTime;
ShardType() = default;
ShardType(std::string name, std::string host, std::vector<std::string> tags = {});
/**
* Constructs a new ShardType object from BSON.
* Also does validation of the contents.
*/
static StatusWith<ShardType> 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& getHost() const {
return _host.get();
}
void setHost(const std::string& host);
bool getDraining() const {
return _draining.value_or(false);
}
void setDraining(bool draining);
long long getMaxSizeMB() const {
return _maxSizeMB.value_or(0);
}
void setMaxSizeMB(long long maxSizeMB);
std::vector<std::string> getTags() const {
return _tags.value_or(std::vector<std::string>());
}
void setTags(const std::vector<std::string>& tags);
ShardState getState() const {
return _state.value_or(ShardState::kNotShardAware);
}
void setState(ShardState state);
Timestamp getTopologyTime() const {
return _topologyTime.value_or(Timestamp());
}
void setTopologyTime(const Timestamp& topologyTime);
private:
// Convention: (M)andatory, (O)ptional, (S)pecial rule.
// (M) shard's id
boost::optional<std::string> _name;
// (M) connection string for the host(s)
boost::optional<std::string> _host;
// (O) is it draining chunks?
boost::optional<bool> _draining;
// (O) maximum allowed disk space in MB
boost::optional<long long> _maxSizeMB;
// (O) shard tags
boost::optional<std::vector<std::string>> _tags;
// (O) shard state
boost::optional<ShardState> _state;
// (O) topologyTime
boost::optional<Timestamp> _topologyTime;
};
} // namespace mongo
|
