/**
* 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 .
*
* 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
#include "mongo/client/connection_string.h"
#include "mongo/db/namespace_string.h"
#include "mongo/s/chunk_version.h"
#include "mongo/s/migration_secondary_throttle_options.h"
namespace mongo {
class BSONObjBuilder;
template
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 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 shardVersion 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,
const ChunkVersion& shardVersion,
const ConnectionString& configServerConnectionString,
const std::string& fromShardId,
const std::string& toShardId,
const BSONObj& chunkMinKey,
const BSONObj& chunkMaxKey,
int64_t maxChunkSizeBytes,
const MigrationSecondaryThrottleOptions& secondaryThrottle,
bool waitForDelete);
const NamespaceString& getNss() const {
return _nss;
}
const ConnectionString& getConfigServerCS() const {
return _configServerCS;
}
const std::string& getFromShardId() const {
return _fromShardId;
}
const std::string& getToShardId() const {
return _toShardId;
}
const BSONObj& getMinKey() const {
return _minKey;
}
const BSONObj& getMaxKey() const {
return _maxKey;
}
int64_t getMaxChunkSizeBytes() const {
return _maxChunkSizeBytes;
}
const MigrationSecondaryThrottleOptions& getSecondaryThrottle() const {
return _secondaryThrottle;
}
bool getWaitForDelete() const {
return _waitForDelete;
}
private:
MoveChunkRequest(NamespaceString nss, 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
std::string _fromShardId;
// The recipient shard id
std::string _toShardId;
// Exact min and max key of the chunk being moved
BSONObj _minKey;
BSONObj _maxKey;
// 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;
};
} // namespace mongo