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
|
/**
* Copyright (C) 2019-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 "mongo/base/error_extra_info.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/bsonobjbuilder.h"
namespace mongo {
/**
* This error is thrown when an update would cause a document to be owned by a different
* shard. If the update is part of a multi statement transaction, we will attach the
* query from the original update and the post image returned by the update stage. MongoS
* will use these to delete the original doc and insert the new doc. If the update is a
* retryable write, we will not attach any extra info and MongoS will start an internal
* transaction and re-send the original update command upon catching this error.
*/
class WouldChangeOwningShardInfo final : public ErrorExtraInfo {
public:
static constexpr auto code = ErrorCodes::WouldChangeOwningShard;
explicit WouldChangeOwningShardInfo(const boost::optional<BSONObj>& originalQueryPredicate,
const boost::optional<BSONObj>& postImage) {
// Either both originalQueryPredicate and postImage should be set or neither should.
invariant((originalQueryPredicate && postImage) != (!originalQueryPredicate && !postImage));
if (originalQueryPredicate)
_originalQueryPredicate = originalQueryPredicate->getOwned();
if (postImage)
_postImage = postImage->getOwned();
}
const auto& getOriginalQueryPredicate() const {
return _originalQueryPredicate;
}
const auto& getPostImage() const {
return _postImage;
}
BSONObj toBSON() const {
BSONObjBuilder bob;
serialize(&bob);
return bob.obj();
}
void serialize(BSONObjBuilder* bob) const override;
static std::shared_ptr<const ErrorExtraInfo> parse(const BSONObj&);
static WouldChangeOwningShardInfo parseFromCommandError(const BSONObj& commandError);
private:
// the 'q' portion of the original update comamand
boost::optional<BSONObj> _originalQueryPredicate;
// The post image returned by the update stage
boost::optional<BSONObj> _postImage;
};
using WouldChangeOwningShardException = ExceptionFor<ErrorCodes::WouldChangeOwningShard>;
} // namespace mongo
|
