summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/optime_base.idl
blob: 755510ae41b7f26f5400b2f2eda33340c986b450 (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
# Copyright (C) 2019-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.

# This IDL file specifies the fields for OpTimeBase.

global:
    cpp_namespace: "mongo::repl"

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

structs:
    OpTimeBase:
        description: "A document that stores the logical time-related fields in an oplog entry.
                     Should never be used directly in server code. Instead, create an instance
                     of OpTime."
        strict: false
        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 will no longer be optional, see SERVER-42258.
                description: "The term of the primary that created the oplog entry"