summaryrefslogtreecommitdiff
path: root/src/mongo/db/commands/generic_servers.idl
blob: 33b54dc465132063c35cdf3ab9ca66b41750442d (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
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
# Copyright (C) 2021-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"

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

structs:
    featuresReplyJS:
        description: "JS information for features command reply"
        fields:
            utf8:
                # In practice this is always true and exists for BC.
                description: "Scripting engine supports utf8"
                type: bool

    featuresReply:
        description: "Reply to the features command"
        is_command_reply: true
        fields:
            js:
                description: "Status of the scription engine"
                type: featuresReplyJS
                optional: true
            oidMachineOld:
                description: "The previous per-machine nonce, before applying oidReset"
                type: long
                optional: true
            oidMachine:
                description: "The per-machine nonce used in generating ObjectId values"
                type: long

    hostInfoSystemReply:
        description: "hostInfo.system reply fields"
        fields:
            currentTime: date
            hostname: string
            cpuAddrSize: int
            memSizeMB: long
            memLimitMB: long
            numCores: int
            numPhysicalCores: int
            numCpuSockets: int
            cpuArch: string
            numaEnabled: bool
            numNumaNodes: int

    hostInfoOsReply:
        description: "hostInfo.os reply fields"
        fields:
            type: string
            name: string
            version: string

    hostInfoReply:
        description: "Reply to hostInfo command"
        is_command_reply: true
        fields:
            system: hostInfoSystemReply
            os: hostInfoOsReply

            # extra is operating system specific
            extra:
                description: "Extra system information from ProcessInfo"
                type: object

    getCmdLineOptsReply:
        description: "Command line options as passed to the server executable on startup"
        is_command_reply: true
        fields:
            argv: array
            parsed: object

commands:
    features:
        description: "Returns build level feature settings"
        api_version: ""
        command_name: features
        namespace: ignored
        cpp_name: FeaturesCommand
        reply_type: featuresReply
        fields:
            oidReset:
                description: "Regenerate the per-machine nonce used in generating ObjectId values"
                type: safeBool
                optional: true

    hostInfo:
        description: "Returns information about the server's host"
        api_version: ""
        command_name: hostInfo
        namespace: ignored
        cpp_name: HostInfoCommand
        reply_type: hostInfoReply

    getCmdLineOpts:
        description: "Return the command line options used to launch the server"
        api_version: ""
        command_name: getCmdLineOpts
        namespace: ignored
        cpp_name: GetCmdLineOptsCommand
        reply_type: getCmdLineOptsReply

    logRotate:
        description: "Rotate log file(s)"
        api_version: ""
        command_name: logRotate
        namespace: type
        type:
            # Strictly speaking, this should be `string or ignored`,
            # but since we must have a type, we'll assume a non-string value
            # will be of the basic form {logRotate: 1}.
            variant: [safeBool, string]
        cpp_name: LogRotateCommand
        reply_type: OkReply

    getLog:
        description: "Returns most recent log lines from log spooler"
        api_version: ""
        command_name: getLog
        namespace: type
        type: string
        cpp_name: GetLogCommand

    clearLog:
        # Test Only
        description: "Clear the log contents"
        api_version: ""
        command_name: clearLog
        namespace: type
        type: string
        cpp_name: ClearLogCommand
        reply_type: OkReply