summaryrefslogtreecommitdiff
path: root/src/mongo/db/list_indexes.idl
blob: 3efc9e02f915bc37e6ad14df32e13d70298b4fbc (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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# Copyright (C) 2020-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"
    cpp_includes:
        - "mongo/util/uuid.h"

imports:
    - "mongo/idl/basic_types.idl"
    - "mongo/db/create_indexes.idl"

structs:
    ListIndexesReplyItem:
        description: "An item in the listIndexes command's reply"
        fields:
            #
            # A built index appears with these fields, which must be the same as NewIndexSpec's
            # fields. The "key" and "name" fields are required for built indexes, but marked
            # optional to allow the in-progress index build format using the fields below.
            #
            v:
                type: safeInt
                optional: true
            key:
                type: object_owned
                optional: true
            name:
                type: string
                optional: true
            ns:
                # MongoDB 4.2 and older generate this field, see SERVER-41696.
                type: string
                ignore: true
            background:
                type: safeBool
                optional: true
            unique:
                type: safeBool
                optional: true
            hidden:
                type: safeBool
                optional: true
            partialFilterExpression:
                type: object_owned
                optional: true
            sparse:
                type: safeBool
                optional: true
            expireAfterSeconds:
                type: safeInt
                optional: true
            storageEngine:
                type: object_owned
                optional: true
            weights:
                type:
                    variant: [string, object_owned]
                optional: true
            default_language:
                type: string
                optional: true
            language_override:
                type: string
                optional: true
            textIndexVersion:
                type: safeInt
                optional: true
            2dsphereIndexVersion:
                type: safeInt
                optional: true
            bits:
                type: safeInt
                optional: true
            min:
                type: safeDouble
                optional: true
            max:
                type: safeDouble
                optional: true
            bucketSize:
                type: safeDouble
                optional: true
            collation:
                type: object_owned
                optional: true
            wildcardProjection:
                type: object_owned
                optional: true
            coarsestIndexedLevel:
                type: safeInt
                optional: true
            finestIndexedLevel:
                type: safeInt
                optional: true
            dropDups:
                type: safeBool
                optional: true
            #
            # An index build in progress appears with these two fields. They're required, but marked
            # optional to permit the built index format using the fields above instead.
            #
            buildUUID:
                type: uuid
                optional: true
            spec:
                type: NewIndexSpec
                optional: true

    ListIndexesReplyCursor:
        description: "Cursor object"
        fields:
            id: long
            ns: namespacestring
            firstBatch: array<ListIndexesReplyItem>

    ListIndexesReply:
        description: "The listIndexes command's reply."
        fields:
            cursor: ListIndexesReplyCursor
            # Included so mongos can parse shards' listIndexes replies.
            ok:
                type: safeDouble
                validator: { gte: 0.0, lte: 1.0 }
                optional: true

commands:
    listIndexes:
        description: "Parser for the listIndexes command"
        command_name: listIndexes
        namespace: concatenate_with_db_or_uuid
        cpp_name: listIndexes
        strict: true
        api_version: "1"
        fields:
            cursor:
                type: SimpleCursorOptions
                optional: true
            includeBuildUUIDs:
                type: safeBool
                optional: true
                unstable: true
        reply_type: ListIndexesReply