[CDRIVER-2994] Note users must advance cursor returned by aggregate helper to execute pipeline Created: 06/Mar/19  Updated: 28/Oct/23  Resolved: 05/Aug/19

Status: Closed
Project: C Driver
Component/s: docs, libmongoc
Affects Version/s: None
Fix Version/s: 1.15.0

Type: Task Priority: Major - P3
Reporter: Jeremy Mikola Assignee: Isabel Atkinson
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
is related to CDRIVER-2899 Add a database aggregate helper Closed

 Description   

This is something I realized while implementing the db-level aggregate helper in CDRIVER-2899. The current documentation leads users to believe that the pipeline is executed by the helper itself, which is not correct since the returned command cursor is lazy. This is especially pertinent for piplines using an $out stage, as there is typically no reason to advance the cursor (no results are ever returned).

I intend to update the doc blocks for both the db and collection helpers as part of CDRIVER-2899, but this issue can be used to revise mongoc_collection_aggregate.rst.



 Comments   
Comment by Githook User [ 06/Aug/19 ]

Author:

{'name': 'isabelatkinson', 'username': 'isabelatkinson', 'email': 'isabel.atkinson@mongodb.com'}

Message: CDRIVER-2994 update aggregate doc to note user must advance cursor
Branch: cdriver-2873
https://github.com/mongodb/mongo-c-driver/commit/f82e4415aee149e49c1e501d64cddc3113c1a89e

Comment by Githook User [ 05/Aug/19 ]

Author:

{'name': 'isabelatkinson', 'username': 'isabelatkinson', 'email': 'isabel.atkinson@mongodb.com'}

Message: CDRIVER-2994 update aggregate doc to note user must advance cursor
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/f82e4415aee149e49c1e501d64cddc3113c1a89e

Generated at Wed Feb 07 21:16:53 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.