@@ -183,6 +183,39 @@ Open a Saved Pipeline
183
183
To learn more, see
184
184
:ref:`viewing saved aggregations<saved-query-view>` for details.
185
185
186
+ .. _set-maxtime-ms-agg:
187
+
188
+ Set ``maxTimeMS`` for Aggregation Queries
189
+ -----------------------------------------
190
+
191
+ Use the ``maxTimeMS`` parameter on the :guilabel:`Aggregations` tab to
192
+ specify an upper time limit in milliseconds on the aggregation pipelines
193
+ that run in |compass-short|.
194
+
195
+ To enable ``maxTimeMS`` for aggregation operations:
196
+
197
+ .. procedure::
198
+ :style: normal
199
+
200
+ .. step:: On the :guilabel:`Aggregations` tab, click
201
+ :guilabel:`More Options`.
202
+
203
+ .. figure:: /images/compass/agg-builder-click-more-options.png
204
+ :alt: Toggle more options
205
+
206
+ .. step:: Enter a value next to :guilabel:`Max Time MS` to set a
207
+ maximum amount of time in milliseconds that an aggregation
208
+ pipeline can run. For a ``5`` second limit, enter ``5000``.
209
+
210
+ .. figure:: /images/compass/agg-builder-enter-maxtime-ms.png
211
+ :alt: Enter a maximum timeout value
212
+
213
+ If your aggregation operation goes over the time limit,
214
+ |compass-short| raises the following error:
215
+
216
+ .. figure:: /images/compass/agg-builder-operation-time-limit-error.png
217
+ :alt: Operation timeout error
218
+
186
219
.. _use-sample-mode-or-auto-preview:
187
220
188
221
Set the Documents Limit or Auto Preview Documents
0 commit comments