summaryrefslogtreecommitdiff
path: root/src/mongo/s/request_types/merge_chunk_request_type.h
blob: 2722c53b057a86735d81f899ecea8e40e188baa5 (plain)
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
/**
 *    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 <vector>

#include "mongo/base/status_with.h"

#include "mongo/db/jsobj.h"
#include "mongo/db/namespace_string.h"

namespace mongo {

/**
 * Provides support for parsing and serialization of arguments to the config server mergeChunk
 * command.
 */
class MergeChunkRequest {
public:
    MergeChunkRequest(NamespaceString nss,
                      std::string shardName,
                      OID epoch,
                      std::vector<BSONObj> chunkBoundaries,
                      boost::optional<Timestamp> validAfter);

    /**
     * Parses the provided BSON content as the internal _configsvrCommitChunkMerge command, and if
     * it contains the correct types, constructs a MergeChunkRequest object from it.
     *
     * {
     *   _configsvrCommitChunkMerge: <NamespaceString nss>,
     *   collEpoch: <OID epoch>,
     *   chunkBoundaries: [
     *       <BSONObj key1>,
     *       <BSONObj key2>,
     *       ...
     *   ],
     *   shard: <string shard>
     * }
     */
    static StatusWith<MergeChunkRequest> parseFromConfigCommand(const BSONObj& cmdObj);

    /**
     * Creates a BSONObjBuilder and uses it to create and return a BSONObj from this
     * MergeChunkRequest instance. Calls appendAsConfigCommand and tacks on the passed-in
     * writeConcern.
     */
    BSONObj toConfigCommandBSON(const BSONObj& writeConcern);

    /**
     * Creates a serialized BSONObj of the internal _configsvCommitChunkMerge command from this
     * MergeChunkRequest instance.
     */
    void appendAsConfigCommand(BSONObjBuilder* cmdBuilder);

    const NamespaceString& getNamespace() const {
        return _nss;
    }

    const OID& getEpoch() const {
        return _epoch;
    }

    const std::vector<BSONObj>& getChunkBoundaries() const {
        return _chunkBoundaries;
    }

    const std::string& getShardName() const {
        return _shardName;
    }

    const boost::optional<Timestamp>& getValidAfter() const {
        return _validAfter;
    }

private:
    NamespaceString _nss;
    OID _epoch;

    // The boundaries of the chunks to be merged.
    std::vector<BSONObj> _chunkBoundaries;

    std::string _shardName;

    boost::optional<Timestamp> _validAfter;
};

}  // namespace mongo