docs(RegisterConnConfig): explain alternative usage #2480
+12
−0
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.
Context
The fact that RegisterConnConfig "holds" an internal map that can grow without bound is something that could be stated explicitly.
PR changes
I believe it would be a good idea to explain an alternative for clients with many short-lived connections to many DBs, to avoid memory leaks. Being a bit more explicit and vocal in the comments about how that works will help clients to choose if they really want to use RegisterConnConfig or the alternative shared.
I placed the comment both in
WDYT ?
Thank you!