Add warnings and recommendations to docs about timeout-related connection leaks #729
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
nsheaps
reviewed
Aug 5, 2022
| @@ -52,6 +52,14 @@ request:: | |||
| Configuration | |||
| ------------- | |||
|
|
|||
| .. warning:: | |||
|
|
|||
| :py:class:`sqlalchemy.pool.QueuePool` does not handle `ServerTimeout` | |||
There was a problem hiding this comment.
Is there a code example of how to do this the right way vs wrong way? That'd be great to include here
(generally I prefer it when saying "Don't do it this way" to guide people through the right way of doing it (though the starting pointers of "do this instead" helps a lot))
KTAtkinson
requested changes
Aug 8, 2022
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.
💸 TL;DR
This PR updates the docs with a warning about
ServerTimeoutexceptions, and a recommendation to avoid SqlAlchemy connection pool leaks until the issue is resolved.