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

imports:
  - "mongo/db/basic_types.idl"
  - "mongo/db/pipeline/legacy_runtime_constants.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."
    strict: false
    fields:
      _id:
        type: namespacestring
        description: "The namespace of the collection."
        cpp_name: ns
      collUuid:
        type: uuid
        description: "The UUID of the collection."
        cpp_name: collectionUuid
      startTime:
        type: date
        description: "The time at which query sampling began."
      stopTime:
        type: date
        description: "The time at which query sampling ended."
        optional: true
    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."
      let:
        type: object
        description: "The user-specified constants for the read."
        optional: true

  SampledQueryDocument:
    description: "Represents a document storing a sampled read or write query."
    strict: false
    fields:
      _id:
        type: uuid
        description: "The unique sample id for the read or write."
        cpp_name: sampleId
      ns:
        type: namespacestring
        description: "The namespace of the collection for the read or write."
      collectionUuid:
        type: uuid
        description: "The UUID of the collection for the read or write."
      cmdName:
        type: SampledCommandName
        description: "The command name for the read or write."
      cmd:
        type: object
        description: "The command object for the read or write."
      expireAt:
        type: date
        description: "The time at which the document should be deleted by the TTL monitor."

  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."
      expireAt:
        type: date
        description: "The time at which the document should be deleted by the TTL monitor."

  AnalyzeShardKeySplitPointId:
    description: "Represents the unique id for a document storing one of the split points created
                  by an analyzeShardKey command."
    strict: false
    fields:
      commandId:
        type: uuid
        description: "The unique id for the command that generated this split point."
      splitPointId:
        type: uuid
        description: "The unique id for this split point."

  AnalyzeShardKeySplitPointDocument:
    description: "Represents a document storing one of the split points created by an
                  analyzeShardKey command."
    strict: false
    fields:
      _id:
        type: AnalyzeShardKeySplitPointId
        cpp_name: id
      ns:
        type: namespacestring
      splitPoint:
        type: object
      expireAt:
        type: date
        description: "The time at which the document should be deleted by the TTL monitor."