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
|
/**
* 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 "mongo/db/exec/plan_stage.h"
#include "mongo/scripting/engine.h"
namespace mongo {
class Collection;
/**
* A description of a request for a group operation. Copyable.
*/
struct GroupRequest {
// Namespace to operate on (e.g. "foo.bar").
std::string ns;
// A predicate describing the set of documents to group.
BSONObj query;
// The field(s) to group by. Alternative to "keyFunctionCode". Empty if "keyFunctionCode"
// is being used instead.
BSONObj keyPattern;
// A Javascript function that maps a document to a key object. Alternative to "keyPattern".
// Empty is "keyPattern" is being used instead.
std::string keyFunctionCode;
// A Javascript function that takes a (input document, group result) pair and
// updates the group result document.
std::string reduceCode;
// Scope for the reduce function. Optional.
BSONObj reduceScope;
// The initial value for the group result.
BSONObj initial;
// A Javascript function that "finalizes" a group result. Optional.
std::string finalize;
// Whether this is an explain of a group.
bool explain;
};
/**
* Stage used by the group command. Consumes input documents from its child stage (returning
* NEED_TIME once for each document produced by the child), returns ADVANCED exactly once with
* the entire group result, then returns EOF.
*
* Only created through the getExecutorGroup path.
*/
class GroupStage: public PlanStage {
MONGO_DISALLOW_COPYING(GroupStage);
public:
GroupStage(OperationContext* txn,
const GroupRequest& request,
WorkingSet* workingSet,
PlanStage* child);
virtual ~GroupStage() { }
virtual StageState work(WorkingSetID* out);
virtual bool isEOF();
virtual void saveState();
virtual void restoreState(OperationContext* opCtx);
virtual void invalidate(OperationContext* txn, const DiskLoc& dl, InvalidationType type);
virtual std::vector<PlanStage*> getChildren() const;
virtual StageType stageType() const { return STAGE_GROUP; }
virtual PlanStageStats* getStats();
virtual const CommonStats* getCommonStats();
virtual const SpecificStats* getSpecificStats();
static const char* kStageType;
private:
/**
* Keeps track of what this group is currently doing so that it can do the right thing on
* the next call to work().
*/
enum GroupState {
// Need to initialize the underlying Javascript machinery.
GroupState_Initializing,
// Retrieving the next document from the child stage and processing it.
GroupState_ReadingFromChild,
// Results have been returned.
GroupState_Done
};
// Initializes _scope, _reduceFunction and _keyFunction using the global scripting engine.
void initGroupScripting();
// Updates _groupMap and _scope to account for the group key associated with this object.
// Returns an error status if an error occurred, else Status::OK().
Status processObject(const BSONObj& obj);
// Finalize the results for this group operation. Returns an owned BSONObj with the results
// array.
BSONObj finalizeResults();
// Transactional context for read locks. Not owned by us.
OperationContext* _txn;
GroupRequest _request;
// The WorkingSet we annotate with results. Not owned by us.
WorkingSet* _ws;
CommonStats _commonStats;
GroupStats _specificStats;
scoped_ptr<PlanStage> _child;
// Current state for this stage.
GroupState _groupState;
// The Scope object that all script operations for this group stage will use. Initialized
// by initGroupScripting(). Owned here.
std::auto_ptr<Scope> _scope;
// The reduce function for the group operation. Initialized by initGroupScripting(). Owned
// by _scope.
ScriptingFunction _reduceFunction;
// The key function for the group operation if one was provided by the user, else 0.
// Initialized by initGroupScripting(). Owned by _scope.
ScriptingFunction _keyFunction;
// Map from group key => group index. The group index is used to index into "$arr", a
// variable owned by _scope which contains the group data for this key.
std::map<BSONObj, int, BSONObjCmp> _groupMap;
};
} // namespace mongo
|
