Skip to content

feat(NODE-4185): Allow opting out of disk use on cursor builder #3230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
baileympearson merged 4 commits into from
May 5, 2022
Merged

feat(NODE-4185): Allow opting out of disk use on cursor builder #3230

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c573bd1
Allow opting out of disk use
lerouxb May 3, 2022
ceec576
tests for allowDiskUse
lerouxb May 4, 2022
641fb92
allowDiskUse was only added in 4.4
lerouxb May 4, 2022
513bcb1
throw if sort is not specified
lerouxb May 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/cursor/find_cursor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,8 +412,15 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
* @remarks
* {@link https://docs.mongodb.com/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation}
*/
allowDiskUse(): this {
allowDiskUse(allow = true): this {
assertUninitialized(this);

// As of 6.0 the default is true. This allows users to get back to the old behaviour.
Comment thread
lerouxb marked this conversation as resolved.
if (!allow) {
this[kBuiltOptions].allowDiskUse = false;
return this;
}

if (!this[kBuiltOptions].sort) {
throw new MongoInvalidArgumentError('Option "allowDiskUse" requires a sort specification');
}
Expand Down