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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
|
# Copyright (C) 2020-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.
#
# Contains internal DDL commands which are exchanged between Router and Shard/ConfigServer role and are linked both on MongoD and MongoS
global:
cpp_namespace: "mongo"
cpp_includes:
- "mongo/s/catalog/type_collection.h"
imports:
- "mongo/db/commands/rename_collection.idl"
- "mongo/db/commands/set_user_write_block_mode.idl"
- "mongo/db/drop_database.idl"
- "mongo/db/keypattern.idl"
- "mongo/db/coll_mod.idl"
- "mongo/idl/basic_types.idl"
- "mongo/s/chunk_version.idl"
- "mongo/s/sharding_types.idl"
- "mongo/s/resharding/common_types.idl"
- "mongo/db/timeseries/timeseries.idl"
types:
CollectionType:
description: "Information of a sharded collection."
bson_serialization_type: object
cpp_type: CollectionType
serializer: "mongo::CollectionType::toBSON"
deserializer: "mongo::CollectionType"
enums:
ShardsvrSetUserWriteBlockModePhase:
description: "Phase for the _shardsvrSetUserWriteBlockMode command."
type: string
values:
# When enabling user write blocking, kPrepare means the shard will start blocking
# sharded DDL operations. When disabling user write blocking, kPrepare means the shard
# will to start accepting user writes again.
kPrepare: "prepare"
# When enabling user write blocking, kComplete means the shard will start blocking
# user writes. When disabling user write blocking, kComplete means the shard
# will to start accepting sharded DDL operations again.
kComplete: "complete"
structs:
ConfigsvrCreateDatabaseResponse:
description: "Response for the create database command"
strict: false
fields:
databaseVersion:
type: database_version
description: "The version of the newly-created or already existing database"
optional: false
RenameCollectionRequest:
description: "Request for the rename collection command"
strict: false
fields:
to:
type: namespacestring
description: "The new namespace for the collection being renamed."
dropTarget:
type: bool
description: "If true, mongod will drop the target of renameCollection prior to
renaming the collection."
default: false
stayTemp:
type: bool
description: "If true, the original collection will remain temp if it was temp
before the rename."
default: false
expectedSourceUUID:
type: uuid
description: "The expected UUID of the source collection."
optional: true
expectedTargetUUID:
type: uuid
description: "The expected UUID of the target collection."
optional: true
RenameCollectionResponse:
description: "Response for the rename collection command"
strict: false
fields:
collectionVersion:
type: ChunkVersionArrayWronglyEncodedAsBSONObjFormat
description: "Latest version of the collection"
optional: false
CreateCollectionRequest:
description: "All the parameters sent by the router."
generate_comparison_operators: false
# TODO SERVER-64720 remove the following comment
# WARN if you add any new field to this request you must also include it in
# CreateCollectionCoordinatorDocumentPre60Compatible::kPre60IncompatibleFields
strict: false
fields:
shardKey:
type: object_owned
description: "The index specification document to use as the shard key."
optional: true
unique:
type: bool
description: "Whether the shard key index should enforce a unique constraint."
optional: true
numInitialChunks:
type: safeInt64
description: >-
The number of chunks to create initially when sharding an empty collection with
a hashed shard key.
optional: true
presplitHashedZones:
type: bool
description: >-
True if the chunks should be pre-split based on the existing zones when
sharding a collection with hashed shard key.
optional: true
initialSplitPoints:
type: array<object_owned>
description: >-
A specific set of points to create initial splits at, currently used only by
mapReduce.
optional: true
timeseries:
description: "The options to create the time-series collection with."
type: TimeseriesOptions
optional: true
collation:
type: object_owned
description: "The collation to use for the shard key index."
optional: true
collectionUUID:
type: uuid
description: "The expected UUID of the collection."
optional: true
implicitlyCreateIndex:
description: "Creates an index on the shard key pattern if the collection is empty."
type: optionalBool
enforceUniquenessCheck:
description: >-
Controls whether this command verifies that any unique indexes are prefixed by
the shard key pattern if unique is true. If true then it will verify and if
false then it won't.
type: optionalBool
CreateCollectionResponse:
description: "Response of the create collection command"
strict: false
fields:
collectionUUID:
type: uuid
description: "UUID of the created collection"
optional: true
collectionVersion:
type: ChunkVersionArrayWronglyEncodedAsBSONObjFormat
description: "Latest version of the collection"
optional: false
RefineCollectionShardKeyRequest:
description: "Parameters sent by the router"
strict: false
fields:
newShardKey:
type: KeyPattern
description: "The index specification document to use as the new shard key."
optional: false
collectionUUID:
type: uuid
description: "The expected UUID of the collection."
optional: true
enforceUniquenessCheck:
description: >-
Controls whether this command verifies that any unique indexes are prefixed by
the shard key pattern if unique is true. If true then it will verify and if
false then it won't.
type: optionalBool
ReshardCollectionRequest:
description: "Parameters for the reshard collection command"
strict: false
fields:
key:
type: object
description: "The index specification document to use as the new shard key."
optional: false
unique:
type: bool
description: "Whether the shard key index should enforce a unique constraint."
optional: true
numInitialChunks:
type: safeInt64
description: "The number of chunks to create initially."
optional: true
collation:
type: object
description: "The collation to use for the shard key index."
optional: true
zones:
type: array<ReshardingZoneType>
description: "The zones associated with the new shard key."
optional: true
_presetReshardedChunks:
type: array<ReshardedChunk>
description: >-
"Mapping of chunk ranges to be used as the initial split output. This is only
for testing purposes."
optional: true
collectionUUID:
type: uuid
description: "The expected UUID of the collection."
optional: true
SetAllowMigrationsRequest:
description: "Parameters sent for the set allow migrations command"
strict: false
fields:
allowMigrations:
type: bool
description: "If false balancer rounds should be disabled and migrations commit prohibited."
optional: false
commands:
_shardsvrCreateCollection:
command_name: _shardsvrCreateCollection
cpp_name: ShardsvrCreateCollection
description: "The internal createCollection command for a shard."
strict: false
namespace: concatenate_with_db
api_version: ""
chained_structs:
CreateCollectionRequest: CreateCollectionRequest
_shardsvrCreateCollectionParticipant:
command_name: _shardsvrCreateCollectionParticipant
cpp_name: ShardsvrCreateCollectionParticipant
description: "Command to create a collection on participant shards, when called, assumes the primary shard is under the critical section for that namespace."
strict: false
namespace: concatenate_with_db
api_version: ""
fields:
indexes:
type: array<object>
description: "Collection indexes."
options:
type: object
description: "Collection options."
collectionUUID:
type: uuid
description: "Collection uuid."
optional: true
idIndex:
type: object
description: "Id index."
_shardsvrDropDatabase:
description: "Internal command sent to the primary shard of a database to drop it."
command_name: _shardsvrDropDatabase
namespace: ignored
api_version: ""
cpp_name: ShardsvrDropDatabase
_shardsvrDropDatabaseParticipant:
description: "Internal command sent to participants shards to drop a database."
command_name: _shardsvrDropDatabaseParticipant
namespace: ignored
api_version: ""
cpp_name: ShardsvrDropDatabaseParticipant
strict: false
_shardsvrDropCollection:
description: "Parser for the _shardsvrDropCollection command"
command_name: _shardsvrDropCollection
namespace: concatenate_with_db
api_version: ""
cpp_name: ShardsvrDropCollection
strict: false
fields:
collectionUUID:
type: uuid
description: "The expected UUID of the collection."
optional: true
_shardsvrDropCollectionParticipant:
description: "Parser for the _shardsvrDropCollectionParticipant command"
command_name: _shardsvrDropCollectionParticipant
namespace: concatenate_with_db
api_version: ""
cpp_name: ShardsvrDropCollectionParticipant
strict: false
_shardsvrRenameCollection:
command_name: _shardsvrRenameCollection
cpp_name: ShardsvrRenameCollection
description: "Internal renameCollection command for a shard."
strict: false
namespace: concatenate_with_db
api_version: ""
chained_structs:
RenameCollectionRequest: RenameCollectionRequest
_shardsvrSetAllowMigrations:
command_name: _shardsvrSetAllowMigrations
cpp_name: shardsvrSetAllowMigrations
description: "Internal setAllowMigrations command for a shard."
strict: false
namespace: concatenate_with_db
api_version: ""
chained_structs:
SetAllowMigrationsRequest: SetAllowMigrationsRequest
_configsvrRenameCollectionMetadata:
command_name: _configsvrRenameCollectionMetadata
cpp_name: ConfigsvrRenameCollectionMetadata
description: "Internal command for renaming collection metadata on the CSRS"
strict: false
namespace: concatenate_with_db
api_version: ""
fields:
to:
type: namespacestring
description: "The new namespace for the collection being renamed."
optFromCollection:
description: "Information of the source collection to rename, used only for sharded collection."
type: CollectionType
optional: true
_shardsvrReshardCollection:
command_name: _shardsvrReshardCollection
cpp_name: ShardsvrReshardCollection
description: "The internal reshardCollection command on the shard."
strict: false
namespace: type
api_version: ""
type: namespacestring
chained_structs:
ReshardCollectionRequest: ReshardCollectionRequest
_shardsvrRefineCollectionShardKey:
description: "Parser for the _shardsvrRefineCollectionShardKey command"
command_name: _shardsvrRefineCollectionShardKey
cpp_name: ShardsvrRefineCollectionShardKey
namespace: concatenate_with_db
api_version: ""
strict: false
chained_structs:
RefineCollectionShardKeyRequest: RefineCollectionShardKeyRequest
_configsvrRefineCollectionShardKey:
command_name: _configsvrRefineCollectionShardKey
cpp_name: ConfigsvrRefineCollectionShardKey
description: "The internal refineCollectionShardKey command on the config server"
strict: false
namespace: type
api_version: ""
type: namespacestring
fields:
key:
type: object
description: "The index specification document to use as the new shard key."
optional: false
epoch:
type: objectid
description: "The expected epoch of the namespace provided to
refineCollectionShardKey."
optional: false
enforceUniquenessCheck:
description: >-
Verifies that the shard key index has the same unique setting as the command.
type: optionalBool
_configsvrCreateDatabase:
description: "The internal createDatabase command on the config server"
api_version: ""
command_name: _configsvrCreateDatabase
cpp_name : ConfigsvrCreateDatabase
namespace: type
type: string
reply_type: ConfigsvrCreateDatabaseResponse
strict: false
fields:
primaryShardId:
type: shard_id
description: "If set, indicates to the system which shard should be used as the
primary for the database (if not already created). Otherwise, the
system will use the balancer in order to select a primary."
optional: true
# TODO SERVER-63983: remove the following field when 6.0 becomes lastLTS
enableSharding:
type: bool
description: "May only be set to 'true'. If set, indicates to the config server that
it must turn on the 'enableSharding' bit for that database."
optional: true
_shardsvrCollMod:
command_name: _shardsvrCollMod
cpp_name: ShardsvrCollMod
description: "Internal command sent to the primary shard in a collMod procedure"
strict: false
api_version: ""
namespace: concatenate_with_db
chained_structs:
CollModRequest: CollModRequest
_configsvrSetUserWriteBlockMode:
command_name: _configsvrSetUserWriteBlockMode
cpp_name: ConfigsvrSetUserWriteBlockMode
description: "internal _configsvrSetUserWriteBlockMode command"
namespace: ignored
api_version: ""
strict: false
chained_structs:
SetUserWriteBlockModeRequest: SetUserWriteBlockModeRequest
_shardsvrSetUserWriteBlockMode:
command_name: _shardsvrSetUserWriteBlockMode
cpp_name: ShardsvrSetUserWriteBlockMode
description: "internal _shardsvrSetUserWriteBlockMode command"
namespace: ignored
api_version: ""
strict: false
chained_structs:
SetUserWriteBlockModeRequest: SetUserWriteBlockModeRequest
fields:
phase:
type: ShardsvrSetUserWriteBlockModePhase
description: "Determines the phase of the blocking/unblocking procedure to be
executed."
_configsvrSetClusterParameter:
command_name: _configsvrSetClusterParameter
cpp_name: ConfigsvrSetClusterParameter
description: "Internal command sent to the config server to start a coordinator and set the
cluster parameter."
# TODO SERVER-63870: use replica set command parameters.
namespace: type
type: object_owned
api_version: ""
strict: false
_configsvrClearJumboFlag:
command_name: _configsvrClearJumboFlag
cpp_name: ConfigsvrClearJumboFlag
description: "internal clearJumboFlag command for config server"
namespace: type
api_version: ""
type: namespacestring
strict: false
fields:
epoch:
type: objectid
description: "The expected epoch of the namespace provided to
clearJumboFlag."
optional: false
minKey:
type: object
description: "The lower bound key value of the chunk."
maxKey:
type: object
description: "The upper bound key value of the chunk."
|