summaryrefslogtreecommitdiff
path: root/src/mongo/db/change_stream_change_collection_manager.h
blob: b4ad0e25c50a0d1d45837ebf8c37e08b486466e7 (plain)
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
/**
 *    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/service_context.h"

namespace mongo {

/**
 * Manages the creation, deletion and insertion lifecycle of the change collection.
 */
class ChangeStreamChangeCollectionManager {
public:
    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. Returns Status::OK
     * if the change collection already exists.
     *
     * TODO: SERVER-65950 make tenantId field mandatory.
     */
    Status createChangeCollection(OperationContext* opCtx, boost::optional<TenantId> tenantId);

    /**
     * Deletes the change collection for the specified tenant, if it already exist.
     *
     * TODO: SERVER-65950 make tenantId field mandatory.
     */
    Status dropChangeCollection(OperationContext* opCtx, boost::optional<TenantId> tenantId);

    /**
     * Inserts documents to the change collection for the specified tenant. The parameter 'records'
     * is a vector of oplog records and the parameter 'timestamps' is a vector for respective
     * timestamp for each oplog record.
     *
     * TODO: SERVER-65950 make tenantId field mandatory.
     */
    Status insertDocumentsToChangeCollection(OperationContext* opCtx,
                                             boost::optional<TenantId> tenantId,
                                             std::vector<Record>* records,
                                             const std::vector<Timestamp>& timestamps);
};

}  // namespace mongo