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
|
/**
* Copyright (C) 2020-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/concurrency/exception_util.h"
#include "mongo/db/record_id.h"
#include "mongo/db/repl/oplog.h"
#include "mongo/db/storage/write_unit_of_work.h"
#include "mongo/util/uuid.h"
namespace mongo {
namespace catalog {
/**
* Indicates whether the data drop (the data table) should occur immediately or be two-phased, which
* delays data removal to support older PIT reads or rollback.
*/
enum class DataRemoval {
kImmediate,
kTwoPhase,
};
/**
* Performs two-phase index drop.
*
* Passthrough to DurableCatalog::removeIndex to execute the first phase of drop by removing the
* index catalog entry, then registers an onCommit hook to schedule the second phase of drop to
* delete the index data. The 'dataRemoval' field can be used to specify whether the second phase of
* drop, table data deletion, should run immediately or delayed: immediate deletion should only be
* used for incomplete indexes, where the index build is the only accessor and the data will not be
* needed for earlier points in time.
*
* Uses IndexCatalogEntry::getSharedIdent() shared_ptr to ensure that the second phase of drop (data
* table drop) will not execute until no users of the index (shared owners) remain.
* IndexCatalogEntry::getSharedIdent() is allowed to be a nullptr, in which case the caller
* guarantees that there are no remaining users of the index. This handles situations wherein there
* is no in-memory state available for an index, such as during repair.
*/
void removeIndex(OperationContext* opCtx,
StringData indexName,
Collection* collection,
std::shared_ptr<IndexCatalogEntry> entry,
DataRemoval dataRemoval = DataRemoval::kTwoPhase);
/**
* Performs two-phase collection drop.
*
* Passthrough to DurableCatalog::dropCollection to execute the first phase of drop by removing the
* collection entry, then registers and onCommit hook to schedule the second phase of drop to delete
* the collection data.
*
* Uses 'ident' shared_ptr to ensure that the second phase of drop (data table drop) will not
* execute until no users of the collection record store (shared owners) remain. 'ident' is not
* allowed to be nullptr.
*/
Status dropCollection(OperationContext* opCtx,
const NamespaceString& nss,
RecordId collectionCatalogId,
std::shared_ptr<Ident> ident);
} // namespace catalog
namespace storage_helpers {
/**
* Inserts the batch of documents 'docs' using the provided callable object 'insertFn'.
*
* 'insertFnType' type should be Callable and have the following call signature:
* Status insertFn(OperationContext* opCtx,
* std::vector<InsertStatement>::const_iterator begin,
* std::vector<InsertStatement>::const_iterator end);
*
* where 'begin' (inclusive) and 'end' (exclusive) are the iterators for the range of documents
* 'docs'.
*
* The function first attempts to insert documents as one batch. If the insertion fails, then it
* falls back to inserting documents one at a time. The insertion is retried in case of write
* conflicts.
*/
template <typename insertFnType>
Status insertBatchAndHandleRetry(OperationContext* opCtx,
const NamespaceStringOrUUID& nsOrUUID,
const std::vector<InsertStatement>& docs,
insertFnType&& insertFn) {
if (docs.size() > 1U) {
try {
if (insertFn(opCtx, docs.cbegin(), docs.cend()).isOK()) {
return Status::OK();
}
} catch (...) {
// Ignore this failure and behave as-if we never tried to do the combined batch insert.
// The loop below will handle reporting any non-transient errors.
}
}
// Try to insert the batch one-at-a-time because the batch failed all-at-once inserting.
for (auto it = docs.cbegin(); it != docs.cend(); ++it) {
auto status = writeConflictRetry(opCtx, "batchInsertDocuments", nsOrUUID, [&] {
auto status = insertFn(opCtx, it, it + 1);
if (!status.isOK()) {
return status;
}
return Status::OK();
});
if (!status.isOK()) {
return status;
}
}
return Status::OK();
}
} // namespace storage_helpers
} // namespace mongo
|
