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
|
# 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.
#
# This IDL file describes the BSON format for find command. Note that the legacy OP_MSG request
# parameters are not represented in the structre.
global:
cpp_namespace: "mongo"
cpp_includes:
- "mongo/db/namespace_string.h"
- "mongo/db/query/max_time_ms_parser.h"
imports:
- "mongo/crypto/fle_field_schema.idl"
- "mongo/db/auth/action_type.idl"
- "mongo/db/auth/access_checks.idl"
- "mongo/db/session/logical_session_id.idl"
- "mongo/db/pipeline/legacy_runtime_constants.idl"
- "mongo/db/basic_types.idl"
- "mongo/db/query/cursor_response.idl"
- "mongo/db/query/hint.idl"
types:
boolNoOpSerializer:
bson_serialization_type: any
description: "Bool data type field which doesn't produce any data when serialized."
cpp_type: "bool"
deserializer: "::mongo::parseBoolean"
serializer: "::mongo::noOpSerializer"
object_owned_nonempty_serialize:
bson_serialization_type: any
description: "An owned BSONObj, which gets serialized only when the BSON is not empty.
The object is ignored if empty, null or missing."
cpp_type: "mongo::BSONObj"
serializer: "::mongo::serializeBSONWhenNotEmpty"
deserializer: "::mongo::parseOwnedBSON"
default: mongo::BSONObj()
maxTimeMS:
bson_serialization_type: any
description: "An int representing max time ms."
cpp_type: "std::int32_t"
deserializer: "::mongo::parseMaxTimeMSForIDL"
commands:
find:
cpp_name: FindCommandRequest
command_name: find
description: "A struct representing the find command"
strict: true
namespace: concatenate_with_db_or_uuid
non_const_getter: true
api_version: "1"
access_check:
complex:
- check: is_authorized_to_parse_namespace_element
- privilege:
resource_pattern: exact_namespace
action_type: find
- privilege:
resource_pattern: cluster
action_type: useUUID
reply_type: CursorInitialReply
fields:
filter:
description: "The query predicate. If unspecified, then all documents in the collection
will match the predicate."
type: object_owned_nonempty_serialize
stability: stable
projection:
description: "The projection specification to determine which fields to include in the
returned documents."
type: object_owned_nonempty_serialize
stability: stable
sort:
description: "The sort specification for the ordering of the results."
type: object_owned_nonempty_serialize
stability: stable
hint:
description: "Specify either the index name as a string or the index key pattern. If
specified, then the query system will only consider plans using the hinted index."
type: indexHint
default: mongo::BSONObj()
stability: stable
collation:
description: "Specifies the collation to use for the operation."
type: object_owned_nonempty_serialize
stability: stable
skip:
description: "Number of documents to skip."
type: safeInt64
optional: true
validator: { gte: 0 }
stability: stable
limit:
description: "The maximum number of documents to return."
type: safeInt64
optional: true
validator: { gte: 0 }
stability: stable
batchSize:
description: "The number of documents to return in the first batch."
type: safeInt64
optional: true
validator: { gte: 0 }
stability: stable
singleBatch:
description: "Determines whether to close the cursor after the first batch."
type: optionalBool
stability: stable
allowDiskUse:
description: "Use allowDiskUse to allow MongoDB to use temporary files on disk to store
data exceeding the 100 megabyte memory limit while processing a blocking sort operation."
type: optionalBool
stability: stable
min:
description: "The inclusive lower bound for a specific index."
type: object_owned_nonempty_serialize
stability: unstable
max:
description: "The exclusive upper bound for a specific index."
type: object_owned_nonempty_serialize
stability: unstable
returnKey:
description: "If true, returns only the index keys in the resulting documents."
type: optionalBool
stability: unstable
showRecordId:
description: "Determines whether to return the record identifier for each document."
type: optionalBool
stability: unstable
$queryOptions:
description: "Deprecated. A mechanism to specify readPreference."
cpp_name: unwrappedReadPref
type: object_owned_nonempty_serialize
stability: unstable
tailable:
description: "Returns a tailable cursor for a capped collections."
type: optionalBool
stability: unstable
oplogReplay:
description: "Deprecated. An internal command for replaying a replica set’s oplog."
type: boolNoOpSerializer
optional: true
stability: unstable
noCursorTimeout:
description: "Prevents the server from timing out idle cursors after an inactivity period."
type: optionalBool
stability: unstable
awaitData:
description: "Use in conjunction with the tailable option to block a getMore command on the
cursor temporarily if at the end of data rather than returning no data."
type: optionalBool
stability: unstable
allowPartialResults:
description: "For queries against a sharded collection, allows the command (or subsequent
getMore commands) to return partial results, rather than an error, if one or more queried
shards are unavailable."
type: optionalBool
stability: stable
let:
description: "Allows user defined variables to be used inside $expr."
type: object_owned
optional: true
stability: stable
term:
description: "Deprecated."
type: safeInt64
optional: true
stability: unstable
readOnce:
description: "Deprecated."
type: optionalBool
stability: unstable
allowSpeculativeMajorityRead:
description: "Deprecated."
type: optionalBool
stability: unstable
$_requestResumeToken:
description: "Deprecated."
cpp_name: requestResumeToken
type: optionalBool
stability: unstable
$_resumeAfter:
description: "Deprecated."
cpp_name: resumeAfter
type: object_owned_nonempty_serialize
default: mongo::BSONObj()
stability: unstable
maxTimeMS:
description: "The cumulative time limit in milliseconds for processing operations on the
cursor."
type: maxTimeMS
optional: true
validator: { gte: 0 }
stability: stable
readConcern:
description: "Specifies the read concern."
type: object_owned
optional: true
stability: stable
runtimeConstants:
description: "A collection of values that do not change once computed."
cpp_name: legacyRuntimeConstants
type: LegacyRuntimeConstants
optional: true
stability: unstable
collectionUUID:
description: "The expected UUID of the collection."
type: uuid
optional: true
stability: unstable
encryptionInformation:
description: "Encryption Information schema and other tokens for CRUD commands"
type: EncryptionInformation
optional: true
stability: unstable
mirrored:
description: "Indicates whether the operation is a mirrored read"
type: optionalBool
stability: unstable
|
