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
|
/**
* 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 <boost/optional/optional.hpp>
#include <boost/smart_ptr.hpp>
#include "mongo/db/catalog/collection.h"
#include "mongo/db/exec/plan_stage.h"
#include "mongo/db/exec/plan_stats.h"
#include "mongo/db/pipeline/pipeline.h"
#include "mongo/db/record_id.h"
namespace mongo {
/**
* Stage for pulling results out from an aggregation pipeline.
*/
class PipelineProxyStage : public PlanStage {
public:
PipelineProxyStage(intrusive_ptr<Pipeline> pipeline,
const boost::shared_ptr<PlanExecutor>& child,
WorkingSet* ws);
virtual PlanStage::StageState work(WorkingSetID* out);
virtual bool isEOF();
virtual void invalidate(OperationContext* txn, const RecordId& dl, InvalidationType type);
//
// Manage our OperationContext. We intentionally don't propagate to the child
// Runner as that is handled by DocumentSourceCursor as it needs to.
//
virtual void saveState();
virtual void restoreState(OperationContext* opCtx);
/**
* Make obj the next object returned by getNext().
*/
void pushBack(const BSONObj& obj);
/**
* Return a shared pointer to the PlanExecutor that feeds the pipeline. The returned
* pointer may be NULL.
*/
boost::shared_ptr<PlanExecutor> getChildExecutor();
//
// These should not be used.
//
virtual PlanStageStats* getStats() { return NULL; }
virtual CommonStats* getCommonStats() { return NULL; }
virtual SpecificStats* getSpecificStats() { return NULL; }
// Not used.
virtual std::vector<PlanStage*> getChildren() const;
// Not used.
virtual StageType stageType() const { return STAGE_PIPELINE_PROXY; }
private:
boost::optional<BSONObj> getNextBson();
// Things in the _stash sould be returned before pulling items from _pipeline.
const intrusive_ptr<Pipeline> _pipeline;
vector<BSONObj> _stash;
const bool _includeMetaData;
boost::weak_ptr<PlanExecutor> _childExec;
// Not owned by us.
WorkingSet* _ws;
};
} // namespace mongo
|
