summaryrefslogtreecommitdiff
path: root/src/mongo/db/commands/txn_two_phase_commit_cmds.idl
blob: e3605b4fb6e259c2d2c019ee7562a40daee78df2 (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
# Copyright (C) 2018 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.
#
global:
    cpp_namespace: "mongo"

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

structs:
    CommitParticipant:
        description: "Describes a shard participant in a transaction commit"
        fields:
            shardId:
                description: "The id of the shard"
                type: shard_id

commands:
    prepareTransaction:
        description: "Parser for the 'prepareTransaction' command."
        strict: true
        namespace: ignored
        fields:
            coordinatorId:
                description: "The coordinator shard for this transaction."
                type: shard_id

    voteCommitTransaction:
        description: "Parser for the 'voteCommitTransaction' command."
        namespace: ignored
        fields:
            shardId:
                description: "The shard name of the sender"
                type: shard_id
            prepareTimestamp:
                description: "Timestamp at which the sender prepared the transaction"
                type: timestamp

    voteAbortTransaction:
        description: "Parser for the 'voteAbortTransaction' command."
        namespace: ignored
        fields:
            shardId:
                description: "The shard name of the sender"
                type: shard_id

    coordinateCommitTransaction:
        description: "Parser for the 'coordinateCommitTransaction' command."
        strict: false
        namespace: ignored
        fields:
            participants:
                description: "An array of shard participants that must be included in the commit."
                type: array<CommitParticipant>