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
|
/**
* Copyright (C) 2012 10gen 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.
*/
/**
* Client utilities for upgrade processes, useful operations for safe configuration upgrades.
*
* These are not very general purpose, however, so are not in the general cluster utilities
* libraries.
*/
#pragma once
#include "mongo/client/dbclientinterface.h"
namespace mongo {
class VersionType;
/**
* Verifies that two collections contain documents with the same _ids.
*
* @return OK if they do, RemoteValidationError if they do not, and an error Status if
* anything else went wrong.
*/
Status checkIdsTheSame(const ConnectionString& configLoc,
const std::string& nsA,
const std::string& nsB);
/**
* Verifies that two collections hash to the same values.
*
* @return OK if they do, RemoteValidationError if they do not, and an error Status if
* anything else went wrong.
*/
Status checkHashesTheSame(const ConnectionString& configLoc,
const std::string& nsA,
const std::string& nsB);
/**
* Atomically overwrites a collection with another collection (only atomic if configLoc is a
* single server).
*
* @return OK if overwrite was successful, and an error Status if anything else went wrong.
*/
Status overwriteCollection(const ConnectionString& configLoc,
const std::string& fromNS,
const std::string& overwriteNS);
/**
* Creates a suffix for an upgrade's working collection
*/
std::string genWorkingSuffix(const OID& lastUpgradeId);
/**
* Creates a suffix for an upgrade's backup collection
*/
std::string genBackupSuffix(const OID& lastUpgradeId);
/**
* Checks whether an unsuccessful upgrade was performed last time and also checks whether
* the mongos in the current cluster have the mimimum version required. Returns not ok if
* the check failed and the upgrade should not proceed.
*
* Note: There is also a special case for ManualInterventionRequired error where the
* message will be empty.
*/
Status preUpgradeCheck(const ConnectionString& configServer,
const VersionType& lastVersionInfo,
std::string minMongosVersion);
/**
* Sets a new upgradeID and empties upgrade state to the config server.
*/
Status startConfigUpgrade(const std::string& configServer,
int currentVersion,
const OID& upgradeID);
/**
* Informs the config server that we are about to enter to the critical section of
* the upgrade.
*/
Status enterConfigUpgradeCriticalSection(const std::string& configServer, int currentVersion);
/**
* Informs the config server that the upgrade task was completed by bumping the version.
* This also clears all upgrade state effectively leaving the critical section if the
* upgrade process did enter it.
*/
Status commitConfigUpgrade(const std::string& configServer,
int currentVersion,
int minCompatibleVersion,
int newVersion);
}
|
