Skip to content

docs: correct DB pool size defaults in CONFIGURATION.md#704

Open
Priyanshubhartistm wants to merge 1 commit into
cameri:mainfrom
Priyanshubhartistm:docs/fix-db-pool-size-defaults
Open

docs: correct DB pool size defaults in CONFIGURATION.md#704
Priyanshubhartistm wants to merge 1 commit into
cameri:mainfrom
Priyanshubhartistm:docs/fix-db-pool-size-defaults

Conversation

@Priyanshubhartistm

Copy link
Copy Markdown
Collaborator

Description

CONFIGURATION.md documented the connection-pool defaults as DB_MIN_POOL_SIZE = 16 and DB_MAX_POOL_SIZE = 32 (and the same for every RRn_DB_MIN_POOL_SIZE / RRn_DB_MAX_POOL_SIZE read-replica row). The actual code defaults in src/database/client.ts are min: 0 and max: 3 for both the primary pool and the read-replica pools:

pool: {
  min: process.env.DB_MIN_POOL_SIZE ? Number(process.env.DB_MIN_POOL_SIZE) : 0,
  max: process.env.DB_MAX_POOL_SIZE ? Number(process.env.DB_MAX_POOL_SIZE) : 3,
  ...
}

This PR updates the eight pool-size rows in the Default column to 0 / 3 so the docs match the code (and .env.example, which already documents 0 / 3).

Related Issue

Closes #701

Motivation and Context

The worker error handler in src/app/worker.ts tells 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 nor docker-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.

  • Verified the corrected values against 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

  • Non-functional change (docs, style, minor refactor)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my code changes.
  • I added a changeset, or this is docs-only and I added an empty changeset.
  • All new and existing tests passed.

@changeset-bot

changeset-bot Bot commented Jul 20, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 8fddc1a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] CONFIGURATION.md documents wrong default values for DB_MIN_POOL_SIZE / DB_MAX_POOL_SIZE

1 participant