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
|
/**
* 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 "mongo/client/connection_string.h"
#include "mongo/db/namespace_string.h"
#include "mongo/s/chunk_version.h"
#include "mongo/s/shard_id.h"
namespace mongo {
class BSONObj;
template <typename T>
class StatusWith;
/**
* Encapsulates the parsing and construction logic for the SetShardVersion command.
*/
class SetShardVersionRequest {
public:
static constexpr StringData kVersion = "version"_sd;
SetShardVersionRequest(NamespaceString nss,
ChunkVersion version,
bool isAuthoritative,
bool forceRefresh = false);
/**
* Parses an SSV request from a set shard version command.
*/
static StatusWith<SetShardVersionRequest> parseFromBSON(const BSONObj& cmdObj);
/**
* Produces a BSON representation of the request, which can be used for sending as a command.
*/
BSONObj toBSON() const;
/**
* Returns whether this request should force the version to be set instead of it being reloaded
* and recalculated from the metadata.
*/
bool isAuthoritative() const {
return _isAuthoritative;
}
/**
* Returns whether the set shard version catalog refresh is allowed to join
* an in-progress refresh triggered by an other thread, or whether it's
* required to either a) trigger its own refresh or b) wait for a refresh
* to be started after it has entered the getCollectionRoutingInfoWithRefresh function
*/
bool shouldForceRefresh() const {
return _forceRefresh;
}
/**
* Returns the namespace associated with this set shard version request. It is illegal to access
* this field if isInit() returns true.
*/
const NamespaceString& getNS() const;
/**
* Returns the version of the namespace associated with this set shard version request. It is
* illegal to access this field if isInit() returns true.
*/
const ChunkVersion getNSVersion() const;
private:
SetShardVersionRequest();
bool _isAuthoritative{false};
// TODO (SERVER-50812) remove this flag that isn't used anymore
bool _forceRefresh{false};
boost::optional<NamespaceString> _nss;
boost::optional<ChunkVersion> _version;
};
} // namespace mongo
|