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
|
/**
* 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 <boost/optional/optional.hpp>
#include "mongo/db/operation_context.h"
#include "mongo/db/tenant_id.h"
namespace mongo {
namespace change_stream_serverless_helpers {
using TenantSet = stdx::unordered_set<TenantId, TenantId::Hasher>;
/**
* Returns true if the server is configured such that change collections can be used to record
* oplog entries; ie, we are running in a Serverless context. Returns false otherwise.
*/
bool isChangeCollectionsModeActive();
/**
* Returns true if the change stream is enabled for the provided tenant, false otherwise.
*/
bool isChangeStreamEnabled(OperationContext* opCtx, const TenantId& tenantId);
/**
* Returns true if services related to the serverless change stream can be initialized.
* TODO SERVER-69960 Remove this function and use 'isChangeCollectionsModeActive' instead.
*/
bool canInitializeServices();
/**
* Returns true if the target environment (replica-set or sharded-cluster) supports running change
* stream in the serverless, false otherwise.
*/
bool canRunInTargetEnvironment();
/**
* Returns an internal tenant id that will be used for testing purposes. This tenant id will not
* conflict with any other tenant id.
*/
const TenantId& getTenantIdForTesting();
/**
* If the provided 'tenantId' is missing and 'internalChangeStreamUseTenantIdForTesting' is true,
* returns a special 'TenantId' for testing purposes. Otherwise, returns the provided 'tenantId'.
*/
boost::optional<TenantId> resolveTenantId(boost::optional<TenantId> tenantId);
/**
* Returns the list of the tenants associated with a 'config' database.
*/
TenantSet getConfigDbTenants(OperationContext* opCtx);
/**
* Returns the 'expireAfterSeconds' value from the 'changeStreams' cluster-wide parameter for the
* given tenant.
*/
int64_t getExpireAfterSeconds(const TenantId& tenantId);
} // namespace change_stream_serverless_helpers
} // namespace mongo
|
