Skip to content

Commit 91e0f3f

Browse files
authored
(DOCSP-13657) Update max time ms to 60000 ms, update UI screenshots (#338)
1 parent 412d80f commit 91e0f3f

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

source/images/compass/max-time-ms.png

6.64 KB
Loading
-83.7 KB
Loading

source/query/maxtimems.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Adjust Maximum Time for Query Operations
55
========================================
66

7-
The :guilabel:`MaxTimeMS` query bar option sets the cumulative time
7+
The :guilabel:`MAX TIME MS` query bar option sets the cumulative time
88
limit in milliseconds to process query bar operations. If the time
99
limit is reached before the operation completes, |compass-short|
1010
interrupts the operation.
@@ -13,21 +13,21 @@ interrupts the operation.
1313
:figwidth: 720px
1414
:alt: MaxTimeMS Option
1515

16-
The default :guilabel:`MaxTimeMS` value is ``5000``. Consider raising
17-
this value if you have a very large collection, or your operations
18-
are frequently timing out. You can also consider creating
16+
The default :guilabel:`MAX TIME MS` value is 60000, or 60 seconds.
17+
Consider raising this value if you have a very large collection, or
18+
your operations are frequently timing out. You can also consider creating
1919
:ref:`indexes <compass-indexes>` to improve query performance.
2020

21-
Set MaxTimeMS
22-
-------------
21+
Set MAX TIME MS
22+
---------------
2323

2424
#. Click :guilabel:`Options`.
2525

26-
#. Adjust :guilabel:`MaxTimeMS` to the desired value in milliseconds.
26+
#. Adjust :guilabel:`MAX TIME MS` to the desired value in milliseconds.
2727

2828
Learn More
2929
----------
3030

31-
To learn more about :guilabel:`MaxTimeMS`, see
31+
To learn more about :guilabel:`MAX TIME MS`, see
3232
:manual:`cursor.maxTimeMS() </reference/method/cursor.maxTimeMS/>`
3333
in the MongoDB manual.

source/schema.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -355,21 +355,21 @@ Troubleshooting
355355
If the analysis of your schema times out, it might be because the
356356
collection you are analyzing is very large, causing MongoDB to stop the
357357
operation before the analysis is complete. Increase the value of
358-
``maxTimeMS`` to allow the operation time to complete.
358+
``MAX TIME MS`` to allow the operation time to complete.
359359

360-
To increase the value of ``maxTimeMS``:
360+
To increase the value of :guilabel:`MAX TIME MS`:
361361

362362
1. In the query bar, expand :guilabel:`Options`.
363363

364-
.. figure:: /images/compass/schema-query-options.png
364+
.. figure:: /images/compass/max-time-ms.png
365365
:alt: The Options button is on the right side of the query bar,
366-
next to the green Analyze button.
366+
next to the Analyze button.
367367

368-
2. Increase the value of ``maxTimeMS`` to accommodate your collection.
369-
``maxTimeMS`` defaults to 5000 milliseconds, or 5 seconds, but large
368+
2. Increase the value of :guilabel:`MAX TIME MS` to accommodate your collection.
369+
:guilabel:`MAX TIME MS` defaults to 60000 milliseconds, or 60 seconds, but large
370370
collections might take tens of seconds to analyze.
371371

372-
Once you have increased the value of ``maxTimeMS``, retry your schema
372+
Once you have increased the value of :guilabel:`MAX TIME MS`, retry your schema
373373
analysis by clicking :guilabel:`Analyze`.
374374

375375
.. toctree::

0 commit comments

Comments
 (0)