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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/**
* 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 "mongo/base/string_data.h"
#include "mongo/db/catalog/index_catalog.h"
#include "mongo/db/exec/batched_delete_stage.h"
#include "mongo/db/exec/delete_stage.h"
#include "mongo/db/query/index_bounds.h"
#include "mongo/db/query/plan_executor.h"
#include "mongo/db/record_id.h"
#include "mongo/db/s/shard_key_index_util.h"
namespace mongo {
class BSONObj;
class Collection;
class CollectionPtr;
class IndexDescriptor;
class OperationContext;
class PlanStage;
class WorkingSet;
struct UpdateStageParams;
/**
* The internal planner is a one-stop shop for "off-the-shelf" plans. Most internal procedures
* that do not require advanced queries could be served by plans already in here.
*/
class InternalPlanner {
public:
enum Direction {
FORWARD = 1,
BACKWARD = -1,
};
enum IndexScanOptions {
// The client is interested in the default outputs of an index scan: BSONObj of the key,
// RecordId of the record that's indexed. The client does its own fetching if required.
IXSCAN_DEFAULT = 0,
// The client wants the fetched object and the RecordId that refers to it. Delegating
// the fetch to the runner allows fetching outside of a lock.
IXSCAN_FETCH = 1,
};
/**
* Returns a collection scan. Refer to CollectionScanParams for usage of 'minRecord' and
* 'maxRecord'.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> collectionScan(
OperationContext* opCtx,
const CollectionPtr* collection,
PlanYieldPolicy::YieldPolicy yieldPolicy,
Direction direction = FORWARD,
const boost::optional<RecordId>& resumeAfterRecordId = boost::none,
boost::optional<RecordIdBound> minRecord = boost::none,
boost::optional<RecordIdBound> maxRecord = boost::none,
CollectionScanParams::ScanBoundInclusion boundInclusion =
CollectionScanParams::ScanBoundInclusion::kIncludeBothStartAndEndRecords,
bool shouldReturnEofOnFilterMismatch = false);
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> collectionScan(
OperationContext* opCtx,
const CollectionPtr* collection,
const CollectionScanParams& params,
PlanYieldPolicy::YieldPolicy yieldPolicy);
/**
* Returns a FETCH => DELETE plan, or a FETCH => BATCHED_DELETE plan if 'batchedDeleteParams' is
* set.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> deleteWithCollectionScan(
OperationContext* opCtx,
const CollectionPtr* collection,
std::unique_ptr<DeleteStageParams> deleteStageParams,
PlanYieldPolicy::YieldPolicy yieldPolicy,
Direction direction = FORWARD,
boost::optional<RecordIdBound> minRecord = boost::none,
boost::optional<RecordIdBound> maxRecord = boost::none,
CollectionScanParams::ScanBoundInclusion boundInclusion =
CollectionScanParams::ScanBoundInclusion::kIncludeBothStartAndEndRecords,
std::unique_ptr<BatchedDeleteStageParams> batchedDeleteParams = nullptr,
const MatchExpression* filter = nullptr,
bool shouldReturnEofOnFilterMismatch = false);
/**
* Returns an index scan. Caller owns returned pointer.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> indexScan(
OperationContext* opCtx,
const CollectionPtr* collection,
const IndexDescriptor* descriptor,
const BSONObj& startKey,
const BSONObj& endKey,
BoundInclusion boundInclusion,
PlanYieldPolicy::YieldPolicy yieldPolicy,
Direction direction = FORWARD,
int options = IXSCAN_DEFAULT);
/**
* Returns an IXSCAN => FETCH => DELETE plan, or an IXSCAN => FETCH => BATCHED_DELETE plan if
* 'batchedDeleteParams' is set.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> deleteWithIndexScan(
OperationContext* opCtx,
const CollectionPtr* collection,
std::unique_ptr<DeleteStageParams> params,
const IndexDescriptor* descriptor,
const BSONObj& startKey,
const BSONObj& endKey,
BoundInclusion boundInclusion,
PlanYieldPolicy::YieldPolicy yieldPolicy,
Direction direction = FORWARD,
std::unique_ptr<BatchedDeleteStageParams> batchedDeleteParams = nullptr);
/**
* Returns a scan over the 'shardKeyIdx'. If the 'shardKeyIdx' is a non-clustered index, returns
* an index scan. If the 'shardKeyIdx' is a clustered idx, returns a bounded collection scan
* since the clustered index does not require a separate index lookup table.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> shardKeyIndexScan(
OperationContext* opCtx,
const CollectionPtr* collection,
const ShardKeyIndex& shardKeyIdx,
const BSONObj& startKey,
const BSONObj& endKey,
BoundInclusion boundInclusion,
PlanYieldPolicy::YieldPolicy yieldPolicy,
Direction direction = FORWARD,
int options = IXSCAN_DEFAULT);
/**
* Returns an IXSCAN => FETCH => DELETE plan when 'shardKeyIdx' indicates the index is a
* standard index or a COLLSCAN => DELETE when 'shardKeyIdx' indicates the index is a clustered
* index.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> deleteWithShardKeyIndexScan(
OperationContext* opCtx,
const CollectionPtr* collection,
std::unique_ptr<DeleteStageParams> params,
const ShardKeyIndex& shardKeyIdx,
const BSONObj& startKey,
const BSONObj& endKey,
BoundInclusion boundInclusion,
PlanYieldPolicy::YieldPolicy yieldPolicy,
Direction direction = FORWARD);
/**
* Returns an IDHACK => UPDATE plan.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> updateWithIdHack(
OperationContext* opCtx,
const CollectionPtr* collection,
const UpdateStageParams& params,
const IndexDescriptor* descriptor,
const BSONObj& key,
PlanYieldPolicy::YieldPolicy yieldPolicy);
private:
/**
* Returns a plan stage that can be used for a collection scan.
*
* Used as a helper for collectionScan() and deleteWithCollectionScan().
*/
static std::unique_ptr<PlanStage> _collectionScan(
const boost::intrusive_ptr<ExpressionContext>& expCtx,
WorkingSet* ws,
const CollectionPtr* collection,
Direction direction,
const boost::optional<RecordId>& resumeAfterRecordId = boost::none,
const boost::optional<RecordId>& minRecord = boost::none,
const boost::optional<RecordId>& maxRecord = boost::none);
static std::unique_ptr<PlanStage> _collectionScan(
const boost::intrusive_ptr<ExpressionContext>& expCtx,
WorkingSet* ws,
const CollectionPtr* collection,
const CollectionScanParams& params,
const MatchExpression* filter = nullptr);
/**
* Returns a plan stage that is either an index scan or an index scan with a fetch stage.
*
* Used as a helper for indexScan() and deleteWithIndexScan().
*/
static std::unique_ptr<PlanStage> _indexScan(
const boost::intrusive_ptr<ExpressionContext>& expCtx,
WorkingSet* ws,
const CollectionPtr* collection,
const IndexDescriptor* descriptor,
const BSONObj& startKey,
const BSONObj& endKey,
BoundInclusion boundInclusion,
Direction direction = FORWARD,
int options = IXSCAN_DEFAULT);
};
} // namespace mongo
|
