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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
|
# 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::write_ops"
cpp_includes:
- "mongo/db/ops/write_ops_parsers.h"
- "mongo/db/repl/optime.h"
imports:
- "mongo/crypto/fle_field_schema.idl"
- "mongo/db/auth/action_type.idl"
- "mongo/db/logical_session_id.idl"
- "mongo/db/pipeline/legacy_runtime_constants.idl"
- "mongo/db/query/hint.idl"
- "mongo/idl/basic_types.idl"
types:
multi_delete_bool:
bson_serialization_type: any
description: "An inverted boolean type used to parse the 'limit' property of the delete
command, which has a mandatory value of either 0 or 1, where 0 means multi
delete and 1 means delete just one."
cpp_type: "bool"
serializer: "::mongo::write_ops::writeMultiDeleteProperty"
deserializer: "::mongo::write_ops::readMultiDeleteProperty"
update_modification:
bson_serialization_type: any
description: "Holds the contents of the update command 'u' field, describing the
modifications to apply on update."
cpp_type: "mongo::write_ops::UpdateModification"
serializer: "mongo::write_ops::UpdateModification::serializeToBSON"
deserializer: "mongo::write_ops::UpdateModification::parseFromBSON"
write_cmd_optime:
bson_serialization_type: any
description: "Holds the operation-time for write commands."
cpp_type: "mongo::repl::OpTime"
serializer: "::mongo::write_ops::opTimeSerializerWithTermCheck"
deserializer: "::mongo::write_ops::opTimeParser"
write_error:
bson_serialization_type: object
description: "Structure used to report a single error entry resulting from a batch write
command."
cpp_type: "mongo::write_ops::WriteError"
serializer: "mongo::write_ops::WriteError::serialize"
deserializer: "mongo::write_ops::WriteError::parse"
structs:
WriteCommandReplyBase:
description: "Contains fields that is common in all the write commands reply."
fields:
n:
description: "For insert: number of documents inserted.
For update: number of documents that matched the query predicate.
For delete: number of documents deleted."
type: int
default: 0
unstable: false
electionId:
description: "Replication coordinator election id."
type: objectid
optional: true
unstable: false
opTime:
description: "Operation time for the command."
type: write_cmd_optime
optional: true
unstable: false
writeErrors:
description: "Contains all the errors encountered."
type: array<write_error>
optional: true
unstable: false
retriedStmtIds:
description: "The statement numbers for the write statements that had already been
executed, thus were not executed by this command."
type: array<int>
optional: true
unstable: true
InsertCommandReply:
description: "Contains information related to insert command reply."
strict: false
chained_structs:
WriteCommandReplyBase: writeCommandReplyBase
Upserted:
description: "Contains documents that have been upserted."
fields:
index:
description: "Index of the document."
type: int
unstable: false
_id:
description: "ID of the document."
type: IDLAnyTypeOwned
unstable: false
UpdateCommandReply:
description: "Contains information related to update command reply."
strict: false
chained_structs:
WriteCommandReplyBase: writeCommandReplyBase
fields:
upserted:
description: "An array contains information about upserted documents."
type: array<Upserted>
optional: true
unstable: false
nModified:
description: "Number of updated documents."
type: int
default: 0
unstable: false
DeleteCommandReply:
description: "Contains information related to delete command reply."
strict: false
chained_structs:
WriteCommandReplyBase: writeCommandReplyBase
WriteCommandRequestBase:
description: "Contains basic information included by all write commands"
strict: false
fields:
bypassDocumentValidation:
description: "Enables the operation to bypass document validation. This lets you
write documents that do not meet the validation requirements."
type: safeBool
default: false
unstable: false
ordered:
description: "If true, then when an write statement fails, the command returns
without executing the remaining statements. If false, then statements
are allowed to be executed in parallel and if a statement fails,
continue with the remaining statements, if any."
type: bool
default: true
unstable: false
stmtId:
description: "A statement number relative to the transaction. If this field
is set, the statement ids of the contained operation will be
implicitly generated based on their offset, starting from the value
given. This field is mutually exclusive with 'stmtIds'."
type: int
optional: true
unstable: false
stmtIds:
description: "An array of statement numbers relative to the transaction. If this
field is set, its size must be exactly the same as the number of
entries in the corresponding insert/update/delete request. If it is
not set, the statement ids of the contained operation will be
implicitly generated based on their offset, starting from 'stmtId' or
0 if 'stmtId' is not specified. This field is mutually exclusive
with 'stmtId'."
type: array<int>
optional: true
unstable: false
isTimeseriesNamespace:
description: "This flag is set to true when the write command was originally sent
to the time-series view, but got rewritten to target time-series
buckets namespace."
type: optionalBool
unstable: false
collectionUUID:
description: "The expected UUID of the collection."
type: uuid
optional: true
unstable: true
encryptionInformation:
description: "Encryption Information schema and other tokens for CRUD commands"
type: EncryptionInformation
optional: true
unstable: true
UpdateOpEntry:
description: "Parser for the entries in the 'updates' array of an update command."
strict: true
fields:
q:
description: "The query that matches documents to update. Uses the same query
selectors as used in the 'find' operation."
type: object
unstable: false
u:
description: "Set of modifications to apply."
type: update_modification
unstable: false
c:
description: "Specifies constant values that can be referred to in the pipeline
performing a custom update."
type: object
optional: true
unstable: false
arrayFilters:
description: "Specifies which array elements an update modifier should apply to."
type: array<object>
optional: true
unstable: false
hint:
description: "Specifies the hint to use for the operation."
type: indexHint
default: mongo::BSONObj()
unstable: false
multi:
description: "If true, updates all documents that meet the query criteria. If false,
limits the update to one document which meets the query criteria."
type: bool
default: false
unstable: false
upsert:
description: "If true, perform an insert if no documents match the query. If both
upsert and multi are true and no documents match the query, the update
operation inserts only a single document."
type: bool
default: false
unstable: false
upsertSupplied:
description: "Only applicable when upsert is true. If set, and if no documents match
the query, the update subsystem will insert the document supplied as
'c.new' rather than generating a new document from the update spec."
type: optionalBool
unstable: false
collation:
description: "Specifies the collation to use for the operation."
type: object
optional: true
unstable: false
DeleteOpEntry:
description: "Parser for the entries in the 'deletes' array of a delete command."
strict: true
fields:
q:
description: "The query that matches documents to delete. Uses the same query
selectors as used in the 'find' operation."
type: object
unstable: false
limit:
description: "The number of matching documents to delete. Value of 0 deletes all
matching documents and 1 deletes a single document."
type: multi_delete_bool
cpp_name: multi
unstable: false
hint:
description: "Specifies the hint to use for the operation."
type: indexHint
default: mongo::BSONObj()
unstable: false
collation:
description: "Specifies the collation to use for the operation."
type: object
optional: true
unstable: false
FindAndModifyLastError:
description: "Contains execution details for the findAndModify command"
fields:
n:
type: int
cpp_name: numDocs
unstable: false
description: "The number of documents that were inserted/deleted or matched the
update predicate."
updatedExisting:
type: bool
description: "Whether an existing document was updated."
optional: true
unstable: false
upserted:
type: IDLAnyTypeOwned
description: "The _id of the inserted document."
optional: true
unstable: false
FindAndModifyCommandReply:
description: "Parser for the response from a `findAndModify` command"
strict: false
fields:
lastErrorObject:
type: FindAndModifyLastError
unstable: false
value:
type: object_owned
optional: true
always_serialize: true
description: "The document after the write, if the 'new' field of the request is
true. Otherwise, the document before the write."
unstable: false
retriedStmtId:
description: "The statement number for this findAndModify statement if it had
already been executed, thus was not executed by this command."
type: int
optional: true
unstable: true
commands:
insert:
description: "Parser for the 'insert' command."
command_name: insert
cpp_name: InsertCommandRequest
strict: true
namespace: concatenate_with_db
api_version: "1"
access_check:
simple:
privilege:
resource_pattern: exact_namespace
action_type: [bypassDocumentValidation, insert]
reply_type: InsertCommandReply
chained_structs:
WriteCommandRequestBase: writeCommandRequestBase
fields:
documents:
description: "An array of one or more documents to insert."
type: array<object>
supports_doc_sequence: true
unstable: false
update:
description: "Parser for the 'update' command."
command_name: update
cpp_name: UpdateCommandRequest
strict: true
namespace: concatenate_with_db
api_version: "1"
access_check:
simple:
privilege:
resource_pattern: exact_namespace
action_type: [bypassDocumentValidation, insert, update]
reply_type: UpdateCommandReply
chained_structs:
WriteCommandRequestBase: writeCommandRequestBase
fields:
updates:
description: "An array of one or more update statements to perform."
type: array<UpdateOpEntry>
supports_doc_sequence: true
unstable: false
let:
description: "A set of user-specified constants used by pipeline-style update
operations and $expr."
type: object
optional: true
unstable: false
runtimeConstants:
description: "A legacy way to specify constant variables available during execution.
'let' is now preferred."
cpp_name: legacyRuntimeConstants
type: LegacyRuntimeConstants
optional: true
unstable: false
delete:
description: "Parser for the 'delete' command."
command_name: delete
cpp_name: DeleteCommandRequest
strict: true
namespace: concatenate_with_db
api_version: "1"
access_check:
simple:
privilege:
resource_pattern: exact_namespace
action_type: [bypassDocumentValidation, remove]
reply_type: DeleteCommandReply
chained_structs:
WriteCommandRequestBase: writeCommandRequestBase
fields:
deletes:
description: "An array of one or more delete statements to perform."
type: array<DeleteOpEntry>
supports_doc_sequence: true
unstable: false
let:
description: "A set of user-specified constants used by $expr."
type: object
optional: true
unstable: false
runtimeConstants:
description: "A legacy way to specify constant variables available during execution.
'let' is now preferred."
cpp_name: legacyRuntimeConstants
type: LegacyRuntimeConstants
optional: true
unstable: false
findAndModify:
description: "Parser for the 'findAndModify' command."
command_name: findAndModify
command_alias: findandmodify
cpp_name: FindAndModifyCommandRequest
strict: true
namespace: concatenate_with_db
api_version: "1"
access_check:
simple:
privilege:
resource_pattern: exact_namespace
action_type: [bypassDocumentValidation, find, insert, update, remove]
reply_type: FindAndModifyCommandReply
fields:
query:
description: "The query that matches documents to update. Uses the same query
selectors as used in the 'find' operation."
type: object_owned
default: mongo::BSONObj()
unstable: false
fields:
description: "A subset of fields to return."
type: object_owned
optional: true
unstable: false
sort:
description: "Determines which document the operation modifies if the query selects
multiple documents."
type: object_owned
optional: true
unstable: false
batchSize:
description: "Determines the batch size."
type: int
optional: true
unstable: false
singleBatch:
description: "Determines if the batch is single."
type: bool
optional: true
unstable: false
hint:
description: "Specifies the hint to use for the operation."
type: indexHint
default: mongo::BSONObj()
unstable: false
collation:
description: "Specifies the collation to use for the operation."
type: object
optional: true
unstable: false
arrayFilters:
description: "Specifies which array elements an update modifier should apply to."
type: array<object>
optional: true
unstable: false
remove:
description: "Removes the document specified in the query field."
# We use 'safeBool' here since the field also allows numeric values.
type: safeBool
optional: true
unstable: false
update:
description: "Modification to apply."
type: update_modification
optional: true
unstable: false
upsert:
description: "If true, perform an insert if no documents match the query. If both
upsert and multi are true and no documents match the query, the update
operation inserts only a single document."
type: safeBool
optional: true
unstable: false
new:
description: "When true, returns the modified document rather than the original."
type: safeBool
optional: true
unstable: false
stmtId:
description: "The statement number for this findAndModify operation."
type: int
optional: true
unstable: false
bypassDocumentValidation:
description: "Enables the operation to bypass document validation. This lets you
write documents that do not meet the validation requirements."
type: safeBool
optional: true
unstable: false
let:
description: "A set of user-specified constants used by pipeline-style update
operations and $expr."
type: object
optional: true
unstable: false
runtimeConstants:
description: "A collection of values that do not change once computed. These are
used by pipeline-style update operations."
cpp_name: legacyRuntimeConstants
type: LegacyRuntimeConstants
optional: true
unstable: false
writeConcern:
description: "Describes the write concern."
type: object
optional: true
unstable: false
|