-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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.
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
feat(NODE-6342): support maxTimeMS for explain commands #4207
Merged
+410
−20
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
baileympearson
force-pushed
the
explain-poc
branch
from
August 23, 2024 17:46
0617065
to
665e040
Compare
baileympearson
changed the title
feat: support maxTimeMS for explain commands
feat(NODE-6342): support maxTimeMS for explain commands
Aug 23, 2024
Merged
3 tasks
W-A-James
added
the
Primary Review
In Review with primary reviewer, not yet ready for team's eyes
label
Aug 26, 2024
dariakp
reviewed
Aug 27, 2024
addaleax
reviewed
Sep 11, 2024
W-A-James
requested changes
Sep 13, 2024
W-A-James
previously approved these changes
Sep 13, 2024
W-A-James
added
Team Review
Needs review from team
and removed
Primary Review
In Review with primary reviewer, not yet ready for team's eyes
labels
Sep 13, 2024
nbbeeken
requested changes
Sep 13, 2024
nbbeeken
reviewed
Sep 13, 2024
nbbeeken
approved these changes
Sep 13, 2024
W-A-James
approved these changes
Sep 13, 2024
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.
Description
What is changing?
Explain commands can now have a maxTimeMS specified for them.
Corresponds to mongodb/specifications#1640. The CSOT-related changes for explain helpers will be done in https://jira.mongodb.org/browse/NODE-6375.
Is there new documentation needed for these changes?
No.
What is the motivation for this change?
Release Highlight
Explain now supports maxTimeMS
Driver CRUD commands can be explained by providing the
explain
option:However, if maxTimeMS was provided, the maxTimeMS value was applied to the command to explain, and consequently the server could take more than maxTimeMS to respond.
Now, maxTimeMS can be specified as a new option for explain commands:
If a top-level maxTimeMS option is provided in addition to the explain maxTimeMS, the explain-specific maxTimeMS is applied to the explain command, and the top-level maxTimeMS is applied to the explained command:
Double check the following
npm run check:lint
scripttype(NODE-xxxx)[!]: description
feat(NODE-1234)!: rewriting everything in coffeescript