/**
* 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 .
*
* 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
#include
#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;
/**
* SingleSolutionRunner runs a plan that was the only possible solution to a query. It exists
* only to dump stats into the cache after running.
*/
class SingleSolutionRunner : public Runner {
public:
/** Takes ownership of all the arguments except collection */
SingleSolutionRunner(const Collection* collection,
CanonicalQuery* canonicalQuery, QuerySolution* soln,
PlanStage* root, WorkingSet* ws);
virtual ~SingleSolutionRunner();
Runner::RunnerState getNext(BSONObj* objOut, DiskLoc* dlOut);
virtual bool isEOF();
virtual void saveState();
virtual bool restoreState();
virtual void setYieldPolicy(Runner::YieldPolicy policy);
virtual void invalidate(const DiskLoc& dl, InvalidationType type);
virtual const std::string& ns();
virtual void kill();
virtual const Collection* collection() { return _collection; }
/**
* Returns OK, allocating and filling in '*explain' and '*staticInfo' with the details
* of the plan used by this runner. Caller takes ownership of '*explain' and
* '*staticInfo'. Otherwise, return a status describing the error.
*/
virtual Status getInfo(TypeExplain** explain,
PlanInfo** planInfo) const;
private:
const Collection* _collection;
boost::scoped_ptr _canonicalQuery;
boost::scoped_ptr _solution;
boost::scoped_ptr _exec;
};
} // namespace mongo