Skip to content
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

Add warnings and recommendations to docs about timeout-related connection leaks #729

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

RoganMurley
Copy link
Collaborator

💸 TL;DR

This PR updates the docs with a warning about ServerTimeout exceptions, and a recommendation to avoid SqlAlchemy connection pool leaks until the issue is resolved.

@RoganMurley RoganMurley requested a review from a team as a code owner August 5, 2022 10:22
@@ -52,6 +52,14 @@ request::
Configuration
-------------

.. warning::

:py:class:`sqlalchemy.pool.QueuePool` does not handle `ServerTimeout`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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))

Copy link
Contributor

@KTAtkinson KTAtkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks good +1 to Nate's comment.

@bradengroom bradengroom removed their request for review October 19, 2022 18:11
@KTAtkinson KTAtkinson added the v2.6 Pull requests to be included in v2.6 label Apr 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v2.6 Pull requests to be included in v2.6
Development

Successfully merging this pull request may close these issues.

3 participants