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
|
/**
* Copyright (C) 2023-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.h"
#include "mongo/db/pipeline/change_stream_preimage_gen.h"
#include "mongo/db/query/internal_plans.h"
#include "mongo/db/query/record_id_bound.h"
#include "mongo/db/record_id.h"
namespace mongo {
namespace change_stream_pre_image_util {
/**
* Returns pre-images expiry time in milliseconds since the epoch time if configured, boost::none
* otherwise.
*
* Only suitable for a single-tenant enviornment. Otherwise, callers should defer to serverless
* methods which compute expireAfterSeconds according to the tenantId.
*/
boost::optional<Date_t> getPreImageExpirationTime(OperationContext* opCtx, Date_t currentTime);
/**
* TODO SERVER-74981: Investigate whether there is a safer way to extract the Timestamp.
*
* Parses the 'ts' field from the 'ChangeStreamPreImageId' associated with the 'rid'. The 'rid' MUST
be
* generated from a pre-image.
*/
Timestamp getPreImageTimestamp(const RecordId& rid);
RecordId toRecordId(ChangeStreamPreImageId id);
/**
* A given pre-images collection consists of segments of pre-images generated from different UUIDs.
* Returns the absolute min/max RecordIdBounds for the segment of pre-images generated from
* 'nsUUID'.
*/
RecordIdBound getAbsoluteMinPreImageRecordIdBoundForNs(const UUID& nsUUID);
RecordIdBound getAbsoluteMaxPreImageRecordIdBoundForNs(const UUID& nsUUID);
/**
* Finds the next collection UUID in 'preImagesCollPtr' greater than 'currentNsUUID'. Returns
* boost::none if the next collection is not found. Stores the wall time of the first record in the
* next collection in 'firstDocWallTime'.
*/
boost::optional<UUID> findNextCollectionUUID(OperationContext* opCtx,
const CollectionPtr* preImagesCollPtr,
boost::optional<UUID> currentNsUUID,
Date_t& firstDocWallTime);
/**
* Preferred method for getting the current time in pre-image removal code - in testing
* enviornments, the 'changeStreamPreImageRemoverCurrentTime' failpoint can alter the return value.
*
* Returns the current time.
*/
Date_t getCurrentTimeForPreImageRemoval();
} // namespace change_stream_pre_image_util
} // namespace mongo
|
