summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/oplog_entry.idl
blob: a01b38f2ee0eef5ba52054030c8689624759e752 (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
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
121
122
123
124
125
126
127
# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or  modify
# it under the terms of the GNU Affero General Public License, version 3,
# as published by the Free Software Foundation.
#
# 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
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# 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 GNU Affero General 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.

# Oplog Entry IDL File

global:
    cpp_namespace: "mongo::repl"

imports:
    - "mongo/idl/basic_types.idl"
    - "mongo/db/logical_session_id.idl"

enums:
    OpType:
        description: "The type of an operation in the oplog"
        type: string
        values:
            kCommand: "c"
            kInsert: "i"
            kUpdate: "u"
            kDelete: "d"
            kNoop: "n"

structs:
    OplogEntryBase:
        description: A document in which the server stores an oplog entry.
        chained_structs:
            OperationSessionInfo : OperationSessionInfo
        fields:
            ts:
                cpp_name: timestamp
                type: timestamp
                description: "The time when the oplog entry was created"
            t:
                cpp_name: term
                type: long
                optional: true # The term is optional for PV0 oplog entries.
                description: "The term of the primary that created the oplog entry"
            h:
                cpp_name: hash
                type: long
                description: "The hash of the oplog entry"
            v:
                cpp_name: version
                type: safeInt64
                default: 1
                description: "The version of the oplog"
            op:
                cpp_name: opType
                type: OpType
                description: "The operation type"
            ns:
                cpp_name: namespace
                type: namespacestring
                description: "The namespace on which to apply the operation"
            ui:
                cpp_name: uuid
                type: uuid
                optional: true
                description: "The UUID of the collection"
            fromMigrate:
                type: bool
                optional: true
                description: "An operation caused by a chunk migration"
            o:
                cpp_name: object
                type: object
                description: "The operation applied"
            o2:
                cpp_name: object2
                type: object
                optional: true
                description: "Additional information about the operation applied"
            _id:
                type: objectid
                optional: true
                description: "An optional _id field for tests that manually insert oplog entries"
            wall:
                cpp_name: wallClockTime
                type: date
                optional: true # Optional for older than 3.6 releases
                description: "A wallclock time with MS resolution"
            stmtId:
                cpp_name: statementId
                type: StmtId
                optional: true # If txnNumber is missing, this will also be absent, otherwise it
                               # must exist.
                description: "Identifier of the transaction statement which generated this oplog
                              entry"
            prevTs:
                cpp_name: prevWriteTsInTransaction
                type: timestamp
                optional: true # Only for writes that are part of a transaction
                description: "The oplog timestamp of the previous write with the same transaction."
            preImageTs:
                type: timestamp
                optional: true
                description: "The oplog timestamp of another oplog entry that contains the document
                              before an update/remove was applied."
            postImageTs:
                type: timestamp
                optional: true
                description: "The oplog timestamp of another oplog entry that contains the document
                              after an update was applied."