Skip to content

Commit f3181fb

Browse files
Isabella Siukay-kim
authored andcommitted
DOCS-12039 Document valid values for cursorTimeoutMillis parameter
1 parent 08a248d commit f3181fb

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

source/reference/parameters.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -531,6 +531,13 @@ General Parameters
531531

532532
db.adminCommand( { setParameter: 1, cursorTimeoutMillis: 300000 } )
533533

534+
Setting :parameter:`cursorTimeoutMillis` to less than or equal
535+
to ``0`` results in all cursors being immediately eligible for timeout.
536+
Generally, the timeout value should be greater than the average amount of
537+
time for a query to return results. Use tools like the :method:`cursor.explain()`
538+
cursor modifier to analyze the average query time and select an appropriate
539+
timeout period.
540+
534541
.. parameter:: failIndexKeyTooLong
535542

536543
.. versionadded:: 2.6

0 commit comments

Comments
 (0)