summaryrefslogtreecommitdiff
path: root/src/mongo/db/exec/collection_scan_common.h
blob: cdb42e59fd01eec92af32003bd1d116491b885cd (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
/**
 *    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"

namespace mongo {

    struct CollectionScanParams {
        enum Direction {
            FORWARD,
            BACKWARD,
        };

        CollectionScanParams() : start(DiskLoc()),
                                 direction(FORWARD),
                                 tailable(false) { }

        // What collection?
        string ns;

        // isNull by default.  If you specify any value for this, you're responsible for the DiskLoc
        // not being invalidated before the first call to work(...).
        DiskLoc start;

        Direction direction;

        // Do we want the scan to be 'tailable'?  Only meaningful if the collection is capped.
        bool tailable;
    };

}  // namespace mongo