docs(connections): add details about keepAlive deprecation
#13431
Conversation
This file contains hidden or 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
vkarpov15
added
the
docs
vkarpov15
requested review from
Uzlopak,
hasezoey,
AbdelrahmanHafez and
IslandRhythms
AbdelrahmanHafez
approved these changes
May 23, 2023
hasezoey
reviewed
May 24, 2023
|
|
||
| `keepAliveInitialDelay` is the number of milliseconds to wait before initiating `keepAlive` on the socket. | ||
| `keepAlive` is true by default since mongoose 5.2.0. | ||
| Before Mongoose 5.2.0, you needed to enable the `keepAlive` option to initiate [TCP keepalive](https://tldp.org/HOWTO/TCP-Keepalive-HOWTO/overview.html) to prevent `"connection closed"` errors errors. |
There was a problem hiding this comment.
i think double "errors" is not quite right here
|
@vkarpov15 it could be good to add v7 migration guide as well. |
vkarpov15
added a commit
that referenced
this pull request
Nov 12, 2024
vkarpov15
added a commit
that referenced
this pull request
Nov 13, 2024
docs(migrating_to_7): add note about keepAlive to Mongoose 7 migration guide
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Re: #13391
Summary
Quick note about keepAlive deprecation in the most recent release of the MongoDB Node driver. Related reading: https://www.mongodb.com/docs/v7.0/faq/diagnostics/#does-tcp-keepalive-time-affect-mongodb-deployments-, https://jira.mongodb.org/browse/NODE-5190
Examples