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
|
/**
* 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 <cstddef> // for std::size_t
#include <vector>
#include "mongo/db/catalog/collection.h" // for CollectionPtr
#include "mongo/db/operation_context.h"
#include "mongo/db/repl/oplog.h" // for OplogLink
#include "mongo/db/repl/oplog_entry.h" // for MutableOplogEntry
#include "mongo/db/session/logical_session_id.h" // for StmtId
#include "mongo/db/storage/record_store.h" // for Record
#include "mongo/util/time_support.h" // for Date_t
namespace mongo {
/**
* This interface provides methods to append entries to the oplog collection with additional
* support for various buffering/write-through semantics depending on the caller's current
* write context (multi-doc transaction, batched writes, or single-operation WriteUnitOfWork).
*
* The actual oplog entry inserts would be delegated to the repl::logOp() methods in repl/oplog.h.
*
* The primary consumer of this interface would be the OpObserverImpl implementation, which
* used to append to the oplog directly once it has assembled the final oplog entry for single write
* operation to be inserted immediately; a multi-doc transaction or a batched write (multiple write
* ops encapsulated in a single applyOps entry).
*/
class OplogWriter {
public:
virtual ~OplogWriter() = default;
/**
* Set the "lsid", "txnNumber", "stmtId", "prevOpTime", "preImageOpTime" and "postImageOpTime"
* fields of the oplogEntry based on the given oplogLink for retryable writes (i.e. when
* stmtIds.front() != kUninitializedStmtId).
*
* Refer to repl::appendOplogEntryChainInfo() in repl/oplog.h.
*/
virtual void appendOplogEntryChainInfo(OperationContext* opCtx,
repl::MutableOplogEntry* oplogEntry,
repl::OplogLink* oplogLink,
const std::vector<StmtId>& stmtIds) = 0;
/**
* Returns the optime of the oplog entry written to the oplog.
* Returns a null optime if oplog was not modified.
*/
virtual repl::OpTime logOp(OperationContext* opCtx, repl::MutableOplogEntry* oplogEntry) = 0;
/**
* Low level oplog function used by logOp() and similar functions to append
* storage engine records to the oplog collection.
*
* This function has to be called within the scope of a WriteUnitOfWork with
* a valid CollectionPtr reference to the oplog.
*
* @param records a vector of oplog records to be written. Records hold references
* to unowned BSONObj data.
* @param timestamps a vector of respective Timestamp objects for each oplog record.
* @param oplogCollection collection to be written to.
* @param finalOpTime the OpTime of the last oplog record.
* @param wallTime the wall clock time of the last oplog record.
* @param isAbortIndexBuild for tenant migration use only.
*/
virtual void logOplogRecords(OperationContext* opCtx,
const NamespaceString& nss,
std::vector<Record>* records,
const std::vector<Timestamp>& timestamps,
const CollectionPtr& oplogCollection,
repl::OpTime finalOpTime,
Date_t wallTime,
bool isAbortIndexBuild) = 0;
/**
* Allocates optimes for new entries in the oplog. Returns a vector of OplogSlots, which
* contain the new optimes along with their terms and newly calculated hash fields.
*/
virtual std::vector<OplogSlot> getNextOpTimes(OperationContext* opCtx, std::size_t count) = 0;
};
} // namespace mongo
|
