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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
# 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.
#
# This IDL file describes the BSON format for a LogicalSessionId, and
# handles the serialization to and deserialization from its BSON representation
# for that class.
global:
cpp_namespace: "mongo"
cpp_includes:
- "mongo/util/uuid.h"
imports:
- "mongo/idl/basic_types.idl"
- "mongo/crypto/sha256_block.idl"
types:
TxnNumber:
description: "A strictly-increasing per-session counter, which indicates to which transaction
of a given session does the specified command belong. The combination of
LogicalSessionId:TxnNumber is referred to as the transaction identifier."
bson_serialization_type: long
cpp_type: "std::int64_t"
deserializer: "mongo::BSONElement::_numberLong"
StmtId:
description: "A number representing an operation within a transaction."
bson_serialization_type: int
cpp_type: "std::int32_t"
deserializer: "mongo::BSONElement::_numberInt"
structs:
LogicalSessionId:
description: "A struct representing a LogicalSessionId"
strict: true
fields:
id: uuid
uid: sha256Block
LogicalSessionIdToClient:
description: "A struct representing a LogicalSessionId to external clients"
strict: true
fields:
id: uuid
LogicalSessionToClient:
description: "A struct representing a LogicalSession reply to external clients"
strict: true
fields:
id: LogicalSessionIdToClient
timeoutMinutes: int
LogicalSessionRecord:
description: "A struct representing a LogicalSessionRecord"
strict: true
fields:
_id:
type: LogicalSessionId
cpp_name: id
lastUse: date
user:
type: string
optional: true
LogicalSessionFromClient:
description: "A struct representing a LogicalSessionId from external clients"
strict: true
fields:
id: uuid
uid:
type: sha256Block
optional: true
OperationSessionInfo:
description: "Parser for serializing sessionId/txnNumber combination"
strict: false
fields:
lsid:
type: LogicalSessionId
cpp_name: sessionId
optional: true
txnNumber:
description: "The transaction number relative to the session in which a particular write
operation executes."
type: TxnNumber
optional: true
OperationSessionInfoFromClient:
description: "Parser for pulling out the sessionId/txnNumber combination from commands"
strict: false
fields:
lsid:
type: LogicalSessionFromClient
cpp_name: sessionId
optional: true
txnNumber:
description: "The transaction number relative to the session in which a particular write
operation executes."
type: TxnNumber
optional: true
autocommit:
type: bool
optional: true
startTransaction:
description: "Used to indicate that a command is the start of a multi-statement
transaction."
type: bool
optional: true
coordinator:
description: "Indicates that this shard is the coordinator shard for the transaction two-phase commit."
type: bool
optional: true
SessionsCollectionFetchResultIndividualResult:
description: "Individual result"
strict: true
fields:
_id: LogicalSessionId
SessionsCollectionFetchResultCursor:
description: "Cursor object"
strict: false
fields:
firstBatch: array<SessionsCollectionFetchResultIndividualResult>
SessionsCollectionFetchResult:
description: "Parser for pulling out the fetch results from SessionsCollection::fetch"
strict: false
fields:
cursor: SessionsCollectionFetchResultCursor
SessionsCollectionFetchRequestFilterId:
description: "Id"
strict: true
fields:
$in:
type: array<LogicalSessionId>
cpp_name: "in"
SessionsCollectionFetchRequestFilter:
description: "filter"
strict: true
fields:
_id: SessionsCollectionFetchRequestFilterId
SessionsCollectionFetchRequestProjection:
description: "projection"
strict: true
fields:
_id: int
SessionsCollectionFetchRequest:
description: "Parser for forming the fetch request for SessionsCollection::fetch"
strict: true
fields:
find: string
filter: SessionsCollectionFetchRequestFilter
projection: SessionsCollectionFetchRequestProjection
batchSize: int
singleBatch: bool
limit: int
server_parameters:
localLogicalSessionTimeoutMinutes:
description: 'The time in minutes that a session remains active after its most recent use'
set_at: [ startup ]
cpp_vartype: int
cpp_varname: localLogicalSessionTimeoutMinutes
default: 30
|
