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
|
/**
* 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 <boost/scoped_ptr.hpp>
#include <string>
#include "mongo/base/status.h"
#include "mongo/db/query/runner.h"
namespace mongo {
class BSONObj;
class CanonicalQuery;
class DiskLoc;
class PlanExecutor;
class PlanStage;
struct QuerySolution;
class TypeExplain;
class WorkingSet;
/**
* This is a runner that was requested by an internal client of the query system, as opposed to
* runners that are built in response to a query entering the system. It is only used by
* internal clients of the query systems (e.g., chunk migration, index building, commands that
* traverse data such as md5, ... )
*
* The salient feature of this Runner is that it does not interact with the cache at all.
*/
class InternalRunner : public Runner {
public:
/** Takes ownership of all arguments. */
InternalRunner(const string& ns, PlanStage* root, WorkingSet* ws);
virtual ~InternalRunner();
Runner::RunnerState getNext(BSONObj* objOut, DiskLoc* dlOut);
virtual bool isEOF();
virtual void saveState();
virtual bool restoreState();
virtual const std::string& ns();
virtual void invalidate(const DiskLoc& dl);
virtual void setYieldPolicy(Runner::YieldPolicy policy);
virtual void kill();
/**
* Returns OK, allocating and filling in '*explain' with details of the plan used by
* this runner. Caller takes ownership of '*explain'. Otherwise, return a status
* describing the error.
*
* Strictly speaking, an InternalRunner's explain is never exposed, simply because an
* InternalRunner itself is not exposed. But we implement the explain here anyway so
* to help in debugging situations.
*/
virtual Status getExplainPlan(TypeExplain** explain) const;
private:
std::string _ns;
boost::scoped_ptr<PlanExecutor> _exec;
Runner::YieldPolicy _policy;
};
} // namespace mongo
|
