[DOCS-12039] Document valid values for cursorTimeoutMillis parameter Created: 07/Sep/18  Updated: 30/Oct/23  Resolved: 19/Sep/18

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Improvement Priority: Major - P3
Reporter: Kevin Pulo Assignee: Isabella Siu (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to SERVER-34952 Require validators for non-boolean se... Closed
Participants:
Days since reply: 5 years, 21 weeks ago
Epic Link: DOCSP-1769

 Description   

Description

The docs for the cursorTimeoutMillis parameter don't specify the range of valid/useful values (since the server currently accepts any numerical value, see SERVER-34952). Specifically it should call out that:

  • values <= 0 are not generally useful because they cause cursors to be immediately eligible for timeout, and
  • the value of 0 does not mean to use the default value.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 19/Sep/18 ]

Author:

{'name': 'Isabella Siu', 'email': 'isabellasiu@Isabellas-MacBook.local'}

Message: DOCS-12039 Document valid values for cursorTimeoutMillis parameter
Branch: v3.2
https://github.com/mongodb/docs/commit/1139206908ef2d033784dc1b202fb3e9f1790cd1

Comment by Githook User [ 19/Sep/18 ]

Author:

{'name': 'Isabella Siu', 'email': 'isabellasiu@Isabellas-MacBook.local'}

Message: DOCS-12039 Document valid values for cursorTimeoutMillis parameter
Branch: v3.4
https://github.com/mongodb/docs/commit/d6b857352e782ae2ad1f09da9a31a06b50bf1bd2

Comment by Githook User [ 19/Sep/18 ]

Author:

{'name': 'Isabella Siu', 'email': 'isabellasiu@Isabellas-MacBook.local'}

Message: DOCS-12039 Document valid values for cursorTimeoutMillis parameter
Branch: v3.6
https://github.com/mongodb/docs/commit/e6226d009cdd839553f3abdf93fcf54db3b23afe

Comment by Githook User [ 19/Sep/18 ]

Author:

{'name': 'Isabella Siu', 'email': 'isabellasiu@Isabellas-MacBook.local'}

Message: DOCS-12039 Document valid values for cursorTimeoutMillis parameter
Branch: master
https://github.com/mongodb/docs/commit/f3181fb2f094df48925533a7c023e361753fb5b5

Generated at Thu Feb 08 08:04:15 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.