summaryrefslogtreecommitdiff
path: root/src/mongo/db/index/btree_based_builder.h
blob: 443f07f76d647b6c6e7233ab6bc7fcf4306e975e (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
/**
*    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 <set>

#include "mongo/db/jsobj.h"
#include "mongo/db/pdfile.h"

namespace IndexUpdateTests {
    class AddKeysToPhaseOne;
    class InterruptAddKeysToPhaseOne;
    class DoDropDups;
    class InterruptDoDropDups;
}

namespace mongo {

    class BSONObjExternalSorter;
    class ExternalSortComparison;
    class IndexDetails;
    class NamespaceDetails;
    class ProgressMeter;
    class ProgressMeterHolder;
    struct SortPhaseOne;

    class BtreeBasedBuilder {
    public:
        /**
         * Want to build an index?  Call this.  Throws DBException.
         */
        static uint64_t fastBuildIndex(const char* ns, NamespaceDetails* d, IndexDetails& idx,
                                       bool mayInterrupt, int idxNo);
        static DiskLoc makeEmptyIndex(const IndexDetails& idx);
        static ExternalSortComparison* getComparison(int version, const BSONObj& keyPattern);

    private:
        friend class IndexUpdateTests::AddKeysToPhaseOne;
        friend class IndexUpdateTests::InterruptAddKeysToPhaseOne;
        friend class IndexUpdateTests::DoDropDups;
        friend class IndexUpdateTests::InterruptDoDropDups;


        static void addKeysToPhaseOne(NamespaceDetails* d, const char* ns, const IndexDetails& idx,
                                      const BSONObj& order, SortPhaseOne* phaseOne,
                                      int64_t nrecords, ProgressMeter* progressMeter,
                                      bool mayInterrupt,
                                      int idxNo);

        static void doDropDups(const char* ns, NamespaceDetails* d, const set<DiskLoc>& dupsToDrop,
                               bool mayInterrupt );
    };

    // Exposed for testing purposes.
    template< class V >
    void buildBottomUpPhases2And3( bool dupsAllowed,
                                   IndexDetails& idx,
                                   BSONObjExternalSorter& sorter,
                                   bool dropDups,
                                   set<DiskLoc>& dupsToDrop,
                                   CurOp* op,
                                   SortPhaseOne* phase1,
                                   ProgressMeterHolder& pm,
                                   Timer& t,
                                   bool mayInterrupt );

}  // namespace mongo