docs: correct DB pool size defaults in CONFIGURATION.md#704
Open
Priyanshubhartistm wants to merge 1 commit into
Open
docs: correct DB pool size defaults in CONFIGURATION.md#704Priyanshubhartistm wants to merge 1 commit into
Priyanshubhartistm wants to merge 1 commit into
Conversation
🦋 Changeset detectedLatest commit: 8fddc1a The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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.
Description
CONFIGURATION.md documented the connection-pool defaults as
DB_MIN_POOL_SIZE = 16andDB_MAX_POOL_SIZE = 32(and the same for everyRRn_DB_MIN_POOL_SIZE/RRn_DB_MAX_POOL_SIZEread-replica row). The actual code defaults insrc/database/client.tsaremin: 0andmax: 3for both the primary pool and the read-replica pools:This PR updates the eight pool-size rows in the Default column to
0/3so the docs match the code (and.env.example, which already documents0/3).Related Issue
Closes #701
Motivation and Context
The worker error handler in
src/app/worker.tstells operators to "increase DB_MAX_POOL_SIZE" when connection acquisition fails. The old docs led operators to believe the pool was already large (32) when the real default is 3, obscuring the fix the error message points to. The documented defaults also matched neither the code nordocker-compose.yml(which overrides to 16/64). Correcting the Default column removes that confusion.How Has This Been Tested?
Documentation-only change; no code paths affected.
src/database/client.ts(min: 0,max: 3) and.env.example.pnpm exec changeset status— empty changeset present.Environment: Linux, Docker
Screenshots (if appropriate):
N/A — documentation table values only.
Types of changes
Checklist: