@@ -59,171 +59,171 @@ The :dbcommand:`aggregate` command takes the following fields as
59
59
arguments:
60
60
61
61
62
- .. list-table::
63
- :header-rows: 1
64
- :widths: 20 20 80
65
-
66
- * - Field
67
-
68
- - Type
69
-
70
- - Description
71
-
72
- * - ``aggregate``
73
-
74
- - string
75
-
76
- - The name of the collection or view that acts as the input for the
77
- aggregation pipeline. Use ``1`` for collection agnostic commands.
78
-
79
-
80
-
81
- * - ``pipeline``
82
-
83
- - array
84
-
85
- - An array of :doc:`aggregation pipeline stages
86
- </reference/operator/aggregation-pipeline>` that process and
87
- transform the document stream as part of the aggregation pipeline.
88
-
89
-
90
-
91
- * - ``explain``
92
-
93
- - boolean
94
-
95
- - Optional. Specifies to return the information on the processing of the pipeline.
96
-
97
- Not available in :doc:`multi-document transactions </core/transactions>`.
98
-
99
-
100
-
101
- * - ``allowDiskUse``
102
-
103
- - boolean
104
-
105
- - Optional. Enables writing to temporary files. When set to ``true``, aggregation
106
- stages can write data to the :file:`_tmp` subdirectory in the
107
- :setting:`~storage.dbPath` directory.
108
-
109
- .. include:: /includes/extracts/4.2-changes-usedDisk.rst
110
-
111
-
112
-
113
- * - ``cursor``
114
-
115
- - document
116
-
117
- - Specify a document that contains options that control the creation
118
- of the cursor object.
119
-
120
- .. versionchanged:: 3.6
121
-
122
- .. include:: /includes/deprecation-aggregate-wo-cursor.rst
123
-
124
-
125
-
126
- * - ``maxTimeMS``
127
-
128
- - non-negative integer
129
-
130
- - Optional. Specifies a time limit in milliseconds for processing
131
- operations on a cursor. If you do not specify a value for maxTimeMS,
132
- operations will not time out. A value of ``0`` explicitly
133
- specifies the default unbounded behavior.
134
-
135
- MongoDB terminates operations that exceed their allotted time limit
136
- using the same mechanism as :method:`db.killOp()`. MongoDB only
137
- terminates an operation at one of its designated :term:`interrupt
138
- points <interrupt point>`.
139
-
140
-
141
-
142
- * - ``bypassDocumentValidation``
143
-
144
- - boolean
145
-
146
- - Optional. Applicable only if you specify the :pipeline:`$out` or :pipeline:`$merge` aggregation
147
- stages.
148
-
149
-
150
-
151
- Enables :samp:`aggregate` to bypass document validation
152
- during the operation. This lets you insert documents that do not
153
- meet the validation requirements.
154
-
155
- .. versionadded:: 3.2
156
-
157
-
158
-
159
- * - ``readConcern``
160
-
161
- - document
162
-
163
- - Optional. Specifies the :term:`read concern`.
164
-
165
- .. include:: /includes/fact-readConcern-syntax.rst
166
-
167
- .. include:: /includes/fact-readConcern-option-description.rst
168
-
169
- .. include:: /includes/extracts/4.2-changes-out-linearizable.rst
170
-
171
- .. include:: /includes/extracts/4.2-changes-linearizable-merge-restriction.rst
172
-
173
-
174
-
175
- * - ``collation``
176
-
177
- - document
178
-
179
- - Optional.
180
-
181
- .. include:: /includes/extracts/collation-option.rst
182
-
183
-
184
-
185
- * - ``hint``
186
-
187
- - string or document
188
-
189
- - Optional. The index to use for the aggregation. The index is on the initial
190
- collection/view against which the aggregation is run.
191
-
192
- Specify the index either by the index name or by the index
193
- specification document.
194
-
195
- .. note::
196
-
197
- The ``hint`` does not apply to :pipeline:`$lookup` and
198
- :pipeline:`$graphLookup` stages.
199
-
200
- .. versionadded:: 3.6
201
-
202
-
203
-
204
- * - ``comment``
205
-
206
- - string
207
-
208
- - Optional. Users can specify an arbitrary string to help trace the operation
209
- through the database profiler, currentOp, and logs.
210
-
211
- .. versionadded:: 3.6
212
-
213
-
214
-
215
- * - ``writeConcern``
216
-
217
- - document
218
-
219
- - Optional. A document that expresses the :doc:`write concern </reference/write-concern>`
220
- to use with the :pipeline:`$out` or :pipeline:`$merge` stage.
221
-
222
- Omit to use the default write concern with the :pipeline:`$out` or
223
- :pipeline:`$merge` stage.
224
-
225
-
226
-
62
+ .. list-table::
63
+ :header-rows: 1
64
+ :widths: 20 20 80
65
+
66
+ * - Field
67
+
68
+ - Type
69
+
70
+ - Description
71
+
72
+ * - ``aggregate``
73
+
74
+ - string
75
+
76
+ - The name of the collection or view that acts as the input for the
77
+ aggregation pipeline. Use ``1`` for collection agnostic commands.
78
+
79
+
80
+
81
+ * - ``pipeline``
82
+
83
+ - array
84
+
85
+ - An array of :doc:`aggregation pipeline stages
86
+ </reference/operator/aggregation-pipeline>` that process and
87
+ transform the document stream as part of the aggregation pipeline.
88
+
89
+
90
+
91
+ * - ``explain``
92
+
93
+ - boolean
94
+
95
+ - Optional. Specifies to return the information on the processing of the pipeline.
96
+
97
+ Not available in :doc:`multi-document transactions </core/transactions>`.
98
+
99
+
100
+
101
+ * - ``allowDiskUse``
102
+
103
+ - boolean
104
+
105
+ - Optional. Enables writing to temporary files. When set to ``true``, aggregation
106
+ stages can write data to the :file:`_tmp` subdirectory in the
107
+ :setting:`~storage.dbPath` directory.
108
+
109
+ .. include:: /includes/extracts/4.2-changes-usedDisk.rst
110
+
111
+
112
+
113
+ * - ``cursor``
114
+
115
+ - document
116
+
117
+ - Specify a document that contains options that control the creation
118
+ of the cursor object.
119
+
120
+ .. versionchanged:: 3.6
121
+
122
+ .. include:: /includes/deprecation-aggregate-wo-cursor.rst
123
+
124
+
125
+
126
+ * - ``maxTimeMS``
127
+
128
+ - non-negative integer
129
+
130
+ - Optional. Specifies a time limit in milliseconds for processing
131
+ operations on a cursor. If you do not specify a value for maxTimeMS,
132
+ operations will not time out. A value of ``0`` explicitly
133
+ specifies the default unbounded behavior.
134
+
135
+ MongoDB terminates operations that exceed their allotted time limit
136
+ using the same mechanism as :method:`db.killOp()`. MongoDB only
137
+ terminates an operation at one of its designated :term:`interrupt
138
+ points <interrupt point>`.
139
+
140
+
141
+
142
+ * - ``bypassDocumentValidation``
143
+
144
+ - boolean
145
+
146
+ - Optional. Applicable only if you specify the :pipeline:`$out` or :pipeline:`$merge` aggregation
147
+ stages.
148
+
149
+
150
+
151
+ Enables :samp:`aggregate` to bypass document validation
152
+ during the operation. This lets you insert documents that do not
153
+ meet the validation requirements.
154
+
155
+ .. versionadded:: 3.2
156
+
157
+
158
+
159
+ * - ``readConcern``
160
+
161
+ - document
162
+
163
+ - Optional. Specifies the :term:`read concern`.
164
+
165
+ .. include:: /includes/fact-readConcern-syntax.rst
166
+
167
+ .. include:: /includes/fact-readConcern-option-description.rst
168
+
169
+ .. include:: /includes/extracts/4.2-changes-out-linearizable.rst
170
+
171
+ .. include:: /includes/extracts/4.2-changes-linearizable-merge-restriction.rst
172
+
173
+
174
+
175
+ * - ``collation``
176
+
177
+ - document
178
+
179
+ - Optional.
180
+
181
+ .. include:: /includes/extracts/collation-option.rst
182
+
183
+
184
+
185
+ * - ``hint``
186
+
187
+ - string or document
188
+
189
+ - Optional. The index to use for the aggregation. The index is on the initial
190
+ collection/view against which the aggregation is run.
191
+
192
+ Specify the index either by the index name or by the index
193
+ specification document.
194
+
195
+ .. note::
196
+
197
+ The ``hint`` does not apply to :pipeline:`$lookup` and
198
+ :pipeline:`$graphLookup` stages.
199
+
200
+ .. versionadded:: 3.6
201
+
202
+
203
+
204
+ * - ``comment``
205
+
206
+ - string
207
+
208
+ - Optional. Users can specify an arbitrary string to help trace the operation
209
+ through the database profiler, currentOp, and logs.
210
+
211
+ .. versionadded:: 3.6
212
+
213
+
214
+
215
+ * - ``writeConcern``
216
+
217
+ - document
218
+
219
+ - Optional. A document that expresses the :doc:`write concern </reference/write-concern>`
220
+ to use with the :pipeline:`$out` or :pipeline:`$merge` stage.
221
+
222
+ Omit to use the default write concern with the :pipeline:`$out` or
223
+ :pipeline:`$merge` stage.
224
+
225
+
226
+
227
227
228
228
229
229
.. include:: /includes/deprecation-aggregate-wo-cursor.rst
0 commit comments