summaryrefslogtreecommitdiff
path: root/src/mongo/db/list_collections.idl
blob: 68087badf2f6ae2fdcf6628fa0f30060b651c25f (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
# 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/db/auth/access_checks.idl"
    - "mongo/db/auth/action_type.idl"
    - "mongo/db/basic_types.idl"

structs:
    ListCollectionsReplyInfo:
        description: "Information about the collection."
        fields:
            readOnly:
                type: bool
                description: "If true, the data store is read only."
                optional: true
                stability: stable
            uuid:
                type: uuid
                description: "Unique, immutable collection ID."
                optional: true
                stability: stable

    ListCollectionsReplyItem:
        description: "Individual result"
        fields:
            name:
                type: string
                description: "Name of the collection."
                stability: stable
            type:
                type: string
                description: "Type of data store."
                stability: stable
            options:
                type: object_owned
                description: "Collection options."
                optional: true
                stability: stable
            info:
                type: ListCollectionsReplyInfo
                description: "Information about the collection."
                optional: true
                stability: stable
            idIndex:
                type: object_owned
                description: "Provides information on the _id index for the collection."
                optional: true
                stability: stable

    ListCollectionsReplyCursor:
        description: "Cursor object"
        fields:
            id: 
                type: long
                stability: stable
            ns: 
                type: namespacestring
                stability: stable
            firstBatch: 
                type: array<ListCollectionsReplyItem>
                stability: stable

    ListCollectionsReply:
        description: "The listCollection command's reply."
        is_command_reply: true
        fields:
            cursor:
                type: ListCollectionsReplyCursor
                stability: stable

commands:
    listCollections:
        description: "Parser for the listCollections command"
        command_name: listCollections
        namespace: ignored
        cpp_name: listCollections
        strict: true
        api_version: "1"
        access_check:
            complex:
                - check: is_authorized_for_any_action_on_resource
                - check: is_authorized_for_any_action_on_any_resource_in_db
                - check: should_ignore_auth_checks
                - check: check_authorized_to_list_collections
                - privilege:
                    resource_pattern: database
                    action_type: listCollections
        fields:
            cursor:
                type: SimpleCursorOptions
                optional: true
                stability: stable
            filter:
                type: object
                optional: true
                stability: stable
            nameOnly:
                type: bool
                default: false
                stability: stable
            authorizedCollections:
                type: bool
                default: false
                stability: stable
            includePendingDrops:
                type: safeBool
                stability: unstable
                optional: true
        reply_type: ListCollectionsReply