summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/dbcheck.idl
blob: 5ded9ce6dafbbb445c8480737e40e593647987df (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
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
# Copyright (C) 2018-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 basic types

global:
  cpp_namespace: "mongo"
  cpp_includes:
    - "mongo/db/repl/dbcheck_idl.h"

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

server_parameters:
    dbCheckHealthLogEveryNBatches:
        description: 'Emit an info-severity health log batch every N batches processed'
        set_at: [ startup, runtime ]
        cpp_vartype: 'AtomicWord<int>'
        cpp_varname: gDbCheckHealthLogEveryNBatches
        default: 25
        validator:
          gte: 1
          lte: 10000

types:
  _id_key:
    bson_serialization_type: any
    description: "An _id value."
    cpp_type: "mongo::BSONKey"
    serializer: "mongo::BSONKey::serializeToBSON"
    deserializer: "mongo::BSONKey::parseFromBSON"

enums:
  OplogEntries:
    description: "The type of dbCheck oplog entry."
    type: string
    values:
      Batch: "batch"
      Collection: "collection"
      Start: "start"
      Stop: "stop"

structs:
  DbCheckSingleInvocation:
    description: "Command object for dbCheck invocation"
    fields:
      dbCheck:
        type: string
        cpp_name: coll
      minKey:
        type: _id_key
        default: "BSONKey::min()"
      maxKey:
        type: _id_key
        default: "BSONKey::max()"
      maxCount:
        type: safeInt64
        default: "std::numeric_limits<int64_t>::max()"
      maxSize:
        type: safeInt64
        default: "std::numeric_limits<int64_t>::max()"
      maxCountPerSecond:
        type: safeInt64
        default: "std::numeric_limits<int64_t>::max()"
      maxDocsPerBatch:
        type: safeInt64
        default: 5000
        validator:
          gte: 1
          lte: 10000
      maxBytesPerBatch:
        type: safeInt64
        default: 20 * 1024 * 1024
        validator:
          gte: 102400
          lte: 268435456
      maxBatchTimeMillis:
        type: safeInt64
        default: 1000
        validator:
          gte: 10
          lte: 20000
      snapshotRead:
        type: safeBool
        default: true
      batchWriteConcern:
        description: Wait for this writeConcern at the end of every batch. Default is w:1 with no timeout.
        type: WriteConcern
        default: WriteConcernOptions()

  DbCheckAllInvocation:
    description: "Command object for database-wide form of dbCheck invocation"
    fields:
      dbCheck:
        type: safeInt64
        cpp_name: tag
      maxCountPerSecond:
        type: safeInt64
        default: "std::numeric_limits<int64_t>::max()"
      maxDocsPerBatch:
        type: safeInt64
        default: 5000
        validator:
          gte: 1
          lte: 10000
      maxBytesPerBatch:
        type: safeInt64
        default: 20 * 1024 * 1024
        validator:
          gte: 102400
          lte: 268435456
      maxBatchTimeMillis:
        type: safeInt64
        default: 1000
        validator:
          gte: 10
          lte: 20000
      snapshotRead:
        type: safeBool
        default: true
      batchWriteConcern:
        description: Wait for this writeConcern at the end of every batch. Default is w:1 with no timeout.
        type: WriteConcern
        default: WriteConcernOptions()

  DbCheckOplogBatch:
    description: "Oplog entry for a dbCheck batch"
    fields:
      dbCheck:
        type: namespacestring
        cpp_name: nss
      type:
        type: OplogEntries
        cpp_name: type
      md5:
        type: string
        cpp_name: md5
      minKey:
        type: _id_key
        cpp_name: minKey
      maxKey:
        type: _id_key
        cpp_name: maxKey
      maxRate:
        type: safeInt64
        optional: true
      readTimestamp:
        type: timestamp
        optional: true

  DbCheckOplogCollection:
    description: "Oplog entry for dbCheck collection metadata"
    fields:
      dbCheck:
        type: namespacestring
        cpp_name: nss
      type:
        type: OplogEntries
        cpp_name: type
      uuid:
        type: uuid
        cpp_name: uuid
      prev:
        optional: true
        type: uuid
        cpp_name: prev
      next:
        optional: true
        type: uuid
        cpp_name: next
      indexes:
        type: array<object>
        cpp_name: indexes
      options:
        type: object
        cpp_name: options

  DbCheckOplogStartStop:
    description: "Oplog entry for dbCheck start and stop"
    fields:
      dbCheck:
        type: namespacestring
        cpp_name: nss
      type:
        type: OplogEntries
        cpp_name: type