docs(pgxpool): correct the documented pool_max_conns default - #2638
Open
shaikn6 wants to merge 1 commit into
Open
docs(pgxpool): correct the documented pool_max_conns default#2638shaikn6 wants to merge 1 commit into
shaikn6 wants to merge 1 commit into
Conversation
ParseConfig's doc lists 'pool_max_conns: ... (default 4)', but when the parameter is unset the code sets MaxConns to the greater of 4 and runtime.NumCPU() (pool.go, the else branch a few lines below). On any host with more than 4 CPUs the effective default is NumCPU, not 4. The Config.MaxConns field doc already states it correctly; this aligns the ParseConfig list with it.
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
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.
ParseConfig's doc comment lists:But when
pool_max_connsis not supplied, the code sets it to the greater of 4 andruntime.NumCPU():So on any host with more than 4 CPUs the effective default is
NumCPU, not 4 — which matters for capacity planning againstmax_connections. TheConfig.MaxConnsfield doc already states this correctly ("The default is the greater of 4 or runtime.NumCPU()"); this just brings theParseConfigparameter list in line with it.One-line comment change. No code, no behavior change.