summaryrefslogtreecommitdiff
path: root/src/mongo/crypto/fle_options.idl
blob: f21eacf8a7c4e2e86cd977b07ae0dcd98adad699 (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
#    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/idl/cluster_server_parameter.idl"

structs:
  FLECompactionOptions:
    description: "Options related to compaction or cleanup operations in Queryable Encryption
        protocol version 2"
    inline_chained_structs: true
    chained_structs:
      ClusterServerParameter: clusterServerParameter
    fields:
      maxCompactionSize:
        description: "Limits the total size of the set of ESC documents that will be removed by
            each compactStructuredEncryptionData operation"
        type: int
        default: 268435456 # 256 MB
        validator:
          gt: 0
      maxESCEntriesPerCompactionDelete:
        description: "Limits the number of ESC non-anchor documents that will be removed by each
            delete operation performed by the compactStructuredEncryptionData operation"
        type: int
        default: 350000
        validator:
          gt: 0
          lte: 350000 # Limit the tags in the $in query to just under 15 MB per request

server_parameters:
  unsupportedDangerousTestingFLEDiagnosticsEnabled:
    description: 'Start with test-only FLE statistics behavior enabled'
    set_at: startup
    cpp_vartype: bool
    cpp_varname: gUnsupportedDangerousTestingFLEDiagnosticsEnabledAtStartup
    default: false
  fleCompactionOptions:
    description: "Options related to compaction or cleanup operations in Queryable Encryption
        protocol version 2"
    set_at: cluster
    cpp_varname: "fleCompactionOptions"
    cpp_vartype: FLECompactionOptions