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
|
# Copyright (C) 2019-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/platform/atomic_proxy.h"
- "mongo/platform/atomic_word.h"
server_parameters:
#
# multi-plan ranking
#
internalQueryPlanEvaluationWorks:
description: "Max number of times we call work() on plans before comparing them, for small collections."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryPlanEvaluationWorks"
cpp_vartype: AtomicWord<int>
default: 10000
validator:
gt: 0
internalQueryPlanEvaluationCollFraction:
description: "For large collections, the number times we work() candidate plans is taken as this fraction of the collection size."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryPlanEvaluationCollFraction"
cpp_vartype: AtomicDouble
default: 0.3
validator:
gte: 0.0
lte: 1.0
internalQueryPlanEvaluationMaxResults:
description: "Stop working plans once a plan returns this many results."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryPlanEvaluationMaxResults"
cpp_vartype: AtomicWord<int>
default: 101
validator:
gte: 0
internalQueryForceIntersectionPlans:
description: "Do we give a big ranking bonus to intersection plans?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryForceIntersectionPlans"
cpp_vartype: AtomicWord<bool>
default: false
internalQueryPlannerEnableIndexIntersection:
description: "Do we have ixisect on at all?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryPlannerEnableIndexIntersection"
cpp_vartype: AtomicWord<bool>
default: true
internalQueryPlannerEnableHashIntersection:
description: "Do we use hash-based intersection for rooted $and queries?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryPlannerEnableHashIntersection"
cpp_vartype: AtomicWord<bool>
default: false
#
# Plan cache
#
internalQueryCacheSize:
description: "How many entries in the cache?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryCacheSize"
cpp_vartype: AtomicWord<int>
default: 5000
validator:
gte: 0
internalQueryCacheFeedbacksStored:
description: "How many feedback entries do we collect before possibly evicting from the cache based on bad performance?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryCacheFeedbacksStored"
cpp_vartype: AtomicWord<int>
default: 20
validator:
gte: 0
internalQueryCacheEvictionRatio:
description: "How many times more works must we perform in order to justify plan cache eviction and replanning?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryCacheEvictionRatio"
cpp_vartype: AtomicDouble
default: 10.0
validator:
gte: 0.0
internalQueryCacheWorksGrowthCoefficient:
description: "How quickly the the 'works' value in an inactive cache entry will grow. It grows exponentially. The value of this server parameter is the base."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryCacheWorksGrowthCoefficient"
cpp_vartype: AtomicDouble
default: 2.0
validator:
gt: 1.0
internalQueryCacheDisableInactiveEntries:
description: "Whether or not cache entries can be marked as 'inactive'."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryCacheDisableInactiveEntries"
cpp_vartype: AtomicWord<bool>
default: false
#
# Planning and enumeration
#
internalQueryPlannerMaxIndexedSolutions:
description: "How many indexed solutions will QueryPlanner::plan output?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryPlannerMaxIndexedSolutions"
cpp_vartype: AtomicWord<int>
default: 64
validator:
gte: 0
internalQueryEnumerationMaxOrSolutions:
description: "How many solutions will the enumerator consider at each OR?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryEnumerationMaxOrSolutions"
cpp_vartype: AtomicWord<int>
default: 10
validator:
gte: 0
internalQueryEnumerationMaxIntersectPerAnd:
description: "How many intersections will the enumerator consider at each AND?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryEnumerationMaxIntersectPerAnd"
cpp_vartype: AtomicWord<int>
default: 3
validator:
gte: 0
internalQueryPlanOrChildrenIndependently:
description: "Do we want to plan each child of the OR independently?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryPlanOrChildrenIndependently"
cpp_vartype: AtomicWord<bool>
default: true
internalQueryMaxScansToExplode:
description: "How many index scans are we willing to produce in order to obtain a sort order during explodeForSort?"
set_at: [ startup, runtime ]
cpp_varname: "internalQueryMaxScansToExplode"
cpp_vartype: AtomicWord<int>
default: 200
validator:
gte: 0
internalQueryPlannerGenerateCoveredWholeIndexScans:
description: "Allow the planner to generate covered whole index scans, rather than falling back to a COLLSCAN."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryPlannerGenerateCoveredWholeIndexScans"
cpp_vartype: AtomicWord<bool>
default: false
internalQueryIgnoreUnknownJSONSchemaKeywords:
description: "Ignore unknown JSON Schema keywords."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryIgnoreUnknownJSONSchemaKeywords"
cpp_vartype: AtomicWord<bool>
default: false
#
# Query execution
#
internalQueryMaxBlockingSortMemoryUsageBytes:
description: "The maximum amount of memory a query (e.g. a find or aggregate command) is willing
to use to execute a blocking sort, measured in bytes. If disk use is allowed, then it may be
possible to sort more data, but this limit will still constrain the memory consumption."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryMaxBlockingSortMemoryUsageBytes"
cpp_vartype: AtomicWord<int>
default:
expr: 100 * 1024 * 1024
validator:
gte: 0
internalQueryExecYieldIterations:
description: "Yield after this many \"should yield?\" checks."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryExecYieldIterations"
cpp_vartype: AtomicWord<int>
default: 128
internalQueryExecYieldPeriodMS:
description: "Yield if it's been at least this many milliseconds since we last yielded."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryExecYieldPeriodMS"
cpp_vartype: AtomicWord<int>
default: 10
validator:
gte: 0
internalQueryFacetBufferSizeBytes:
description: "The number of bytes to buffer at once during a $facet stage."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryFacetBufferSizeBytes"
cpp_vartype: AtomicWord<int>
default:
expr: 100 * 1024 * 1024
validator:
gt: 0
internalLookupStageIntermediateDocumentMaxSizeBytes:
description: "Maximum size of the result set that we cache from the foreign collection during a $lookup."
set_at: [ startup, runtime ]
cpp_varname: "internalLookupStageIntermediateDocumentMaxSizeBytes"
cpp_vartype: AtomicWord<long long>
default:
expr: 100 * 1024 * 1024
validator:
gte: { expr: BSONObjMaxInternalSize}
internalDocumentSourceGroupMaxMemoryBytes:
description: "Maximum size of the data that the $group aggregation stage will cache in-memory before spilling to disk."
set_at: [ startup, runtime ]
cpp_varname: "internalDocumentSourceGroupMaxMemoryBytes"
cpp_vartype: AtomicWord<long long>
default:
expr: 100 * 1024 * 1024
validator:
gt: 0
internalInsertMaxBatchSize:
description: "Maximum number of documents that we will insert in a single batch."
set_at: [ startup, runtime ]
cpp_varname: "internalInsertMaxBatchSize"
cpp_vartype: AtomicWord<int>
default:
expr: internalQueryExecYieldIterations.load() / 2
is_constexpr: false
validator:
gt: 0
internalDocumentSourceCursorBatchSizeBytes:
description: "Maximum amount of data that DocumentSourceCursor will cache from the underlying PlanExecutor before pipeline processing."
set_at: [ startup, runtime ]
cpp_varname: "internalDocumentSourceCursorBatchSizeBytes"
cpp_vartype: AtomicWord<int>
default:
expr: 4 * 1024 * 1024
validator:
gte: 0
internalDocumentSourceLookupCacheSizeBytes:
description: "Maximum amount of non-correlated foreign-collection data that the $lookup stage will cache before abandoning the cache and executing the full pipeline on each iteration."
set_at: [ startup, runtime ]
cpp_varname: "internalDocumentSourceLookupCacheSizeBytes"
cpp_vartype: AtomicWord<int>
default:
expr: 100 * 1024 * 1024
validator:
gte: 0
internalQueryProhibitBlockingMergeOnMongoS:
description: "If true, blocking stages such as $group or non-merging $sort will be prohibited from running on mongoS."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryProhibitBlockingMergeOnMongoS"
cpp_vartype: AtomicWord<bool>
default: false
internalQueryAllowShardedLookup:
description: "If true, activates the incomplete sharded $lookup feature."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryAllowShardedLookup"
cpp_vartype: AtomicWord<bool>
default: false
internalQueryMaxJsEmitBytes:
description: "Limits the vector of values emitted from a single document's call to JsEmit to the
given size in bytes."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryMaxJsEmitBytes"
cpp_vartype: AtomicWord<int>
default:
expr: 100 * 1024 * 1024
validator:
gt: 0
internalQueryMaxPushBytes:
description: "Limits the vector of values pushed into a single array while grouping with the
$push accumulator."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryMaxPushBytes"
cpp_vartype: AtomicWord<int>
default:
expr: 100 * 1024 * 1024
validator:
gt: 0
internalQueryMaxAddToSetBytes:
description: "Limits the vector of values pushed into a single array while grouping with the
$addToSet accumulator."
set_at: [ startup, runtime ]
cpp_varname: "internalQueryMaxAddToSetBytes"
cpp_vartype: AtomicWord<int>
default:
expr: 100 * 1024 * 1024
validator:
gt: 0
|