summaryrefslogtreecommitdiff
path: root/src/mongo/s/catalog/type_index_catalog.idl
blob: b7f24760a93e49c83e5fe69d5bb24d8b0b0119ac (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
# 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/idl/basic_types.idl"

structs:
    IndexCatalogType:
        description: "Represents the layout and contents of documents contained in the 
                    config.shard.indexes and config.csrs.indexes collections"
        strict: false
        fields:
            name:
                type: string
                description: "Index name"
            keyPattern:
                type: object
                description: "Index field description"
            options:
                type: object
                description: "Index options"
            lastmod:
                type: timestamp
                description: "Index version"
            collectionUUID:
                type: uuid
                description: "UUID of the collection"
            indexCollectionUUID:
                type: uuid
                description: "UUID of the collection which backs this index. If there
                            is not indexCollectionUUID then the index is not global."
                optional: true