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
|
/**
* Copyright (C) 2016 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 <string>
#include "mongo/client/connection_string.h"
#include "mongo/db/namespace_string.h"
#include "mongo/s/catalog/type_chunk.h"
#include "mongo/s/chunk_version.h"
#include "mongo/s/migration_secondary_throttle_options.h"
namespace mongo {
class BSONObjBuilder;
template <typename T>
class StatusWith;
/**
* Parses the arguments for a move chunk operation.
*/
class MoveChunkRequest {
public:
/**
* Parses the input command and produces a request corresponding to its arguments. The parsing
* ignores arguments, which are processed at the command level, in particular shardVersion and
* maxTimeMS.
*/
static StatusWith<MoveChunkRequest> createFromCommand(NamespaceString nss, const BSONObj& obj);
/**
* Constructs a moveChunk command with the specified parameters and writes it to the builder,
* without closing the builder. The builder must be empty, but callers are free to append more
* fields once the command has been constructed.
*
* The collectionVersion argument is appended, but not parsed by the createFromCommand method
* above, because it is processed by the mongod generic command parsing code.
*/
static void appendAsCommand(BSONObjBuilder* builder,
const NamespaceString& nss,
ChunkVersion collectionVersion,
const ConnectionString& configServerConnectionString,
const ShardId& fromShardId,
const ShardId& toShardId,
const ChunkRange& range,
ChunkVersion chunkVersion,
int64_t maxChunkSizeBytes,
const MigrationSecondaryThrottleOptions& secondaryThrottle,
bool waitForDelete,
bool takeDistLock);
const NamespaceString& getNss() const {
return _nss;
}
const ConnectionString& getConfigServerCS() const {
return _configServerCS;
}
const ShardId& getFromShardId() const {
return _fromShardId;
}
const ShardId& getToShardId() const {
return _toShardId;
}
const BSONObj& getMinKey() const {
return _range.getMin();
}
const BSONObj& getMaxKey() const {
return _range.getMax();
}
bool hasChunkVersion() const {
return _chunkVersion.is_initialized();
}
ChunkVersion getChunkVersion() const {
return *_chunkVersion;
}
int64_t getMaxChunkSizeBytes() const {
return _maxChunkSizeBytes;
}
const MigrationSecondaryThrottleOptions& getSecondaryThrottle() const {
return _secondaryThrottle;
}
bool getWaitForDelete() const {
return _waitForDelete;
}
bool getTakeDistLock() const {
return _takeDistLock;
}
/**
* Returns true if the requests match exactly in terms of the field values and the order of
* elements within the BSON-typed fields.
*/
bool operator==(const MoveChunkRequest& other) const;
bool operator!=(const MoveChunkRequest& other) const;
/**
* Print logging info for the request.
*/
std::string toString() const;
private:
MoveChunkRequest(NamespaceString nss,
ChunkRange range,
MigrationSecondaryThrottleOptions secondaryThrottle);
// The collection for which this request applies
NamespaceString _nss;
// Connections string for the config server. This is a legacy field and is used in order to
// initialize the sharding state on the donor shard in case it doesn't yet know that it is part
// of a sharded system.
ConnectionString _configServerCS;
// The source shard id
ShardId _fromShardId;
// The recipient shard id
ShardId _toShardId;
// Range of the chunk being moved
ChunkRange _range;
// Version of the chunk being moved. Optional for backwards compatibility with 3.2 mongos
// instances.
// TODO: Make non-optional after 3.4 is released.
boost::optional<ChunkVersion> _chunkVersion;
// This value is used by the migration source to determine the data size threshold above which a
// chunk would be considered jumbo and migrations will not proceed.
int64_t _maxChunkSizeBytes{0};
// The parsed secondary throttle options
MigrationSecondaryThrottleOptions _secondaryThrottle;
// Whether to block and wait for the range deleter to cleanup the orphaned documents at the end
// of move.
bool _waitForDelete;
// Whether to take the distributed lock for the collection or not.
bool _takeDistLock;
};
} // namespace mongo
|