[DOCS-10886] AllowPartialResults cursor method not currently documented Created: 10/Oct/17  Updated: 30/Oct/23  Resolved: 14/Apr/20

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

Type: Improvement Priority: Major - P3
Reporter: John Gibbons Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: docs-triage
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
is related to DOCS-13201 Investigate changes in SERVER-43996: ... Closed
Participants:
Days since reply: 3 years, 43 weeks, 1 day ago
Epic Link: DOCSP-1769

 Description   

there is a cursor method called AllowPartialResults.

mongos> db.test.find().allowPartialResults()

this is not documented in the documentation
https://docs.mongodb.com/v3.2/reference/method/js-cursor/
(nor in documentation for 3.4 or 3.6)

it is the replacement for deprecated addOption(DBQuery.Option.partial)

I came across it mentioned by chance in https://jira.mongodb.org/browse/SERVER-27170

but it is not documented.



 Comments   
Comment by Kay Kim (Inactive) [ 14/Apr/20 ]

Ticket slipped through the cracks and the page was actually done as part of DOCS-13201

Apologies and much appreciate the work that you did for the pull request.  You are correct in following the pattern of the other cursor methods.

 

Comment by John Gibbons [ 11/Oct/17 ]

raised PR https://github.com/mongodb/docs/pull/2996

Notes:
./includes/apiargs-dbcommand-find-field.yaml - already had reference to AllowPartialResults
./includes/changelogs/releases/3.4.5.rst - ignored
./includes/ref-toc-method-cursor.yaml - MODIFIED TO ADD reference to AllowPartialResults
./reference/command/find.txt - already had reference to AllowPartialResults
./reference/method/cursor.close.txt - not relevant to AllowPartialResults
./reference/method/cursor.maxTimeMS.txt - not relevant to AllowPartialResults
./reference/method/cursor.noCursorTimeout.txt - not relevant to AllowPartialResults
./reference/mongodb-wire-protocol.txt - already had reference to partial (OP_QUERY)
./tutorial/iterate-a-cursor.txt - no action

Comment by John Gibbons [ 10/Oct/17 ]

I assume that the files to change/create can be guided by the following existing documented cursor method.
$ grep . -rile "nocursortimeout"
./includes/apiargs-dbcommand-find-field.yaml
./includes/changelogs/releases/3.4.5.rst
./includes/ref-toc-method-cursor.yaml
./reference/command/find.txt
./reference/method/cursor.close.txt
./reference/method/cursor.maxTimeMS.txt
./reference/method/cursor.noCursorTimeout.txt
./reference/mongodb-wire-protocol.txt
./tutorial/iterate-a-cursor.txt

Comment by John Gibbons [ 10/Oct/17 ]

i will have a go at fixing the docs on this ....

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