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
|
/**
* 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 <vector>
#include "mongo/base/status_with.h"
#include "mongo/db/catalog/collection_operation_source.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/ops/single_write_result_gen.h"
#include "mongo/db/ops/update_result.h"
#include "mongo/db/ops/write_ops.h"
#include "mongo/s/stale_exception.h"
namespace mongo {
class OpDebug;
class ParsedUpdate;
namespace write_ops_exec {
/**
* The result of performing a single write, possibly within a batch.
*/
struct WriteResult {
/**
* Maps 1-to-1 to single ops in request. May be shorter than input if there are errors.
*/
std::vector<StatusWith<SingleWriteResult>> results;
// Stores the statement ids for the ops that had already been executed, thus were not executed
// by this write.
std::vector<StmtId> retriedStmtIds;
// In case of an error, whether the operation can continue.
bool canContinue = true;
};
/**
* Performs a batch of inserts, updates, or deletes.
*
* These functions handle all of the work of doing the writes, including locking, incrementing
* counters, managing CurOp, and of course actually doing the write. Waiting for the writeConcern is
* *not* handled by these functions and is expected to be done by the caller if needed.
*
* NotPrimaryErrorTracker is updated for failures of individual writes, but not for batch errors
* reported by an exception being thrown from these functions. Callers are responsible for managing
* NotPrimaryErrorTracker in that case. This should generally be combined with
* NotPrimaryErrorTracker handling from parse failures.
*
* 'type' indicates whether the operation was induced by a standard write, a chunk migration, or a
* time-series insert.
*
* Note: performInserts() gets called for both user and internal (like tenant collection cloner,
* and initial sync/tenant migration oplog buffer) inserts.
*/
WriteResult performInserts(OperationContext* opCtx,
const write_ops::InsertCommandRequest& op,
OperationSource source = OperationSource::kStandard);
WriteResult performUpdates(OperationContext* opCtx,
const write_ops::UpdateCommandRequest& op,
OperationSource source = OperationSource::kStandard);
WriteResult performDeletes(OperationContext* opCtx,
const write_ops::DeleteCommandRequest& op,
OperationSource source = OperationSource::kStandard);
Status performAtomicTimeseriesWrites(OperationContext* opCtx,
const std::vector<write_ops::InsertCommandRequest>& insertOps,
const std::vector<write_ops::UpdateCommandRequest>& updateOps);
/**
* Populate 'opDebug' with stats describing the execution of an update operation. Illegal to call
* with a null OpDebug pointer.
*/
void recordUpdateResultInOpDebug(const UpdateResult& updateResult, OpDebug* opDebug);
/**
* Returns true if an update failure due to a given DuplicateKey error is eligible for retry.
* Requires that parsedUpdate.hasParsedQuery() is true.
*/
bool shouldRetryDuplicateKeyException(const ParsedUpdate& parsedUpdate,
const DuplicateKeyErrorInfo& errorInfo);
} // namespace write_ops_exec
} // namespace mongo
|
