summaryrefslogtreecommitdiff
path: root/src/mongo/db/exec/limit.h
blob: 87cced9c662877d0bcbd604206eba7d4d2fcae60 (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
/**
 *    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/>.
 */

#pragma once

#include "mongo/db/diskloc.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/exec/plan_stage.h"

namespace mongo {

    /**
     * This stage implements limit functionality.  It only returns 'limit' results before EOF.
     *
     * Sort has a baked-in limit, as it can optimize the sort if it has a limit.
     *
     * Preconditions: None.
     */
    class LimitStage : public PlanStage {
    public:
        LimitStage(int limit, WorkingSet* ws, PlanStage* child);
        virtual ~LimitStage();

        virtual bool isEOF();
        virtual StageState work(WorkingSetID* out);

        virtual void prepareToYield();
        virtual void recoverFromYield();
        virtual void invalidate(const DiskLoc& dl);

        virtual PlanStageStats* getStats();

    private:
        WorkingSet* _ws;
        scoped_ptr<PlanStage> _child;

        // We only return this many results.
        int _numToReturn;

        // Stats
        CommonStats _commonStats;
    };

}  // namespace mongo