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
131
|
/**
* 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/change_stream_constants.h"
#include "mongo/db/pipeline/document_source.h"
#include "mongo/db/pipeline/document_source_change_stream.h"
#include "mongo/db/pipeline/document_source_change_stream_gen.h"
#include "mongo/db/pipeline/document_source_sort.h"
#include "mongo/db/pipeline/resume_token.h"
#include "mongo/db/query/query_knobs_gen.h"
namespace mongo {
/**
* This stage checks whether or not the oplog has enough history to resume the stream, and consumes
* all events up to the given resume point. It is deployed on all shards when resuming a stream on
* a sharded cluster, and is also used in the single-replicaset case when a stream is opened with
* startAtOperationTime or with a high-water-mark resume token. It defers to the COLLSCAN to check
* whether the first event (matching or non-matching) encountered in the oplog has a timestamp equal
* to or earlier than the minTs in the change stream filter. If not, the COLLSCAN will throw an
* assertion, which this stage catches and converts into a more comprehensible $changeStream
* specific exception. The rules are:
*
* - If the first event seen in the oplog has the same timestamp as the requested resume token or
* startAtOperationTime, we can resume.
* - If the timestamp of the first event seen in the oplog is earlier than the requested resume
* token or startAtOperationTime, we can resume.
* - If the first entry in the oplog is a replica set initialization, then we can resume even if the
* token timestamp is earlier, since no events can have fallen off this oplog yet. This can happen
* in a sharded cluster when a new shard is added.
*
* - Otherwise we cannot resume, as we do not know if there were any events between the resume token
* and the first matching document in the oplog.
*/
class DocumentSourceChangeStreamCheckResumability : public DocumentSource,
public ChangeStreamStageSerializationInterface {
public:
static constexpr StringData kStageName = "$_internalChangeStreamCheckResumability"_sd;
// Used to record the results of comparing the token data extracted from documents in the
// resumed stream against the client's resume token.
enum class ResumeStatus {
kFoundToken, // The stream produced a document satisfying the client resume token.
kSurpassedToken, // The stream's latest document is more recent than the resume token.
kCheckNextDoc // The next document produced by the stream may contain the resume token.
};
const char* getSourceName() const override;
StageConstraints constraints(Pipeline::SplitState pipeState) const override {
return {StreamType::kStreaming,
PositionRequirement::kNone,
HostTypeRequirement::kAnyShard,
DiskUseRequirement::kNoDiskUse,
FacetRequirement::kNotAllowed,
TransactionRequirement::kNotAllowed,
LookupRequirement::kNotAllowed,
UnionRequirement::kNotAllowed,
ChangeStreamRequirement::kChangeStreamStage};
}
boost::optional<DistributedPlanLogic> distributedPlanLogic() final {
return boost::none;
}
Value serialize(boost::optional<ExplainOptions::Verbosity> explain) const override {
return ChangeStreamStageSerializationInterface::serializeToValue(explain);
}
static boost::intrusive_ptr<DocumentSourceChangeStreamCheckResumability> createFromBson(
BSONElement spec, const boost::intrusive_ptr<ExpressionContext>& expCtx) {
uassert(5467603,
str::stream() << "the '" << kStageName << "' object spec must be an object",
spec.type() == Object);
auto parsed = DocumentSourceChangeStreamCheckResumabilitySpec::parse(
IDLParserErrorContext("DocumentSourceChangeStreamCheckResumabilitySpec"),
spec.embeddedObject());
return create(expCtx, parsed.getResumeToken().getData());
}
static boost::intrusive_ptr<DocumentSourceChangeStreamCheckResumability> create(
const boost::intrusive_ptr<ExpressionContext>& expCtx, Timestamp ts);
static boost::intrusive_ptr<DocumentSourceChangeStreamCheckResumability> create(
const boost::intrusive_ptr<ExpressionContext>& expCtx, ResumeTokenData token);
protected:
/**
* Use the create static method to create a DocumentSourceChangeStreamCheckResumability.
*/
DocumentSourceChangeStreamCheckResumability(
const boost::intrusive_ptr<ExpressionContext>& expCtx, ResumeTokenData token);
GetNextResult doGetNext() override;
ResumeStatus _resumeStatus = ResumeStatus::kCheckNextDoc;
const ResumeTokenData _tokenFromClient;
private:
Value serializeLegacy(boost::optional<ExplainOptions::Verbosity> explain) const final;
Value serializeLatest(boost::optional<ExplainOptions::Verbosity> explain) const final;
};
} // namespace mongo
|
