summaryrefslogtreecommitdiff
path: root/src/mongo/db/index/btree_access_method.h
blob: 8d7dcec266a59d223533ec54e12a119c0fb46355 (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
/**
*    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 <boost/scoped_ptr.hpp>

#include "mongo/base/status.h"
#include "mongo/db/btree.h"
#include "mongo/db/index/index_access_method.h"
#include "mongo/db/index/btree_key_generator.h"
#include "mongo/db/index/btree_access_method_internal.h"
#include "mongo/db/jsobj.h"

namespace mongo {

    class BtreeInterface;
    class IndexCursor;
    class IndexDescriptor;

    /**
     * The IndexAccessMethod for a Btree index.
     * Any index created with {field: 1} or {field: -1} uses this.
     */
    class BtreeAccessMethod : public BtreeBasedAccessMethod {
    public:
        // Every Btree-based index needs these.  We put them in the BtreeBasedAccessMethod
        // superclass and subclasses (like this) can use them.
        using BtreeBasedAccessMethod::_descriptor;
        using BtreeBasedAccessMethod::_interface;
        using BtreeBasedAccessMethod::_ordering;

        BtreeAccessMethod(IndexDescriptor* descriptor);
        virtual ~BtreeAccessMethod() { }

        virtual Status newCursor(IndexCursor** out);

    private:
        virtual void getKeys(const BSONObj& obj, BSONObjSet* keys);

        // Our keys differ for V0 and V1.
        scoped_ptr<BtreeKeyGenerator> _keyGenerator;
    };

}  // namespace mongo