From e9bf55109088468800b9443440ff1fbe748df765 Mon Sep 17 00:00:00 2001 From: Isabella Siu Date: Mon, 10 Sep 2018 16:08:06 -0400 Subject: [PATCH] DOCS-12039 Document valid values for cursorTimeoutMillis parameter --- source/reference/parameters.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/reference/parameters.txt b/source/reference/parameters.txt index fd75708acc5..3f7ee8a5252 100644 --- a/source/reference/parameters.txt +++ b/source/reference/parameters.txt @@ -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