summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/hello.idl
blob: 50ba56c0cd41c35efb26d96d6f0bfa408d6fbdbb (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
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# Copyright (C) 2021-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/db/auth/auth_types.idl"
    - "mongo/db/repl/replication_types.idl"
    - "mongo/db/write_concern_options.idl"
    - "mongo/idl/basic_types.idl"
    - "mongo/rpc/metadata/client_metadata.idl"
    - "mongo/rpc/topology_version.idl"

structs:
    HelloInternalClientField:
        description: "Specifies min/max wire protocol versions"
        strict: true
        fields:
            minWireVersion:
                # Currently ignored
                type: safeInt
                default: 0
                unstable: false
            maxWireVersion:
                type: safeInt
                unstable: false

    HelloLastWrite:
        description: "Most recent op/write times for this node"
        strict: true
        fields:
            opTime:
                type: optime
                optional: true
                unstable: false
            lastWriteDate:
                type: date
                optional: true
                unstable: false
            majorityOpTime:
                type: optime
                optional: true
                unstable: false
            majorityWriteDate:
                type: date
                optional: true
                unstable: false

    HelloCommandReply:
        description: "Reply to 'hello' command"
        strict: true
        fields:
            helloOk:
                type: bool
                default: true
                unstable: false
            clientSupportsHello:
                type: bool
                optional: true
                unstable: false
            configsvr:
                type: safeInt
                optional: true
                unstable: false
            maxBsonObjectSize:
                type: safeInt64
                optional: true
                unstable: false
            maxMessageSizeBytes:
                type: safeInt64
                optional: true
                unstable: false
            maxWriteBatchSize:
                type: safeInt64
                optional: true
                unstable: false
            localTime:
                type: date
                optional: true
                unstable: false
            logicalSessionTimeoutMinutes:
                type: safeInt
                optional: true
                unstable: false
            connectionId:
                type: safeInt64
                optional: true
                unstable: false
            minWireVersion:
                type: safeInt
                optional: true
                unstable: false
            maxWireVersion:
                type: safeInt
                optional: true
                unstable: false
            readOnly:
                type: bool
                optional: true
                unstable: false
            compression:
                type: array<string>
                optional: true
                unstable: false
            automationServiceDescriptor:
                type: string
                optional: true
                unstable: false
            saslSupportedMechs:
                type: array<string>
                optional: true
                unstable: false
            speculativeAuthenticate:
                type: object
                optional: true
                unstable: false
            msg:
                type: string
                optional: true
                unstable: false
            serviceId:
                type: objectid
                optional: true
                unstable: false
            ##
            ## ReplicationInfo
            ##
            topologyVersion:
                type: TopologyVersion
                unstable: false
            ismaster:
                # Replies will contain 'ismaster' OR 'isWritablePrimary', not both
                type: bool
                optional: true
                unstable: false
            isWritablePrimary:
                type: bool
                optional: true
                unstable: false
            ##
            ## Using ReplSets
            ##
            hosts:
                type: array<string>
                optional: true
                unstable: false
            passives:
                type: array<string>
                optional: true
                unstable: false
            arbiters:
                type: array<string>
                optional: true
                unstable: false
            setName:
                type: string
                optional: true
                unstable: false
            primary:
                type: string
                optional: true
                unstable: false
            secondary:
                type: bool
                optional: true
                unstable: false
            info:
                type: string
                optional: true
                unstable: false
            isreplicaset:
                type: bool
                optional: true
                unstable: false
            setVersion:
                type: safeInt
                optional: true
                unstable: false
            arbiterOnly:
                type: bool
                optional: true
                unstable: false
            passive:
                type: bool
                optional: true
                unstable: false
            hidden:
                type: bool
                optional: true
                unstable: false
            buildIndexes:
                type: bool
                optional: true
                unstable: false
            slaveDelay:
                # Reply will contain either slaveDelay or secondaryDelaySecs, but not both.
                type: safeInt64
                optional: true
                unstable: false
            secondaryDelaySecs:
                type: safeInt64
                optional: true
                unstable: false
            tags:
                type: object
                optional: true
                unstable: false
            me:
                type: string
                optional: true
                unstable: false
            electionId:
                type: objectid
                optional: true
                unstable: false
            lastWrite:
                type: HelloLastWrite
                optional: true
                unstable: false
            isImplicitDefaultMajorityWC:
                # Only populated on shard server.
                type: bool
                optional: true
                unstable: false
            cwwc:
                # Only populated on shard server.
                type: WriteConcern
                optional: true
                unstable: false

commands:
    hello:
        # Aliases: 'isMaster', 'ismaster'
        description: "Check if this server is primary for a replica set { hello: 1 }"
        command_name: hello
        namespace: ignored
        cpp_name: HelloCommand
        api_version: "1"
        access_check:
            none: true
        reply_type: HelloCommandReply
        # Most V1 commands should be strict: true but hello is special to allow for unknown fields.
        strict: false
        fields:
            forShell:
                type: safeBool
                default: false
                unstable: false
            hostInfo:
                type: string
                default: false
                unstable: false
            hangUpOnStepDown:
                type: safeBool
                default: true
                unstable: false
            internalClient:
                type: HelloInternalClientField
                optional: true
                unstable: false
            client:
                type: ClientMetadata
                optional: true
                unstable: false
            topologyVersion:
                type: TopologyVersion
                optional: true
                unstable: false
            maxAwaitTimeMS:
                type: safeInt64
                optional: true
                validator: { gte: 0 }
                unstable: false
            helloOk:
                type: safeBool
                optional: true
                unstable: false
            compression:
                type: array<string>
                optional: true
                unstable: false
            saslSupportedMechs:
                type: 
                    variant: [string, object_owned]
                optional: true
                unstable: false
            speculativeAuthenticate:
                type: object
                optional: true
                unstable: false
            loadBalanced:
                type: bool
                optional: true
                unstable: false