summaryrefslogtreecommitdiff
path: root/src/mongo/db/exec/eof.h
diff options
context:
space:
mode:
authorDavid Storch <david.storch@10gen.com>2014-06-11 14:24:20 -0400
committerDavid Storch <david.storch@10gen.com>2014-06-27 09:56:04 -0400
commit1cc6be662ccd83b0341ef1f31f8f4ad30dc69451 (patch)
tree2cdd5f7e473d77685f6f7ca1c6735f75991089a7 /src/mongo/db/exec/eof.h
parenta67bddc57c9b8a8d9d13ac30ebe74f9914b0c6d0 (diff)
downloadmongo-1cc6be662ccd83b0341ef1f31f8f4ad30dc69451.tar.gz
SERVER-14097 SERVER-14098 execution-level explain for .find() and .count()
The explain implementation for .find() and .count() is feature complete. To use the .find() implementation, set the enableNewExplain setParameter to true. Count operations are explained through the new explain command, e.g. db.runCommand({explain: {count: "coll", query: {foo: "bar"}}}).
Diffstat (limited to 'src/mongo/db/exec/eof.h')
-rw-r--r--src/mongo/db/exec/eof.h64
1 files changed, 64 insertions, 0 deletions
diff --git a/src/mongo/db/exec/eof.h b/src/mongo/db/exec/eof.h
new file mode 100644
index 00000000000..cfcddc15b87
--- /dev/null
+++ b/src/mongo/db/exec/eof.h
@@ -0,0 +1,64 @@
+/**
+ * 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 "mongo/db/diskloc.h"
+#include "mongo/db/exec/plan_stage.h"
+
+namespace mongo {
+
+ /**
+ * This stage just returns EOF immediately.
+ */
+ class EOFStage : public PlanStage {
+ public:
+ EOFStage();
+
+ virtual ~EOFStage();
+
+ virtual bool isEOF();
+ virtual StageState work(WorkingSetID* out);
+
+ virtual void prepareToYield();
+ virtual void recoverFromYield();
+ virtual void invalidate(const DiskLoc& dl, InvalidationType type);
+
+ virtual std::vector<PlanStage*> getChildren() const;
+
+ virtual StageType stageType() const { return STAGE_EOF; }
+
+ PlanStageStats* getStats();
+
+ static const char* kStageType;
+
+ private:
+ CommonStats _commonStats;
+ };
+
+} // namespace mongo