[DOCS-5901] Document new DBQuery helper methods in the shell Created: 24/Jul/15 Updated: 11/Jan/17 Resolved: 11/Dec/15 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 01112017-cleanup |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | David Storch | Assignee: | Ravind Kumar (Inactive) |
| Resolution: | Done | Votes: | 0 |
| Labels: | docs-3.2 | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Participants: | |
| Days since reply: | 8 years, 9 weeks, 2 days ago |
| Description |
|
The returnKey and maxScan options to find are passed using a different format for legacy OP_QUERY find and the find command (new in 3.2). Therefore, passing a literal $returnKey or $maxScan as part of the argument to a .find() is no longer supported in the shell:
Commit ffdb57ed20b introduced cursor.returnKey() and cursor.maxScan() helpers, which are now the official way to set these options. In the 3.2 manual, we should replace the $returnKey documentation (http://docs.mongodb.org/manual/reference/operator/meta/returnKey/) with a page documenting the cursor.returnKey() method. Similarly, we should replace http://docs.mongodb.org/manual/reference/operator/meta/maxScan/ with a page documenting the cursor.maxScan() method. |
| Comments |
| Comment by Githook User [ 14/Dec/15 ] |
|
Author: {u'username': u'rkumar-mongo', u'name': u'ravind', u'email': u'ravind.kumar@10gen.com'}Message: Signed-off-by: kay <kay.kim@10gen.com> |
| Comment by Githook User [ 10/Dec/15 ] |
|
Author: {u'username': u'rkumar-mongo', u'name': u'ravind', u'email': u'ravind.kumar@10gen.com'}Message: Round 3:
Round 2:
Round 1:
Signed-off-by: kay <kay.kim@10gen.com> |
| Comment by David Storch [ 02/Dec/15 ] |
|
We also need to document the new .tailable() helper method. |