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
111
112
113
114
115
116
117
118
119
120
|
/**
* Copyright (C) 2018-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.
*/
#include <vector>
#include "mongo/base/status.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/db/repl/apply_ops_gen.h"
#include "mongo/db/repl/multiapplier.h"
#include "mongo/db/repl/oplog.h"
#include "mongo/db/repl/oplog_entry.h"
namespace mongo {
class BSONObjBuilder;
class OperationContext;
namespace repl {
class ApplyOps {
public:
static constexpr StringData kPreconditionFieldName = "preCondition"_sd;
static constexpr StringData kOplogApplicationModeFieldName = "oplogApplicationMode"_sd;
/**
* Extracts CRUD operations from an atomic applyOps oplog entry.
* Throws UserException on error.
*/
static std::vector<OplogEntry> extractOperations(const OplogEntry& applyOpsOplogEntry);
/**
* This variant allows optimization for extracting multiple applyOps operations. The entry for
* the non-DurableReplOperation fields of the extracted operation must be specified as
* 'topLevelDoc', and need not be any of the applyOps operations. The 'topLevelDoc' entry's
* 'ts' field will be used as the 'ts' field for each operation.
*/
static void extractOperationsTo(const OplogEntry& applyOpsOplogEntry,
const BSONObj& topLevelDoc,
std::vector<OplogEntry>* operations);
};
/**
* Holds information about an applyOps command object.
*/
class ApplyOpsCommandInfo : public ApplyOpsCommandInfoBase {
public:
/**
* Parses the object in the 'o' field of an applyOps command.
* May throw UserException.
*/
static ApplyOpsCommandInfo parse(const BSONObj& applyOpCmd);
/**
* Returns true if all operations described by this applyOps command are CRUD only.
*/
bool areOpsCrudOnly() const;
/**
* Returns true if applyOps will try to process all operations in a single batch atomically.
* Derived from getAllowAtomic() and areOpsCrudOnly().
*/
bool isAtomic() const;
private:
explicit ApplyOpsCommandInfo(const BSONObj& applyOpCmd);
const bool _areOpsCrudOnly;
};
/**
* Applies ops contained in 'applyOpCmd' and populates fields in 'result' to be returned to the
* caller. The information contained in 'result' can be returned to the user if called as part
* of the execution of an 'applyOps' command.
*
* The 'oplogApplicationMode' argument determines the semantics of the operations contained within
* the given command object. This function may be called as part of a direct user invocation of the
* 'applyOps' command, or as part of the application of an 'applyOps' oplog operation. In either
* case, the mode can be set to determine how the internal ops are executed.
*
* For oplog application, the optime of the oplog entry will be given as the "optime" argument.
*/
Status applyOps(OperationContext* opCtx,
const std::string& dbName,
const BSONObj& applyOpCmd,
repl::OplogApplication::Mode oplogApplicationMode,
BSONObjBuilder* result);
/**
* Applies a non-transactional 'applyOps' oplog entry. That is, an 'applyOps' entry that was not
* generated by a transaction.
*/
Status applyApplyOpsOplogEntry(OperationContext* opCtx,
const OplogEntry& entry,
repl::OplogApplication::Mode oplogApplicationMode);
} // namespace repl
} // namespace mongo
|
