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

structs:
  QueryAnalyzerDocument:
    description: "Represents a document storing the query analyzer configuration for a collection
                  as configured via the configureQueryAnalyzer command."
    fields:
      _id:
        type: uuid
        description: "The UUID of the collection."
        cpp_name: collectionUuid
      ns:
        type: namespacestring
        description: "The namespace of the collection."
    inline_chained_structs: true
    chained_structs:
      QueryAnalyzerConfiguration: configuration

  SampledReadCommand:
    description: "The command object for a sampled read query."
    strict: false
    fields:
      filter:
        type: object
        description: "The filter for the read."
      collation:
        type: object
        description: "The collation for the read."

  SampledReadQueryDocument:
    description: "Represents a document storing a sampled read query."
    strict: false
    fields:
      _id:
        type: uuid
        description: "The unique sample id for the read."
        cpp_name: sampleId
      ns:
        type: namespacestring
        description: "The namespace of the collection for the read."
      collectionUuid:
        type: uuid
        description: "The UUID of the collection for the read."
      cmdName:
        type: SampledReadCommandName
        description: "The command name for the read."
      cmd:
        type: object
        description: "The command object for the read."

  SampledWriteQueryDocument:
    description: "Represents a document storing a sampled write query."
    strict: false
    fields:
      _id:
        type: uuid
        description: "The unique sample id for the write."
        cpp_name: sampleId
      ns:
        type: namespacestring
        description: "The namespace of the collection for the write."
      collectionUuid:
        type: uuid
        description: "The UUID of the collection for the write."
      cmdName:
        type: SampledWriteCommandName
        description: "The command name for the write."
      cmd:
        type: object
        description: "The command object for the write."

  SampledQueryDiffDocument:
    description: "Represents a document storing the diff for a sampled write query."
    strict: false
    fields:
      _id:
        type: uuid
        description: "The unique sample id for the write."
        cpp_name: sampleId
      ns:
        type: namespacestring
        description: "The namespace of the collection for the write."
      collectionUuid:
        type: uuid
        description: "The UUID of the collection for the write."
      diff:
        type: object
        description: "The diff for the write."