summaryrefslogtreecommitdiff
path: root/src/mongo/db/exec/count.h
blob: 60873374cdc954cd9440119351970b382ff5ced0 (plain)
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
/**
 *    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 <boost/scoped_ptr.hpp>

#include "mongo/db/exec/plan_stage.h"
#include "mongo/db/diskloc.h"
#include "mongo/db/index/btree_index_cursor.h"
#include "mongo/db/index/index_access_method.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/matcher/expression.h"
#include "mongo/db/operation_context.h"
#include "mongo/platform/unordered_set.h"

namespace mongo {

    class IndexAccessMethod;
    class IndexDescriptor;
    class WorkingSet;

    struct CountParams {
        CountParams() : descriptor(NULL) { }

        // What index are we traversing?
        const IndexDescriptor* descriptor;

        BSONObj startKey;
        bool startKeyInclusive;

        BSONObj endKey;
        bool endKeyInclusive;
    };

    /**
     * Used by the count command.  Scans an index from a start key to an end key.  Does not create
     * any WorkingSetMember(s) for any of the data, instead returning ADVANCED to indicate to the
     * caller that another result should be counted.
     *
     * Only created through the getExecutorCount path, as count is the only operation that doesn't
     * care about its data.
     */
    class Count : public PlanStage {
    public:
        Count(OperationContext* txn, const CountParams& params, WorkingSet* workingSet);
        virtual ~Count() { }

        virtual StageState work(WorkingSetID* out);
        virtual bool isEOF();
        virtual void prepareToYield();
        virtual void recoverFromYield(OperationContext* opCtx);
        virtual void invalidate(const DiskLoc& dl, InvalidationType type);

        virtual std::vector<PlanStage*> getChildren() const;

        virtual StageType stageType() const { return STAGE_COUNT; }

        virtual PlanStageStats* getStats();

        virtual const CommonStats* getCommonStats();

        virtual const SpecificStats* getSpecificStats();

        static const char* kStageType;

    private:
        /**
         * Initialize the underlying IndexCursor
         */
        void initIndexCursor();

        /**
         * See if we've hit the end yet.
         */
        void checkEnd();

        // transactional context for read locks. Not owned by us
        OperationContext* _txn;

        // The WorkingSet we annotate with results.  Not owned by us.
        WorkingSet* _workingSet;

        // Index access.  Both pointers below are owned by Collection -> IndexCatalog.
        const IndexDescriptor* _descriptor;
        const IndexAccessMethod* _iam;

        // Our start cursor is _btreeCursor.
        boost::scoped_ptr<BtreeIndexCursor> _btreeCursor;

        // Our end marker.
        boost::scoped_ptr<BtreeIndexCursor> _endCursor;

        // Could our index have duplicates?  If so, we use _returned to dedup.
        unordered_set<DiskLoc, DiskLoc::Hasher> _returned;

        CountParams _params;

        bool _hitEnd;

        bool _shouldDedup;

        CommonStats _commonStats;
        CountStats _specificStats;
    };

}  // namespace mongo