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) 2012-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 <boost/intrusive_ptr.hpp>
#include <memory>
#include "mongo/bson/bsonobj.h"
#include "mongo/db/namespace_string.h"
namespace mongo {
class Collection;
class DocumentSourceCursor;
class DocumentSourceSort;
struct ExpressionContext;
class OperationContext;
class Pipeline;
class PlanExecutor;
struct PlanSummaryStats;
class BSONObj;
struct DepsTracker;
/*
PipelineD is an extension of the Pipeline class, but with additional
material that references symbols that are not available in mongos,
where the remainder of the Pipeline class also functions. PipelineD
is a friend of Pipeline so that it can have equal access to Pipeline's
members.
See the friend declaration in Pipeline.
*/
class PipelineD {
public:
/**
* Create a Cursor wrapped in a DocumentSourceCursor, which is suitable
* to be the first source for a pipeline to begin with. This source
* will feed the execution of the pipeline.
*
* This method looks for early pipeline stages that can be folded into
* the underlying cursor, and when a cursor can absorb those, they
* are removed from the head of the pipeline. For example, an
* early match can be removed and replaced with a Cursor that will
* do an index scan.
*
* The cursor is added to the front of the pipeline's sources.
*
* Callers must take care to ensure that 'collection' is locked in at least IS-mode.
*/
static void prepareCursorSource(Collection* collection,
const boost::intrusive_ptr<Pipeline>& pipeline);
static std::string getPlanSummaryStr(const boost::intrusive_ptr<Pipeline>& pPipeline);
static void getPlanSummaryStats(const boost::intrusive_ptr<Pipeline>& pPipeline,
PlanSummaryStats* statsOut);
private:
PipelineD(); // does not exist: prevent instantiation
/**
* Creates a PlanExecutor to be used in the initial cursor source. If the query system can use
* an index to provide a more efficient sort or projection, the sort and/or projection will be
* incorporated into the PlanExecutor.
*
* 'sortObj' will be set to an empty object if the query system cannot provide a non-blocking
* sort, and 'projectionObj' will be set to an empty object if the query system cannot provide a
* covered projection.
*/
static StatusWith<std::unique_ptr<PlanExecutor>> prepareExecutor(
OperationContext* txn,
Collection* collection,
const NamespaceString& nss,
const boost::intrusive_ptr<Pipeline>& pipeline,
const boost::intrusive_ptr<ExpressionContext>& expCtx,
const boost::intrusive_ptr<DocumentSourceSort>& sortStage,
const DepsTracker& deps,
const BSONObj& queryObj,
BSONObj* sortObj,
BSONObj* projectionObj);
/**
* Creates a DocumentSourceCursor from the given PlanExecutor and adds it to the front of the
* Pipeline.
*/
static void addCursorSource(const boost::intrusive_ptr<Pipeline>& pipeline,
const boost::intrusive_ptr<ExpressionContext>& expCtx,
std::unique_ptr<PlanExecutor> exec,
DepsTracker deps,
const BSONObj& queryObj = BSONObj(),
const BSONObj& sortObj = BSONObj(),
const BSONObj& projectionObj = BSONObj());
};
} // namespace mongo
|
