[DOCS-13201] Investigate changes in SERVER-43996: Make the router return flag in response to indicate if partial results were returned Created: 06/Nov/19  Updated: 13/Nov/23  Due: 10/Apr/20  Resolved: 14/Apr/20

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

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Kay Kim (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-43996 Make the router return flag in respon... Closed
Related
related to DOCS-10886 AllowPartialResults cursor method not... Closed
is related to DRIVERS-786 Make the router return flag in respon... Backlog
is related to DRIVERS-801 Make the router return flag in respon... Closed
Participants:
Days since reply: 3 years, 43 weeks, 1 day ago
Epic Link: DOCS: 4.4 Server Release Work

 Description   

Description

Downstream Change Summary

The "allowPartialResults" option of the "find" command permits a query to run on a sharded cluster even in cases where some of the shards are not available. In this case, the results will consist of the subset of data present on the available shards. However, until now there was no way for a client to know whether the data they received was complete or partial.

This change adds a new field, "partialResultsReturned", in the "cursor" object returned to the client by the "find" and "getMore" commands. In the event that some of the shards are not available at the time the query is run, or if some shards disconnect while the cursor is being iterated, this field will be present and will have a boolean value of true. If all shards are available, the field will be absent.

This flag is scoped to the cursor, not to an individual operation; all getMores after the point where a shard disconnects will be flagged as "partialResultsReturned".

Description of Linked Ticket

Right now, a user can opt in to getting partial results (that is, ignoring unreachable shards) by passing allowPartialResults: true  in their find command.

However, they have no way to tell if partial results were actually returned.

This ticket is to make mongos return a flag in its response if partial results were returned.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

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



 Comments   
Comment by Githook User [ 14/Apr/20 ]

Author:

{'name': 'Kay Kim', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}

Message: DOCS-13201: fix typos in last commit
Branch: master
https://github.com/mongodb/docs/commit/85e3f7c4ebfc46d82cad9ada45c0f785a86e5887

Comment by Githook User [ 14/Apr/20 ]

Author:

{'name': 'Kay Kim', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}

Message: DOCS-13201: 4.4 cursor partial results for sharded collection
Branch: master
https://github.com/mongodb/docs/commit/4a15831d22f79ea1309d929028ae477d3588dbc9

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