Skip to content

DOCS-12039 Document valid values for cursorTimeoutMillis parameter #3413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 19, 2018
Merged

DOCS-12039 Document valid values for cursorTimeoutMillis parameter #3413

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions source/reference/parameters.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,13 @@ General Parameters

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

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

.. parameter:: failIndexKeyTooLong

.. versionadded:: 2.6
Expand Down