summaryrefslogtreecommitdiff
path: root/src/mongo/db/index/btree_based_access_method.h
blob: cee969887109f8bea7474b76ca077a228ccc282e (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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/**
*    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 <vector>

#include "mongo/base/disallow_copying.h"
#include "mongo/db/diskloc.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/index/index_access_method.h"
#include "mongo/db/index/index_cursor.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/structure/btree/btree_interface.h"

namespace mongo {

    class ExternalSortComparison;

    /**
     * Any access method that is Btree based subclasses from this.
     *
     * Subclassers must:
     * 1. Call the constructor for this class from their constructors, and
     * 2. override getKeys.
     *
     * XXX: Should really think of the sub-class as providing an expression mapping of the input,
     * don't need so many AMs, just really precomputing some data and mapping doc for getKeys(?).
     * See SERVER-12397 for tracking.
     */
    class BtreeBasedAccessMethod : public IndexAccessMethod {
        MONGO_DISALLOW_COPYING( BtreeBasedAccessMethod );
    public:
        BtreeBasedAccessMethod( IndexCatalogEntry* btreeState );

        virtual ~BtreeBasedAccessMethod() { }

        virtual Status insert(OperationContext* txn,
                              const BSONObj& obj,
                              const DiskLoc& loc,
                              const InsertDeleteOptions& options,
                              int64_t* numInserted);

        virtual Status remove(OperationContext* txn,
                              const BSONObj& obj,
                              const DiskLoc& loc,
                              const InsertDeleteOptions& options,
                              int64_t* numDeleted);

        virtual Status validateUpdate(const BSONObj& from,
                                      const BSONObj& to,
                                      const DiskLoc& loc,
                                      const InsertDeleteOptions& options,
                                      UpdateTicket* ticket);

        virtual Status update(OperationContext* txn,
                              const UpdateTicket& ticket,
                              int64_t* numUpdated);

        virtual Status newCursor(IndexCursor **out) const;

        virtual Status initializeAsEmpty(OperationContext* txn);

        virtual IndexAccessMethod* initiateBulk(OperationContext* txn) ;

        virtual Status commitBulk( IndexAccessMethod* bulk,
                                   bool mayInterrupt,
                                   std::set<DiskLoc>* dups );

        virtual Status touch(const BSONObj& obj);

        virtual Status touch(OperationContext* txn) const;

        virtual Status validate(int64_t* numKeys);

        // XXX: consider migrating callers to use IndexCursor instead
        virtual DiskLoc findSingle( const BSONObj& key ) const;

    protected:
        // Friends who need getKeys.
        friend class BtreeBasedBulkAccessMethod;

        // See below for body.
        class BtreeBasedPrivateUpdateData;

        virtual void getKeys(const BSONObj &obj, BSONObjSet *keys) = 0;

        IndexCatalogEntry* _btreeState; // owned by IndexCatalogEntry
        const IndexDescriptor* _descriptor;

        /**
         * The collection is needed for resolving record locations to actual objects.
         */
        const Collection* collection() const {
            return _btreeState->collection();
        }

    private:
        bool removeOneKey(OperationContext* txn,
                          const BSONObj& key,
                          const DiskLoc& loc);

        scoped_ptr<BtreeInterface> _newInterface;
    };

    /**
     * What data do we need to perform an update?
     */
    class BtreeBasedAccessMethod::BtreeBasedPrivateUpdateData
        : public UpdateTicket::PrivateUpdateData {
    public:
        virtual ~BtreeBasedPrivateUpdateData() { }

        BSONObjSet oldKeys, newKeys;

        // These point into the sets oldKeys and newKeys.
        vector<BSONObj*> removed, added;

        DiskLoc loc;
        bool dupsAllowed;
    };

}  // namespace mongo