summaryrefslogtreecommitdiff
path: root/src/mongo/db/session_txn_record.idl
blob: 04714e143a7691355dd780a54d7de4726b23f3bd (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
# 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.
#

# Session Transaction Entry IDL File

global:
    cpp_namespace: "mongo"
    cpp_includes:
        - "mongo/db/logical_session_id.h"
        - "mongo/db/repl/optime.h"

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

enums:
    DurableTxnState:
        description: "The state of the most recent durable transaction on a session"
        type: string
        values:
            kPrepared: "prepared"
            kCommitted: "committed"
            kAborted: "aborted"
            kInProgress: "inProgress"

structs:
    sessionTxnRecord:
        description: "A document used for storing session transaction states."
        strict: false
        fields:
            _id:
                cpp_name: sessionId
                type: LogicalSessionId
                description: "The id of the session this transaction belongs to."
            txnNum:
                type: TxnNumber
                description: "The id representing this transaction."
            startOpTime:
                type: optime
                description: "The optime of this transaction's first oplog entry."
                optional: true
            lastWriteOpTime:
                type: optime
                description: "The optime timestamp component of the last write on this
                              transaction."
            lastWriteDate:
                type: date
                description: "Wall clock time of the last write which happened on on this
                              transaction."
            state:
                type: DurableTxnState
                optional: true # Retryable writes do not have a state field.
                description: "The state of the most recent durable transaction on the session"