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
|
/**
* Copyright (C) 2019-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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 "mongo/db/index/index_build_interceptor.h"
namespace mongo {
/**
* Interface for building a single index from an index spec and persisting its state to disk.
*/
class IndexBuildBlock {
IndexBuildBlock(const IndexBuildBlock&) = delete;
IndexBuildBlock& operator=(const IndexBuildBlock&) = delete;
public:
IndexBuildBlock(const NamespaceString& nss,
const BSONObj& spec,
IndexBuildMethod method,
// The index build UUID is only required for persisting to the catalog.
boost::optional<UUID> indexBuildUUID);
~IndexBuildBlock();
/**
* Prevent any temporary tables from being dropped when this IndexBuildBlock is destructed.
*/
void keepTemporaryTables();
/**
* Initializes a new entry for the index in the IndexCatalog.
*
* On success, holds pointer to newly created IndexCatalogEntry that can be accessed using
* getEntry(). IndexCatalog will still own the entry.
*
* Must be called from within a `WriteUnitOfWork`
*/
Status init(OperationContext* opCtx, Collection* collection, bool forRecovery);
/**
* Makes sure that an entry for the index was created at startup in the IndexCatalog. Returns
* an error status if we are resuming from the bulk load phase and the index ident was unable
* to be dropped or recreated in the storage engine.
*/
Status initForResume(OperationContext* opCtx,
Collection* collection,
const IndexStateInfo& stateInfo,
IndexBuildPhaseEnum phase);
/**
* Marks the state of the index as 'ready' and commits the index to disk.
*
* Must be called from within a `WriteUnitOfWork`
*/
void success(OperationContext* opCtx, Collection* collection);
/**
* Aborts the index build and removes any on-disk state where applicable.
*
* Must be called from within a `WriteUnitOfWork`
*/
void fail(OperationContext* opCtx, Collection* collection);
/**
* Returns the IndexCatalogEntry that was created in init().
*
* This entry is owned by the IndexCatalog.
*/
const IndexCatalogEntry* getEntry(OperationContext* opCtx,
const CollectionPtr& collection) const;
IndexCatalogEntry* getEntry(OperationContext* opCtx, Collection* collection);
/**
* Returns the name of the index managed by this index builder.
*/
const std::string& getIndexName() const {
return _indexName;
}
/**
* Returns the index spec used to build this index.
*/
const BSONObj& getSpec() const {
return _spec;
}
/**
* Returns a memory pool for creating temporary objects for this index build.
*/
SharedBufferFragmentBuilder& getPooledBuilder() {
return _pooledBuilder;
}
private:
void _completeInit(OperationContext* opCtx, Collection* collection);
const NamespaceString _nss;
BSONObj _spec;
IndexBuildMethod _method;
boost::optional<UUID> _buildUUID;
std::string _indexName;
std::string _indexNamespace;
std::unique_ptr<IndexBuildInterceptor> _indexBuildInterceptor;
SharedBufferFragmentBuilder _pooledBuilder;
};
} // namespace mongo
|
