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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/**
* Copyright (C) 2022-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/collection_catalog.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/repl/storage_interface.h"
#include "mongo/db/service_context.h"
namespace mongo {
/**
* Metadata associated with a particular change collection that is used by the purging job.
*/
struct ChangeCollectionPurgingJobMetadata {
// The wall time in milliseconds of the first document of the change collection.
long long firstDocWallTimeMillis;
// Current maximum record id present in the change collection.
RecordIdBound maxRecordIdBound;
};
/**
* Manages the creation, deletion and insertion lifecycle of the change collection.
*/
class ChangeStreamChangeCollectionManager {
public:
/**
* Statistics of the change collection purging job.
*/
struct PurgingJobStats {
/**
* Total number of deletion passes completed by the purging job.
*/
AtomicWord<long long> totalPass;
/**
* Cumulative number of change collections documents deleted by the purging job.
*/
AtomicWord<long long> docsDeleted;
/**
* Cumulative size in bytes of all deleted documents from all change collections by the
* purging job.
*/
AtomicWord<long long> bytesDeleted;
/**
* Cumulative number of change collections scanned by the purging job.
*/
AtomicWord<long long> scannedCollections;
/**
* Cumulative number of milliseconds elapsed since the first pass by the purging job.
*/
AtomicWord<long long> timeElapsedMillis;
/**
* Maximum wall time in milliseconds from the first document of each change collection.
*/
AtomicWord<long long> maxStartWallTimeMillis;
/**
* Serializes the purging job statistics to the BSON object.
*/
BSONObj toBSON() const;
};
explicit ChangeStreamChangeCollectionManager(ServiceContext* service) {}
~ChangeStreamChangeCollectionManager() = default;
/**
* Creates an instance of the class using the service-context.
*/
static void create(ServiceContext* service);
/**
* Gets the instance of the class using the service context.
*/
static ChangeStreamChangeCollectionManager& get(ServiceContext* service);
/**
* Gets the instance of the class using the operation context.
*/
static ChangeStreamChangeCollectionManager& get(OperationContext* opCtx);
/**
* Creates a change collection for the specified tenant, if it doesn't exist.
*/
void createChangeCollection(OperationContext* opCtx, const TenantId& tenantId);
/**
* Deletes the change collection for the specified tenant, if it already exist.
*/
void dropChangeCollection(OperationContext* opCtx, const TenantId& tenantId);
/**
* Inserts documents to change collections. The parameter 'oplogRecords' is a vector of oplog
* records and the parameter 'oplogTimestamps' is a vector for respective timestamp for each
* oplog record.
*
* The method fetches the tenant-id from the oplog entry, performs necessary modification to the
* document and then write to the tenant's change collection at the specified oplog timestamp.
*
* Failure in insertion to any change collection will result in a fatal exception and will bring
* down the node.
*/
void insertDocumentsToChangeCollection(OperationContext* opCtx,
const std::vector<Record>& oplogRecords,
const std::vector<Timestamp>& oplogTimestamps);
/**
* Performs a range inserts on respective change collections using the oplog entries as
* specified by 'beginOplogEntries' and 'endOplogEntries'.
*
* Bails out if a failure is encountered in inserting documents to a particular change
* collection.
*/
Status insertDocumentsToChangeCollection(
OperationContext* opCtx,
std::vector<InsertStatement>::const_iterator beginOplogEntries,
std::vector<InsertStatement>::const_iterator endOplogEntries,
bool isGlobalIXLockAcquired,
OpDebug* opDebug);
PurgingJobStats& getPurgingJobStats() {
return _purgingJobStats;
}
/**
* Scans the provided change collection and returns its metadata that will be used by the
* purging job to perform deletion on it. The method returns 'boost::none' if the collection is
* empty.
*/
static boost::optional<ChangeCollectionPurgingJobMetadata>
getChangeCollectionPurgingJobMetadata(OperationContext* opCtx,
const CollectionPtr* changeCollection);
/** Removes documents from a change collection whose wall time is less than the
* 'expirationTime'. Returns the number of documents deleted. The 'maxRecordIdBound' is the
* maximum record id bound that will not be included in the collection scan.
*/
static size_t removeExpiredChangeCollectionsDocuments(OperationContext* opCtx,
const CollectionPtr* changeCollection,
RecordIdBound maxRecordIdBound,
Date_t expirationTime);
private:
// Change collections purging job stats.
PurgingJobStats _purgingJobStats;
};
} // namespace mongo
|
