summaryrefslogtreecommitdiff
path: root/src/mongo/s/analyze_shard_key_common.idl
blob: ee6ba4470c154e3ca381663df235c2691007577c (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
# 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.
#

global:
  cpp_namespace: "mongo"

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

enums:
  QueryAnalyzerMode:
    description: "The query analysis mode for a collection."
    type: string
    values:
      kFull: "full"
      kOff: "off"

structs:
  QueryAnalyzerConfiguration:
    description: "The query analyzer configuration for a collection as configured via the
                  configureQueryAnalyzer command."
    strict: false
    fields:
      mode:
        type: QueryAnalyzerMode
        description: "The query analyzer mode."
      sampleRate:
        type: double
        description: "The maximum number of queries to sample per second, in total across the
                      cluster (not per mongos or mongod)."
        optional: true

  CollectionQueryAnalyzerConfiguration:
    description: "The query analyzer configuration for a collection as returned by the
                  _refreshQueryAnalyzerConfiguration command."
    fields:
      ns:
          type: namespacestring
          description: "The namespace of the collection."
      collectionUuid:
          type: uuid
          description: "The UUID of the collection."
      sampleRate:
        type: double
        description: "The maximum number of queries to sample per second."