Skip to content

Commit 7436248

Browse files
committed
update docs for v0.1.30
1 parent b61d95f commit 7436248

3 files changed

Lines changed: 15 additions & 2 deletions

File tree

docs/configuration/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,16 @@ checkout_timeout = 5_000
5454

5555
!!! note "TOML syntax"
5656
Since PgDog uses TOML, both `5000` and `5_000` are valid numbers. Configuration will fail to load if non-integer values are used, e.g. "5s" or "53.5".
57+
58+
## Overrides
59+
60+
When reading the configuration files, PgDog will apply settings in the following order:
61+
62+
1. Values in [`[[users]]`](users.toml/users.md) section take the highest priority
63+
2. Values in [`[[databases]]`](pgdog.toml/databases.md) are read next
64+
3. Values in [`[general]`](pgdog.toml/general.md) are used by default
65+
66+
For example, if `pool_size` is set on a user, it will be used over the same setting on the database. If none is set on the user, but it is set on a database, that will take priority over `default_pool_size` configured in general settings.
5767

5868
## Overview
5969

docs/configuration/pgdog.toml/databases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ The shard number for this database. Only required if your database contains more
7676

7777
Default: **`0`**
7878

79-
!!! note
80-
All settings below take priority over values in [`[general]`](general.md) and [`[[users]]`](../users.toml/users.md) config sections.
79+
!!! note "Settings priority"
80+
All settings below take priority over values in [`[general]`](general.md).
8181

8282
### `pool_size`
8383

docs/configuration/users.toml/users.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ The password for the user. Clients will need to provide this when connecting to
3636

3737
Default: **none** (required)
3838

39+
!!! note "Settings priority"
40+
All settings below take priority over values in [`[general]`](../pgdog.toml/general.md) and [`[[databases]]`](../pgdog.toml/databases.md).
41+
3942
### `pool_size`
4043

4144
Overrides [`default_pool_size`](../pgdog.toml/general.md) for this user. No more than this many server connections will be open at any given time to serve requests for this connection pool.

0 commit comments

Comments
 (0)