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
|
/**
* Copyright (C) 2021-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/db/pipeline/document_source.h"
namespace mongo {
/**
* This stage will take a list of oplog entry documents as input and forge a no-op pre- or
* post-image to be returned before the document for each 'findAndModify' oplog entry that has the
* the 'needsRetryImage' field or each 'applyOps' oplog entry with a 'findAndModify' operation entry
* that has the 'needsRetryImage' field. This stage also downconverts 'findAndModify' or 'applyOps'
* oplog entry documents by stripping the 'needsRetryImage' field and appending the appropriate
* 'preImageOpTime' or 'postImageOpTime' field. If 'includeCommitTransactionTimestamp' is true,
* the forged pre- or post-image oplog entry document for each 'applyOps' oplog entry document that
* comes with a transaction commit timestamp will have the commit timestamp attached to it.
*/
class DocumentSourceFindAndModifyImageLookup : public DocumentSource {
public:
static constexpr StringData kStageName = "$_internalFindAndModifyImageLookup"_sd;
static constexpr StringData kIncludeCommitTransactionTimestampFieldName =
"includeCommitTransactionTimestamp"_sd;
static boost::intrusive_ptr<DocumentSourceFindAndModifyImageLookup> create(
const boost::intrusive_ptr<ExpressionContext>& expCtx,
bool includeCommitTransactionTimestamp = false);
static boost::intrusive_ptr<DocumentSourceFindAndModifyImageLookup> createFromBson(
BSONElement elem, const boost::intrusive_ptr<ExpressionContext>& expCtx);
DepsTracker::State getDependencies(DepsTracker* deps) const final;
void addVariableRefs(std::set<Variables::Id>* refs) const final {}
DocumentSource::GetModPathsReturn getModifiedPaths() const final;
Value serialize(SerializationOptions opts = SerializationOptions()) const final override;
StageConstraints constraints(Pipeline::SplitState pipeState) const final;
boost::optional<DistributedPlanLogic> distributedPlanLogic() final {
return boost::none;
}
const char* getSourceName() const {
return DocumentSourceFindAndModifyImageLookup::kStageName.rawData();
}
protected:
DocumentSource::GetNextResult doGetNext() override;
private:
DocumentSourceFindAndModifyImageLookup(const boost::intrusive_ptr<ExpressionContext>& expCtx,
bool includeCommitTransactionTimestamp);
// Downconverts 'findAndModify' or 'applyOps' entries with 'needsRetryImage'. If an oplog entry
// document has 'needsRetryImage' set, we downconvert and stash the document as
// '_stashedDownconvertedDoc' and then forge a no-op pre- or post-image document and return it.
Document _downConvertIfNeedsRetryImage(Document inputDoc);
// Set to true if the input oplog entry documents can have a transaction commit timestamp
// attached to it.
bool _includeCommitTransactionTimestamp;
// Represents the stashed downconverted 'findAndModify' or 'applyOps' oplog entry document.
// This indicates that the previous document emitted was a forged pre- or post-image.
boost::optional<Document> _stashedDownconvertedDoc;
};
} // namespace mongo
|
