summaryrefslogtreecommitdiff
path: root/src/mongo/db/commands/create.idl
blob: a824d3ae167c7aa0371915e4fc29237aab2b0819 (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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# Copyright (C) 2019-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/db/commands/create_command_validation.h"

imports:
    - "mongo/db/auth/access_checks.idl"
    - "mongo/db/auth/action_type.idl"
    - "mongo/db/catalog/collection_options.idl"
    - "mongo/db/catalog/clustered_collection_options.idl"
    - "mongo/db/timeseries/timeseries.idl"
    - "mongo/db/pipeline/change_stream_pre_and_post_images_options.idl"

structs:
    CreateCommandReply:
        description: 'Reply from the {create: ...} command'
        strict: true
        fields:
            note:
                description: 'Warnings or other additional information'
                type: string
                optional: true
                unstable: false

commands:
    create:
        description: "Parser for the 'create' Command"
        command_name: create
        namespace: concatenate_with_db
        cpp_name: CreateCommand
        api_version: "1"
        access_check:
            complex:
                - check: should_ignore_auth_checks
                - check: get_single_user # Can be triggered by aggregation
                - check: lookup_user # Can be triggered by aggregation
                - privilege:
                    resource_pattern: exact_namespace
                    action_type: convertToCapped
                - privilege:
                    resource_pattern: exact_namespace
                    action_type: createCollection
                - privilege:
                    resource_pattern: exact_namespace
                    action_type: insert
                - privilege:
                    resource_pattern: exact_namespace
                    action_type: find
                - privilege: # Can be triggered by aggregation
                    resource_pattern: exact_namespace
                    action_type: [remove, update, collStats, indexStats, planCacheRead]
        reply_type: CreateCommandReply
        strict: true
        fields:
            capped:
                description: "Specify true to create a capped collection. If you specify true, you
                              must also set a maximum size in the 'size' field."
                type: safeBool
                default: false
                unstable: false
            autoIndexId:
                description: "Specify false to disable the automatic creation of an index on the
                              _id field."
                type: safeBool
                optional: true
                unstable: true
            idIndex:
                description: "Specify the default _id index specification."
                type: object
                optional: true
                unstable: false
            size:
                description: "Specify a maximum size in bytes for the capped collection."
                type: safeInt64
                optional: true
                validator:
                    gte: 1
                    lte: 1125899906842624  # 1 PB
                unstable: true
            max:
                description: "The maximum number of documents allowed in the capped collection. The
                              'size' limit takes precedence over this limit."
                type: safeInt64
                optional: true
                validator:
                    lt: 2147483648  # 2^31
                unstable: true
            storageEngine:
                description: "Specify a configuration to the storage engine on a per-collection
                              basis when creating a collection."
                type: object
                optional: true
                unstable: true
            validator:
                description: "Specify validation rules or expressions for the collection."
                type: object
                optional: true
                unstable: false
            validationLevel:
                description: "Determines how strictly to apply the validation rules to existing
                              documents during an update.
                              Can be one of following values: 'off', 'strict' or 'moderate'."
                type: ValidationLevel
                optional: true
                unstable: false
            validationAction:
                description: "Determines whether to error on invalid documents or just warn about
                              the violations but allow invalid documents to be inserted.
                              Can be either 'warn' or 'error'."
                type: ValidationAction
                optional: true
                unstable: false
            indexOptionDefaults:
                description: "Allows users to specify a default configuration for indexes when
                              creating a collection."
                type: IndexOptionDefaults
                optional: true
                unstable: true
            viewOn:
                description: "The name of the source collection or view from which to create the
                              view."
                type: string
                optional: true
                unstable: false
                validator:
                    callback: create_command_validation::validateViewOnNotEmpty
            pipeline:
                description: "An array that consists of the aggregation pipeline. Creates the view
                              by applying the specified pipeline to the 'viewOn' collection or
                              view."
                type: array<object>
                optional: true
                unstable: false
            collation:
                description: "Specifies the default collation for the collection or the view."
                type: Collation
                optional: true
                unstable: false
            recordPreImages:
                description: "Sets whether updates/deletes should store the pre-image of the
                              document in the oplog"
                type: safeBool
                optional: true
                unstable: true
            changeStreamPreAndPostImages:
                description: "The options for point-in-time pre- and post-images in change streams opened on this collection."
                type: ChangeStreamPreAndPostImagesOptions
                optional: true
                unstable: true
            timeseries:
                description: "The options to create the time-series collection with."
                type: TimeseriesOptions
                optional: true
                unstable: false
            clusteredIndex:
                description: "Specifies whether this collection should have a clusteredIndex.
                    Boolean is accepted as the legacy clustered index format for specific internal
                    collections - and implies clustering by _id. Otherwise, clusters according to
                    the ClusteredIndexSpec."
                type:
                    variant: [safeBool, ClusteredIndexSpec]
                optional: true
                unstable: false
            expireAfterSeconds:
                description: "The number of seconds after which old data should be deleted."
                type: safeInt64
                optional: true
                unstable: false
            temp:
                description: "DEPRECATED"
                type: safeBool
                optional: true
                unstable: true
            flags:
                description: "DEPRECATED"
                type: safeInt64
                optional: true
                unstable: true