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
|
# 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.
#
global:
cpp_namespace: "mongo"
cpp_includes:
- "mongo/db/logical_session_id.h"
- "mongo/db/query/plan_executor.h"
imports:
- "mongo/db/logical_session_id.idl"
- "mongo/db/pipeline/runtime_constants.idl"
- "mongo/idl/basic_types.idl"
- "mongo/db/query/hint.idl"
types:
yield_policy:
bson_serialization_type: string
description: "The yielding policy of the plan executor"
cpp_type: "PlanExecutor::YieldPolicy"
serializer: "::mongo::PlanExecutor::serializeYieldPolicy"
deserializer: "mongo::PlanExecutor::parseFromBSON"
stmt_id:
bson_serialization_type: int
description: ""
cpp_type: "mongo::StmtId"
deserializer: "mongo::BSONElement::_numberInt"
structs:
DeleteRequest:
description: "Specifies a delete command."
fields:
nsString:
description: "Specifies the namespace string for the delete."
type: namespacestring
hint:
description: "Specifies the hint to use for the delete."
type: object
query:
description: "Specifies the query to use for the delete."
type: object
proj:
description: "Specifies the projection to use for the delete."
type: object
sort:
description: "Specifies the sort to use for the delete."
type: object
collation:
description: "Specifies the collation to use for the delete."
type: object
runtimeConstants:
description: "A collection of values that do not change once computed."
type: RuntimeConstants
optional: true
let:
description: "User-defined constant values to be used within $expr. These can be
specified by the user for each individual element of the 'deletes'
array."
type: object
optional: true
stmtId:
description: "The statement ID for the delete."
type: stmt_id
default: kUninitializedStmtId
multi:
description: "If true, deletes all documents that meet the query criteria. If false,
limits the delete to one document which meets the query criteria."
type: bool
default: false
god:
description: "If true, execute the delete in GodMode."
type: bool
default: false
fromMigrate:
description: ""
type: bool
default: false
isExplain:
description: "If true, running an explain of the delete command."
type: bool
default: false
returnDeleted:
description: "If true, return the deleted documents."
type: bool
default: false
yieldPolicy:
description: "The yielding policy of the plan executor."
type: yield_policy
default: PlanExecutor::NO_YIELD
|
