docs(aggregate): add more info on aggregation changes to upgrade guide #1638
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jlord
approved these changes
Jan 16, 2018
mbroadst
suggested changes
Jan 17, 2018
CHANGES_3.0.0.md
Outdated
| ### `aggregate` | ||
|
|
||
| `Collection.prototype.aggregate` no longer accepts variadic arguments. Pipeline stages | ||
| are now only accepted as an `Array` of stages as the first argument. |
There was a problem hiding this comment.
I think it would be helpful to show before and after images of the input shape here, make it very easy for people to see the difference. Also I think it might pay to explain our rationale for making the change (maintainability, consistency of api, etc)
There was a problem hiding this comment.
probably worth noting that things like this might have been included for shell compatibility
CHANGES_3.0.0.md
Outdated
|
|
||
| `Collection.prototype.aggregate` now returns a cursor if a callback is provided. It used to return | ||
| the resulting documents which is the same as calling `cursor.toArray()` on the cursor we now pass to | ||
| the callback. |
CHANGES_3.0.0.md
Outdated
| @@ -177,7 +173,14 @@ in on the options object . Additionally, `find` does not support individual opti | |||
| `limit` as positional parameters. You must either pass in these parameters in the `options` object, | |||
| or add them via `Cursor` methods like `Cursor.prototype.skip`. | |||
|
|
|||
| ### Aggregation | |||
| ### `aggregate` | |||
There was a problem hiding this comment.
Collection.prototype.aggregate ? Or just Aggregation? I'm not too picky though
daprahamian
force-pushed
the
NODE-1285
branch
from
9d12ac3 to
ff6d176
Compare
|
Updated with feedback from @mbroadst |
mbroadst
reviewed
Jan 18, 2018
CHANGES_3.0.0.md
Outdated
| {$project: {b: 1, _id: 0}} | ||
| ], | ||
| function (err, cursor) { | ||
| console.log(cursor.toArray()); |
There was a problem hiding this comment.
toArray is actually an async function
We now consolidate all notes on aggregation in to a single location in the upgrade guide. We also add a note about how `aggregate` no longer accepts variadic arguments. Fixes NODE-1285
daprahamian
force-pushed
the
NODE-1285
branch
from
ff6d176 to
34cca2c
Compare
mbroadst
approved these changes
Jan 18, 2018
This was referenced Mar 8, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We now consolidate all notes on aggregation in to a single location
in the upgrade guide. We also add a note about how
aggregatenolonger accepts variadic arguments.
Fixes NODE-1285