[WIP] Add documentation for maxConnectionCount database pool option

[Copilot]

• Explore repository structure
• Understand existing documentation organization
• Create docs/configuration/ directory
• Create docs/configuration/database-pool.md with maxConnectionCount documentation
• Create docs/changes/ directory
• Create docs/changes/4290-maxConnectionCount.md changelog entry
• Verify files are created correctly
• Run linting to check markdown formatting
• Code review

Original prompt

Add documentation for the new maxConnectionCount database pool configuration option introduced in serverpod/serverpod#4290.

This PR should add a new documentation page describing the option, how to use it, guidance for sizing, the default behavior, and a reference to the original Serverpod PR. It should also add a short changelog entry file documenting the introduction of the option.

Files to add:

# Database connection pool — maxConnectionCount

## Overview

A new configuration option, `maxConnectionCount`, allows you to set an upper limit on the number of concurrent connections in Serverpod’s database connection pool. This option was introduced in serverpod/serverpod#4290.

## Parameter

- Name: `maxConnectionCount`
- Type: integer
- Scope: database pool configuration

## Description

`maxConnectionCount` sets a hard upper limit for how many concurrent database connections Serverpod may open from its connection pool. Tuning this value helps you balance parallel throughput against database resource usage and connection limits imposed by your database server or cloud provider.

## Example configuration

```yaml
database:
  host: db.example.com
  port: 5432
  user: serverpod
  password: yourpassword
  database: mydb
  maxConnectionCount: 50
```

Replace `50` with the desired maximum number of pooled connections for your environment.

## Guidance

- Increase `maxConnectionCount` if your application needs more parallel database throughput and your database server can handle the increased number of connections.
- Decrease `maxConnectionCount` to reduce the number of open connections (useful on small deployments or when the database has strict connection limits).
- Make sure the value does not exceed any limits enforced by your database configuration or your hosting provider.

## Default behavior

If `maxConnectionCount` is not specified, Serverpod will select a sensible default appropriate for the environment. See the server code or the release notes for details on the default algorithm.

## Where this was introduced

This option was added in: https://github.com/serverpod/serverpod/pull/4290

# Add maxConnectionCount database pool option

- Add new database pool configuration option `maxConnectionCount` to limit the maximum number of concurrent DB connections. (serverpod/serverpod#4290)

This documents the configuration key, provides an example, and offers guidance for sizing. The documentation page is at `docs/configuration/database-pool.md`.

Additional details for the PR body / commit message:

• PR title: docs: add documentation for maxConnectionCount database pool option
• Commit message: docs: document maxConnectionCount database pool option (serverpod#4290)

Please create a new branch and open a pull request against the default branch of serverpod/serverpod_docs with the files above.

This pull request was created as a result of the following prompt from Copilot chat.

Add documentation for the new maxConnectionCount database pool configuration option introduced in serverpod/serverpod#4290.

This PR should add a new documentation page describing the option, how to use it, guidance for sizing, the default behavior, and a reference to the original Serverpod PR. It should also add a short changelog entry file documenting the introduction of the option.

Files to add:

# Database connection pool — maxConnectionCount

## Overview

A new configuration option, `maxConnectionCount`, allows you to set an upper limit on the number of concurrent connections in Serverpod’s database connection pool. This option was introduced in serverpod/serverpod#4290.

## Parameter

- Name: `maxConnectionCount`
- Type: integer
- Scope: database pool configuration

## Description

`maxConnectionCount` sets a hard upper limit for how many concurrent database connections Serverpod may open from its connection pool. Tuning this value helps you balance parallel throughput against database resource usage and connection limits imposed by your database server or cloud provider.

## Example configuration

```yaml
database:
  host: db.example.com
  port: 5432
  user: serverpod
  password: yourpassword
  database: mydb
  maxConnectionCount: 50
```

Replace `50` with the desired maximum number of pooled connections for your environment.

## Guidance

- Increase `maxConnectionCount` if your application needs more parallel database throughput and your database server can handle the increased number of connections.
- Decrease `maxConnectionCount` to reduce the number of open connections (useful on small deployments or when the database has strict connection limits).
- Make sure the value does not exceed any limits enforced by your database configuration or your hosting provider.

## Default behavior

If `maxConnectionCount` is not specified, Serverpod will select a sensible default appropriate for the environment. See the server code or the release notes for details on the default algorithm.

## Where this was introduced

This option was added in: https://github.com/serverpod/serverpod/pull/4290

# Add maxConnectionCount database pool option

- Add new database pool configuration option `maxConnectionCount` to limit the maximum number of concurrent DB connections. (serverpod/serverpod#4290)

This documents the configuration key, provides an example, and offers guidance for sizing. The documentation page is at `docs/configuration/database-pool.md`.

Additional details for the PR body / commit message:

• PR title: docs: add documentation for maxConnectionCount database pool option
• Commit message: docs: document maxConnectionCount database pool option (serverpod#4290)

Please create a new branch and open a pull request against the default branch of serverpod/serverpod_docs with the files above.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}