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
|
/**
* 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/query/plan_executor.h"
#include "mongo/db/record_id.h"
namespace mongo {
class BSONObj;
class Collection;
class IndexDescriptor;
class OperationContext;
class PlanStage;
class WorkingSet;
struct DeleteStageParams;
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. Caller owns pointer.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> collectionScan(
OperationContext* opCtx,
StringData ns,
Collection* collection,
PlanExecutor::YieldPolicy yieldPolicy,
const Direction direction = FORWARD,
const RecordId startLoc = RecordId());
/**
* Returns a FETCH => DELETE plan.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> deleteWithCollectionScan(
OperationContext* opCtx,
Collection* collection,
const DeleteStageParams& params,
PlanExecutor::YieldPolicy yieldPolicy,
Direction direction = FORWARD,
const RecordId& startLoc = RecordId());
/**
* Returns an index scan. Caller owns returned pointer.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> indexScan(
OperationContext* opCtx,
const Collection* collection,
const IndexDescriptor* descriptor,
const BSONObj& startKey,
const BSONObj& endKey,
BoundInclusion boundInclusion,
PlanExecutor::YieldPolicy yieldPolicy,
Direction direction = FORWARD,
int options = IXSCAN_DEFAULT);
/**
* Returns an IXSCAN => FETCH => DELETE plan.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> deleteWithIndexScan(
OperationContext* opCtx,
Collection* collection,
const DeleteStageParams& params,
const IndexDescriptor* descriptor,
const BSONObj& startKey,
const BSONObj& endKey,
BoundInclusion boundInclusion,
PlanExecutor::YieldPolicy yieldPolicy,
Direction direction = FORWARD);
/**
* Returns an IDHACK => UPDATE plan.
*/
static std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> updateWithIdHack(
OperationContext* opCtx,
Collection* collection,
const UpdateStageParams& params,
const IndexDescriptor* descriptor,
const BSONObj& key,
PlanExecutor::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(OperationContext* opCtx,
WorkingSet* ws,
const Collection* collection,
Direction direction,
const RecordId& startLoc);
/**
* 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(OperationContext* opCtx,
WorkingSet* ws,
const Collection* collection,
const IndexDescriptor* descriptor,
const BSONObj& startKey,
const BSONObj& endKey,
BoundInclusion boundInclusion,
Direction direction = FORWARD,
int options = IXSCAN_DEFAULT);
};
} // namespace mongo
|
