mongo::QueryOp Class Reference

#include <queryoptimizer.h>

Inheritance diagram for mongo::QueryOp:
Inheritance graph
[legend]

List of all members.

Public Member Functions

bool complete () const
QueryOpcreateChild ()
bool error () const
ExceptionInfo exception () const
void init ()
shared_ptr< CoveredIndexMatchermatcher () const
virtual bool mayRecordPlan () const =0
virtual void next ()=0
virtual long long nscanned ()=0
virtual bool prepareToYield ()
const QueryPlanqp () const
 QueryOp (const QueryOp &other)
 QueryOp ()
virtual void recoverFromYield ()
void setException (const DBException &e)
void setQueryPlan (const QueryPlan *qp)
bool stopRequested () const
virtual ~QueryOp ()

Protected Member Functions

virtual QueryOp_createChild () const =0
virtual void _init ()=0
virtual bool alwaysUseRecord () const
void setComplete ()
void setStop ()

Private Attributes

bool _complete
bool _error
ExceptionInfo _exception
shared_ptr< CoveredIndexMatcher_matcher
shared_ptr< CoveredIndexMatcher_oldMatcher
shared_ptr< FieldRangeVector_orConstraint
const QueryPlan_qp
bool _stopRequested

Detailed Description

Definition at line 98 of file queryoptimizer.h.


Constructor & Destructor Documentation

mongo::QueryOp::QueryOp (  )  [inline]

Definition at line 100 of file queryoptimizer.h.

mongo::QueryOp::QueryOp ( const QueryOp other  )  [inline]

Definition at line 103 of file queryoptimizer.h.

virtual mongo::QueryOp::~QueryOp (  )  [inline, virtual]

Definition at line 107 of file queryoptimizer.h.


Member Function Documentation

virtual QueryOp* mongo::QueryOp::_createChild (  )  const [protected, pure virtual]

Implemented in mongo::MultiCursor::NoOp.

virtual void mongo::QueryOp::_init (  )  [protected, pure virtual]

Implemented in mongo::MultiCursor::NoOp.

virtual bool mongo::QueryOp::alwaysUseRecord (  )  const [inline, protected, virtual]

Definition at line 166 of file queryoptimizer.h.

bool mongo::QueryOp::complete (  )  const [inline]

Definition at line 143 of file queryoptimizer.h.

QueryOp* mongo::QueryOp::createChild (  )  [inline]
Returns:
a copy of the inheriting class, which will be run with its own query plan. If multiple plan sets are required for an $or query, the QueryOp of the winning plan from a given set will be cloned to generate QueryOps for the subsequent plan set. This function should only be called after the query op has completed executing.

Definition at line 134 of file queryoptimizer.h.

bool mongo::QueryOp::error (  )  const [inline]

Definition at line 144 of file queryoptimizer.h.

ExceptionInfo mongo::QueryOp::exception (  )  const [inline]

Definition at line 146 of file queryoptimizer.h.

void mongo::QueryOp::init (  )  [inline]

these gets called after a query plan is set

Definition at line 110 of file queryoptimizer.h.

shared_ptr< CoveredIndexMatcher > mongo::QueryOp::matcher (  )  const [inline]

Definition at line 154 of file queryoptimizer.h.

virtual bool mongo::QueryOp::mayRecordPlan (  )  const [pure virtual]

Implemented in mongo::MultiCursor::NoOp.

virtual void mongo::QueryOp::next (  )  [pure virtual]

Implemented in mongo::MultiCursor::NoOp.

virtual long long mongo::QueryOp::nscanned (  )  [pure virtual]

Implemented in mongo::MultiCursor::NoOp.

virtual bool mongo::QueryOp::prepareToYield (  )  [inline, virtual]

Definition at line 123 of file queryoptimizer.h.

const QueryPlan& mongo::QueryOp::qp (  )  const [inline]

Definition at line 147 of file queryoptimizer.h.

virtual void mongo::QueryOp::recoverFromYield (  )  [inline, virtual]

Definition at line 124 of file queryoptimizer.h.

void mongo::QueryOp::setComplete (  )  [inline, protected]

Definition at line 156 of file queryoptimizer.h.

void mongo::QueryOp::setException ( const DBException e  )  [inline]

Definition at line 150 of file queryoptimizer.h.

void mongo::QueryOp::setQueryPlan ( const QueryPlan qp  )  [inline]

Definition at line 149 of file queryoptimizer.h.

void mongo::QueryOp::setStop (  )  [inline, protected]

Definition at line 160 of file queryoptimizer.h.

bool mongo::QueryOp::stopRequested (  )  const [inline]

Definition at line 145 of file queryoptimizer.h.


Member Data Documentation

bool mongo::QueryOp::_complete [private]

Definition at line 169 of file queryoptimizer.h.

bool mongo::QueryOp::_error [private]

Definition at line 173 of file queryoptimizer.h.

Definition at line 171 of file queryoptimizer.h.

Definition at line 174 of file queryoptimizer.h.

Definition at line 175 of file queryoptimizer.h.

Definition at line 176 of file queryoptimizer.h.

const QueryPlan* mongo::QueryOp::_qp [private]

Definition at line 172 of file queryoptimizer.h.

Definition at line 170 of file queryoptimizer.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


mongodb
Author(s): Nate Koenig
autogenerated on Fri Jan 11 12:15:57 2013