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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/**
* Copyright (C) 2014 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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/exec/plan_stage.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/logical_session_id.h"
namespace mongo {
class CanonicalQuery;
class OpDebug;
class OperationContext;
class PlanExecutor;
struct DeleteStageParams {
DeleteStageParams()
: isMulti(false),
fromMigrate(false),
isExplain(false),
returnDeleted(false),
canonicalQuery(nullptr),
opDebug(nullptr) {}
// Should we delete all documents returned from the child (a "multi delete"), or at most one
// (a "single delete")?
bool isMulti;
// Is this delete part of a migrate operation that is essentially like a no-op
// when the cluster is observed by an external client.
bool fromMigrate;
// Are we explaining a delete command rather than actually executing it?
bool isExplain;
// Should we return the document we just deleted?
bool returnDeleted;
// The stmtId for this particular delete.
StmtId stmtId = kUninitializedStmtId;
// The parsed query predicate for this delete. Not owned here.
CanonicalQuery* canonicalQuery;
// The user-requested sort specification. Currently used just for findAndModify.
BSONObj sort;
// Optional. When not null, delete metrics are recorded here.
OpDebug* opDebug;
};
/**
* This stage delete documents by RecordId that are returned from its child. If the deleted
* document was requested to be returned, then ADVANCED is returned after deleting a document.
* Otherwise, NEED_TIME is returned after deleting a document.
*
* Callers of work() must be holding a write lock (and, for replicated deletes, callers must have
* had the replication coordinator approve the write).
*/
class DeleteStage final : public PlanStage {
MONGO_DISALLOW_COPYING(DeleteStage);
public:
DeleteStage(OperationContext* opCtx,
const DeleteStageParams& params,
WorkingSet* ws,
Collection* collection,
PlanStage* child);
bool isEOF() final;
StageState doWork(WorkingSetID* out) final;
void doRestoreState() final;
StageType stageType() const final {
return STAGE_DELETE;
}
std::unique_ptr<PlanStageStats> getStats() final;
const SpecificStats* getSpecificStats() const final;
static const char* kStageType;
/**
* Extracts the number of documents deleted by the delete plan 'exec'.
*
* Should only be called if the root plan stage of 'exec' is DELETE and if 'exec' is EOF.
*/
static long long getNumDeleted(const PlanExecutor& exec);
private:
/**
* Stores 'idToRetry' in '_idRetrying' so the delete can be retried during the next call to
* work(). Always returns NEED_YIELD and sets 'out' to WorkingSet::INVALID_ID.
*/
StageState prepareToRetryWSM(WorkingSetID idToRetry, WorkingSetID* out);
DeleteStageParams _params;
// Not owned by us.
WorkingSet* _ws;
// Collection to operate on. Not owned by us. Can be NULL (if NULL, isEOF() will always
// return true). If non-NULL, the lifetime of the collection must supersede that of the
// stage.
Collection* _collection;
// If not WorkingSet::INVALID_ID, we use this rather than asking our child what to do next.
WorkingSetID _idRetrying;
// If not WorkingSet::INVALID_ID, we return this member to our caller.
WorkingSetID _idReturning;
// Stats
DeleteStats _specificStats;
};
} // namespace mongo
|
