summaryrefslogtreecommitdiff
path: root/src/mongo/s/query/cluster_query_knobs.idl
blob: 2a8a6936234f913c6387a0477728ccebbacba055 (plain)
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
# 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"

server_parameters:
    internalQueryAlwaysMergeOnPrimaryShard:
        description: >-
            If set to true on mongos, all aggregations delivered to the mongos which require a merging shard
            will select the primary shard as the merger. False by default, which means that the merging shard
            will be selected randomly amongst the shards participating in the query. Pipelines capable of
            merging on mongoS are unaffected by this setting, unless internalQueryProhibitMergingOnMongoS is true.
        cpp_vartype: AtomicWord<bool>
        cpp_varname: internalQueryAlwaysMergeOnPrimaryShard
        set_at: [ startup, runtime ]
        default: false
    internalQueryProhibitMergingOnMongoS:
        description: >-
            If set to true on mongos, all aggregations which could otherwise merge on the mongos will be
            obliged to merge on a shard instead. Pipelines which are redirected to the shards will obey the
            value of internalQueryAlwaysMergeOnPrimaryShard. False by default, meaning that pipelines capable
            of merging on mongoS will always do so.
        cpp_vartype: AtomicWord<bool>
        cpp_varname: internalQueryProhibitMergingOnMongoS
        set_at: [ startup, runtime ]
        default: false
    internalQueryDisableExchange:
        description: >-
            If set to true on mongos then the cluster query planner will not produce plans with the exchange.
            False by default, so the queries run with exchanges.
        cpp_vartype: AtomicWord<bool>
        cpp_varname: internalQueryDisableExchange
        set_at: [ startup, runtime ]
        default: false