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
|
/**
* Copyright (C) 2013 10gen 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/collection_scan.h"
#include "mongo/db/query/eof_runner.h"
#include "mongo/db/exec/fetch.h"
#include "mongo/db/exec/index_scan.h"
#include "mongo/db/index/catalog_hack.h"
#include "mongo/db/query/internal_runner.h"
#include "mongo/db/query/query_projection.h"
namespace mongo {
/**
* 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,
// DiskLoc 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 DiskLoc that refers to it. Delegating
// the fetch to the runner allows fetching outside of a lock.
IXSCAN_FETCH = 1,
};
/**
* Return a collection scan. Caller owns pointer.
*/
static Runner* collectionScan(const StringData& ns,
const Direction direction = FORWARD,
const DiskLoc startLoc = DiskLoc()) {
NamespaceDetails* nsd = nsdetails(ns);
if (NULL == nsd) { return new EOFRunner(NULL, ns.toString()); }
CollectionScanParams params;
params.ns = ns.toString();
params.start = startLoc;
if (FORWARD == direction) {
params.direction = CollectionScanParams::FORWARD;
}
else {
params.direction = CollectionScanParams::BACKWARD;
}
WorkingSet* ws = new WorkingSet();
CollectionScan* cs = new CollectionScan(params, ws, NULL);
return new InternalRunner(ns.toString(), cs, ws);
}
/**
* Return an index scan. Caller owns returned pointer.
*/
static Runner* indexScan(const StringData& ns, NamespaceDetails* nsd, int idxNo,
const BSONObj& startKey, const BSONObj& endKey,
bool endKeyInclusive, Direction direction = FORWARD,
int options = 0) {
verify(NULL != nsd);
IndexScanParams params;
params.descriptor = CatalogHack::getDescriptor(nsd, idxNo);
verify(NULL != params.descriptor);
params.direction = direction;
params.bounds.isSimpleRange = true;
params.bounds.startKey = startKey;
params.bounds.endKey = endKey;
params.bounds.endKeyInclusive = endKeyInclusive;
// This always as 'true' as this is the new btreecursor. Even if the underlying index
// is 'special' (ie, expression) we treat it like a Btree.
params.forceBtreeAccessMethod = true;
WorkingSet* ws = new WorkingSet();
IndexScan* ix = new IndexScan(params, ws, NULL);
if (IXSCAN_FETCH & options) {
return new InternalRunner(ns.toString(), new FetchStage(ws, ix, NULL), ws);
}
else {
return new InternalRunner(ns.toString(), ix, ws);
}
}
};
} // namespace mongo
|
