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
|
/**
* Copyright (C) 2021-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 <boost/optional/optional.hpp>
#include "mongo/db/namespace_string.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/pipeline/change_stream_preimage_gen.h"
#include "mongo/db/tenant_id.h"
#include "mongo/util/background.h"
namespace mongo {
namespace change_stream_pre_image_helpers {
/**
* Specifies attributes that determines if the pre-image has been expired or not.
*/
struct PreImageAttributes {
mongo::UUID collectionUUID;
Timestamp ts;
Date_t operationTime;
/**
* Determines if the pre-image is considered expired based on the expiration parameter being
* set.
*/
bool isExpiredPreImage(const boost::optional<Date_t>& preImageExpirationTime,
const Timestamp& earliestOplogEntryTimestamp);
};
boost::optional<Date_t> getPreImageExpirationTime(OperationContext* opCtx, Date_t currentTime);
} // namespace change_stream_pre_image_helpers
/**
* Manages the lifecycle of the change stream pre-images collection(s). Also is responsible for
* inserting the pre-images into the pre-images collection.
*/
class ChangeStreamPreImagesCollectionManager {
public:
/**
* Creates the pre-images collection, clustered by the primary key '_id'. The collection is
* created for the specific tenant if the 'tenantId' is specified.
*/
static void createPreImagesCollection(OperationContext* opCtx,
boost::optional<TenantId> tenantId);
/**
* Drops the pre-images collection. The collection is dropped for the specific tenant if
* the 'tenantId' is specified.
*/
static void dropPreImagesCollection(OperationContext* opCtx,
boost::optional<TenantId> tenantId);
/**
* Inserts the document into the pre-images collection. The document is inserted into the
* tenant's pre-images collection if the 'tenantId' is specified.
*/
static void insertPreImage(OperationContext* opCtx,
boost::optional<TenantId> tenantId,
const ChangeStreamPreImage& preImage);
/**
* Scans the system pre-images collection and deletes the expired pre-images from it.
*/
static void performExpiredChangeStreamPreImagesRemovalPass(Client* client);
};
} // namespace mongo
|
