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
|
/**
* 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/catalog/index_catalog_entry.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/storage/temporary_record_store.h"
#include "mongo/platform/atomic_word.h"
namespace mongo {
class IndexCatalogEntry;
/**
* Records keys that have violated index key constraints. The keys are backed by a temporary table
* that is created and destroyed by this tracker.
*/
class SkippedRecordTracker {
SkippedRecordTracker(const SkippedRecordTracker&) = delete;
public:
enum class RetrySkippedRecordMode {
// Retry key generation but do not update the index or remove the records from the tracker.
kKeyGeneration,
// Retry key generation and update the index with the new keys, removing the retried records
// from the tracker.
kKeyGenerationAndInsertion
};
explicit SkippedRecordTracker(const IndexCatalogEntry* indexCatalogEntry);
SkippedRecordTracker(OperationContext* opCtx,
const IndexCatalogEntry* indexCatalogEntry,
boost::optional<StringData> ident);
/**
* Records a RecordId that was unable to be indexed due to a key generation error. At the
* conclusion of the build, the key generation and insertion into the index should be attempted
* again by calling 'retrySkippedRecords'.
*/
void record(OperationContext* opCtx, const RecordId& recordId);
/**
* Keeps the temporary table managed by this tracker. This is a no-op when the table is empty or
* has not yet been initialized.
*/
void keepTemporaryTable();
/**
* Returns true if the temporary table is empty.
*/
bool areAllRecordsApplied(OperationContext* opCtx) const;
/**
* By default, attempts to generate keys for each skipped record and insert into the index.
* Returns OK if all records were either indexed or no longer exist.
*
* The behaviour can be modified by specifying a RetrySkippedRecordMode.
*/
Status retrySkippedRecords(
OperationContext* opCtx,
const CollectionPtr& collection,
RetrySkippedRecordMode mode = RetrySkippedRecordMode::kKeyGenerationAndInsertion);
boost::optional<std::string> getTableIdent() const {
return _skippedRecordsTable ? boost::make_optional(_skippedRecordsTable->rs()->getIdent())
: boost::none;
}
boost::optional<MultikeyPaths> getMultikeyPaths() const {
return _multikeyPaths;
}
private:
const IndexCatalogEntry* _indexCatalogEntry;
// This temporary record store is owned by the duplicate key tracker.
std::unique_ptr<TemporaryRecordStore> _skippedRecordsTable;
AtomicWord<std::uint32_t> _skippedRecordCounter{0};
boost::optional<MultikeyPaths> _multikeyPaths;
};
} // namespace mongo
|
