summaryrefslogtreecommitdiff
path: root/src/mongo/db/commands/fle2_get_count_info_command.idl
blob: 2caf9a38816dbd45f7dbf9f4903b212833bc1ac3 (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
# Copyright (C) 2023-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/crypto/fle_stats.idl"

structs:
    ESCPositionsPair:
        description: "A pair of non-anchor and anchor positions"
        strict: true
        fields:
          cpos:
            description: "non-anchor position"
            type: long
          apos:
            description: "anchor position"
            type: long

    ESCOptionalPositionsPair:
        description: "A pair of optional non-anchor and anchor positions"
        strict: true
        fields:
          cpos:
            description: "non-anchor position"
            type: long
            optional: true
          apos:
            description: "anchor position"
            type: long
            optional: true

    QECountInfoReplyTokens:
        description: "A tokens of ESC information"
        strict: true
        fields:
          t:
            description: "ESCTwiceDerivedTagToken"
            type: bindata_generic
            cpp_name: ESCTwiceDerivedTagToken
          c:
            description: "ESC count"
            type: long
            cpp_name: count
          td:
            description: "EDCDerivedFromDataTokenAndContentionFactorToken"
            type: bindata_generic
            cpp_name: EDCDerivedFromDataTokenAndContentionFactorToken
            optional: true
          spos:
            description: "positions returned from emuBinary"
            type: ESCOptionalPositionsPair
            cpp_name: SearchedPositions
            optional: true
          npos:
            description: "position pair retrieved from the null anchor"
            type: ESCPositionsPair
            cpp_name: NullAnchorPositions
            optional: true
          stats:
            description: "stats returned for compaction or cleanup algorithms"
            type: ECStats
            optional: true

    QECountInfoReplyTokenSet:
        description: "Array of tokens sets"
        strict: true
        fields:
            tokens: array<QECountInfoReplyTokens>


    QECountInfoRequestTokens:
        description: "A ESC token to lookup in ESC"
        strict: true
        fields:
            d:
                description: "EDCDerivedFromDataTokenAndContentionFactorToken"
                type: bindata_generic
                cpp_name: EDCDerivedFromDataTokenAndContentionFactorToken
                optional: true
            s:
                description: "ESCDerivedFromDataTokenAndContentionFactorToken"
                type: bindata_generic
                cpp_name: ESCDerivedFromDataTokenAndContentionFactorToken

    QECountInfoRequestTokenSet:
        description: An array of tag sets to lookup
        strict: true
        fields:
            tokens: array<QECountInfoRequestTokens>


    QECountInfosReply:
        description: "Reply from the {getQueryableEncryptionCountInfo: ...} command"
        # MongoS/Txn add fields to the reply we want to ignore
        strict: false
        is_command_reply: true
        fields:
            counts: array<QECountInfoReplyTokenSet>

enums:
    QECountInfoQueryType:
        description: "query types"
        type: string
        values:
            Insert: "insert"
            Query: "query"
            Compact: "compact"
            Cleanup: "cleanup"

commands:
    getQueryableEncryptionCountInfo:
        description: "Parser for the 'getQueryableEncryptionCountInfo' command"
        command_name: getQueryableEncryptionCountInfo
        api_version: ""
        namespace: concatenate_with_db
        strict: true
        reply_type: QECountInfosReply
        fields:
            tokens:
                description: "Array of tokens to fetch"
                type: array<QECountInfoRequestTokenSet>
            queryType:
                description: "Purpose of command, either for insert, query, compact, or cleanup"
                type: QECountInfoQueryType