summaryrefslogtreecommitdiff
path: root/src/mongo/db/server_parameter.idl
blob: 999da3747abf8cd3755c6c3d57184130660aa757 (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
# Copyright (C) 2022-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.
#
# IDL constructs useful for all server parameters.

global:
    cpp_namespace: "mongo"

imports:
    - "mongo/db/basic_types.idl"

# Options for the getParameter command. Describes the object "options" when the command is run as 
# {getParameter: <options>}
structs:
  GetParameterOptions:
    description: 'Optional flags to pass to {getParameter: options, ...}'
    fields: 
      showDetails:
        description: 'Return metadata about the server parameter along with its current value'
        type: safeBool
        default: false
      allParameters:
        description: 'Return all server parameters, not just the ones specified'
        type: safeBool
        default: false