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
120
121
122
123
124
125
126
127
128
129
130
|
/**
* 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 <boost/optional.hpp>
#include <string>
#include <vector>
#include "mongo/db/ops/write_ops.h"
#include "mongo/db/session/logical_session_id.h"
#include "mongo/db/transaction/transaction_api.h"
#include "mongo/executor/task_executor_pool.h"
#include "mongo/s/transaction_router.h"
namespace mongo {
class BSONObj;
class BSONObjBuilder;
class NamespaceString;
class OperationContext;
class ShardRegistry;
template <typename T>
class StatusWith;
class TaskExecutor;
/**
* Set of functions used to update a document's shard key.
*/
namespace documentShardKeyUpdateUtil {
static constexpr StringData kDuplicateKeyErrorContext =
"Failed to update document's shard key "
"field. There is either an orphan for this document or _id for this collection is not "
"globally unique."_sd;
static constexpr StringData kNonDuplicateKeyErrorContext =
"Update operation was converted into a "
"distributed transaction because the document being updated would move shards and that "
"transaction failed."_sd;
/**
* TODO SERVER-67429 Remove this function.
*
* Coordinating method and external point of entry for updating a document's shard key. This method
* creates the necessary extra operations. It will then run each operation using the ClusterWriter.
* If any statement throws, an exception will leave this method, and must be handled by external
* callers.
*/
bool updateShardKeyForDocumentLegacy(OperationContext* opCtx,
const NamespaceString& nss,
const WouldChangeOwningShardInfo& documentKeyChangeInfo,
bool fleCrudProcessed = false);
/**
* Coordinating method and external point of entry for updating a document's shard key. This method
* creates the necessary extra operations. It will then run each operation using the given
* transaction client. If any statement throws, an exception will leave this method, and must be
* handled by external callers.
*
* Returns an error on any error returned by a command. If the original update was sent with
* {upsert: false}, returns whether or not we deleted the original doc and inserted the new one
* sucessfully. If the original update was sent with {upsert: true}, returns whether or not we
* inserted the new doc successfully.
*/
SemiFuture<bool> updateShardKeyForDocument(const txn_api::TransactionClient& txnClient,
ExecutorPtr txnExec,
const NamespaceString& nss,
const WouldChangeOwningShardInfo& changeInfo,
bool fleCrudProcessed = false);
/**
* Starts a transaction on this session. This method is called when WouldChangeOwningShard is thrown
* for a write that is not in a transaction already.
*/
void startTransactionForShardKeyUpdate(OperationContext* opCtx);
/**
* Commits the transaction on this session. This method is called to commit the transaction started
* when WouldChangeOwningShard is thrown for a write that is not in a transaction already.
*/
BSONObj commitShardKeyUpdateTransaction(OperationContext* opCtx);
/**
* Creates the BSONObj that will be used to delete the pre-image document. Will also attach
* necessary generic transaction and passthrough field transaction information.
*
* This method should not be called outside of this class. It is only temporarily exposed for
* intermediary test coverage.
*/
BSONObj constructShardKeyDeleteCmdObj(const NamespaceString& nss, const BSONObj& updatePreImage);
/*
* Creates the BSONObj that will be used to insert the new document with the post-update image.
* Will attach all necessary generic transaction and passthrough field transaction information.
*
* This method should not be called outside of this class. It is only temporarily exposed for
* intermediary test coverage.
*/
BSONObj constructShardKeyInsertCmdObj(const NamespaceString& nss,
const BSONObj& updatePostImage,
bool fleCrudProcessed);
} // namespace documentShardKeyUpdateUtil
} // namespace mongo
|
