summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/replication_consistency_markers.idl
blob: b9044268e624b494fd4ab9ef1bd10e29345e76c4 (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
# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or  modify

#    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.
#

# Replication Consistency Markers IDL File

global:
    cpp_namespace: "mongo::repl"

imports:
    - "mongo/idl/basic_types.idl"
    - "mongo/db/repl/replication_types.idl"

structs:
    MinValidDocument:
        description: A document in which the server stores its minValid and appliedThrough information.
        fields:
            ts:
                cpp_name: minValidTimestamp
                type: timestamp
                description: "The timestamp for the OpTime at which the data on disk will be consistent"
            t:
                cpp_name: minValidTerm
                type: safeInt64
                description: "The term for the OpTime at which the data on disk will be consistent; -1 for PV0."
            begin:
                cpp_name: appliedThrough
                type: optime
                optional: true # This field is unset when we want to mark that we are consistent at the top of the oplog
                description: "The OpTime of the last oplog entry we applied"
            # TODO (SERVER-30556): Delete this field since it cannot exist after 3.6.
            oplogDeleteFromPoint:
                cpp_name: oldOplogDeleteFromPoint
                type: timestamp
                optional: true # This field only exists on 3.4 upgrade
                description: "The timestamp of the first oplog entry in a batch when we are writing
                              oplog entries to the oplog after which the oplog may be inconsistent.
                              This field only exists on 3.4 upgrade."
            doingInitialSync:
                cpp_name: initialSyncFlag
                type: bool
                optional: true # This field is unset when we are not doing initial sync
                description: "A flag for if we are in the middle of initial sync"
            _id:
                type: objectid
                optional: true # This is automatically created when the document is upserted
                description: "An objectid that is not used but is automatically generated"
    OplogTruncateAfterPointDocument:
        description: A document in which the server stores information on where to truncate the oplog on unclean shutdown.
        fields:
            oplogTruncateAfterPoint:
                type: timestamp
                description: "The timestamp of the first oplog entry in a batch when we are writing oplog entries to the oplog after which the oplog may be inconsistent."
            _id:
                type: string
                description: "Always set to 'oplogTruncateAfterPoint' to easily retrieve it."
    CheckpointTimestampDocument:
        description: A document that stores the latest timestamp the database can recover to.
        fields:
            checkpointTimestamp:
                type: timestamp
                description: "The checkpoint timestamp. Should be set by a storage engine
                              before a checkpoint is taken."
            _id:
                type: string
                description: "Always set to 'checkpointTimestamp' to easily retrieve it."