forked from mongodb/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiargs-dbcommand-create-field.yaml
180 lines (164 loc) · 3.8 KB
/
apiargs-dbcommand-create-field.yaml
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
arg_name: field
description: |
The name of the new collection.
interface: dbcommand
name: create
operation: create
optional: false
position: 1
type: string
---
arg_name: field
interface: dbcommand
name: capped
operation: create
position: 2
source:
file: apiargs-method-db.createCollection-options-param.yaml
ref: capped
---
arg_name: field
interface: dbcommand
name: autoIndexId
operation: create
position: 3
source:
file: apiargs-method-db.createCollection-options-param.yaml
ref: autoIndexId
---
arg_name: field
interface: dbcommand
name: size
operation: create
optional: true
position: 4
source:
file: apiargs-method-db.createCollection-options-param.yaml
ref: size
type: integer
---
arg_name: field
interface: dbcommand
name: max
operation: create
position: 5
source:
file: apiargs-method-db.createCollection-options-param.yaml
ref: max
type: integer
---
arg_name: field
description: |
Available for the MMAPv1 storage engine only to set the
:collflag:`usePowerOf2Sizes` and the :collflag:`noPadding` flags. To
set, specify one of the following values:
.. include:: /includes/list-collection-user-flags.rst
Defaults to ``1``.
.. versionadded:: 2.6
.. versionchanged:: 3.0.0
Add support for setting the new :collflag:`noPadding` flag.
.. warning::
Do not set ``noPadding`` if the workload includes removes or any
updates that may cause documents to grow. For more information,
see :ref:`exact-fit-allocation`.
interface: dbcommand
name: flags
operation: create
optional: true
position: 6
type: integer
---
arg_name: field
interface: dbcommand
name: storageEngine
operation: create
position: 7
source:
file: apiargs-method-db.createCollection-options-param.yaml
ref: storageEngine
type: document
---
name: validator
source:
file: apiargs-method-db.createCollection-options-param.yaml
ref: validator
arg_name: field
interface: dbcommand
operation: create
position: 8
---
name: validationLevel
source:
file: apiargs-method-db.createCollection-options-param.yaml
ref: validationLevel
arg_name: field
interface: dbcommand
operation: create
position: 9
---
name: validationAction
source:
file: apiargs-method-db.createCollection-options-param.yaml
ref: validationAction
arg_name: field
interface: dbcommand
operation: create
position: 10
---
name: indexOptionDefaults
source:
file: apiargs-method-db.createCollection-options-param.yaml
ref: indexOptionDefaults
arg_name: field
interface: dbcommand
operation: create
position: 11
---
name: viewOn
source:
file: apiargs-method-db.createView-param.yaml
ref: source
arg_name: field
interface: dbcommand
operation: create
position: 12
post: |
See also :method:`db.createView()`.
.. versionadded:: 3.4
---
name: pipeline
source:
file: apiargs-method-db.createView-param.yaml
ref: pipeline
arg_name: field
interface: dbcommand
operation: create
position: 13
replacement:
source: "``viewOn`` collection or view"
op: ":dbcommand:`create`"
post: |
See also :method:`db.createView()`.
.. versionadded:: 3.4
---
name: collation
description: |
Specifies the default :ref:`collation <collation>` for the
collection or the view.
.. include:: /includes/extracts/collation-description.rst
.. include:: /includes/extracts/collation-option-specification.rst
.. include:: /includes/extracts/collation-collection-level.rst
.. include:: /includes/extracts/collation-unspecified.rst
.. include:: /includes/extracts/views-collation-behavior.rst
After you create the collection or the view, you cannot update its
default collation.
For an example that specifies the default collation during the
creation of a collection, see {{example}}.
.. versionadded:: 3.4
arg_name: field
interface: dbcommand
operation: create
position: 14
replacement:
example: ":ref:`create-collation-example`"
...