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

[Doc] clarified the usage of and settings #169

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

andsel
Copy link
Contributor

@andsel andsel commented May 17, 2024

Release notes

Clarified the usage of jdbc_validation_timeout and connection_retry_attempts_wait_time settings.

What does this PR do?

Improve the documentation description of a couple of configs.
The connection_retry_attempts_wait_time is used as retry mechanism only at Sequel Database object creation, so at connection pool time creation, during the registration of the plugin.
The jdbc_validation_timeout is used by Sequel to decide to validate or not a connection when it's borrowed from the pool. If the connection hasn't received or sent data for more than this timeout then a "ping query" is executed; but it doesn't actively executes the ping queries when the connections are in the pool, just on the borrow action.

  • code ref to check how connection_retry_attempts_wait_time is used
  • code ref to check how jdbc_validation_timeout is used in Sequel.

Why is it important/What is the impact to the user?

Avoid to set not aligned expectations on the usage of these settings.

Checklist

  • My code follows the style guidelines of this project
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • [ ] I have made corresponding change to the default configuration files (and/or docker env variables)
  • [ ] I have added tests that prove my fix is effective or that my feature works

@andsel andsel self-assigned this May 17, 2024
@jsvd jsvd self-requested a review May 17, 2024 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants