Skip to content

Commit 54b8ca9

Browse files
committed
Missing settings docs
1 parent 1328c67 commit 54b8ca9

3 files changed

Lines changed: 30 additions & 2 deletions

File tree

docs/configuration/pgdog.toml/general.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,18 @@ Maximum amount of time a client is allowed to wait for a connection from the poo
177177

178178
Default: **`300`** (5s)
179179

180+
### `idle_timeout`
181+
182+
Close server connections that have been idle, i.e., haven't served a single client transaction, for this amount of time.
183+
184+
Default: **`60_000`** (60s)
185+
186+
### `client_idle_timeout`
187+
188+
Close client connections that have been idle, i.e., haven't sent any queries, for this amount of time.
189+
190+
Default: **`none`** (disabled)
191+
180192
## Load balancer
181193

182194
### `load_balancing_strategy`
@@ -198,7 +210,7 @@ Available options:
198210
- `include_primary`
199211
- `exclude_primary`
200212

201-
Include primary uses the primary database as well as the replicas to serve read queries. Exclude primary will send all read queries to replicas, leaving the primary to serve only writes.
213+
Include primary uses the primary database as well as the replicas to serve read queries. Exclude primary will send all read queries to replicas, leaving the primary to serve only writes.
202214

203215
Default: **`include_primary`**
204216

docs/configuration/pgdog.toml/sharded_tables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The data type of the column. Currently supported options are:
7272

7373
## Omnisharded tables
7474

75-
Omnisharded tables are tables that have the same data on all shards. They typically are small and contain metadata, e.g., list of countries, cities, etc., and are used in joins. PgDog allows to read from these tables directly and load balances traffic event across all shards.
75+
Omnisharded tables are tables that have the same data on all shards. They typically are small and contain metadata, e.g., list of countries, cities, etc., and are used in joins. PgDog allows to read from these tables directly and load balances traffic evenly across all shards.
7676

7777
#### Example
7878
```toml

docs/configuration/users.toml/users.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ Overrides [`default_pool_size`](../pgdog.toml/general.md) for this user. No more
3939

4040
Default: **none** (defaults to `default_pool_size` from `pgdog.toml`)
4141

42+
### `min_pool_size`
43+
44+
Overrides [`min_pool_size`](../pgdog.toml/general.md#min_pool_size) for this user. Opens at least this many connections on pooler startup and keeps them open despite [`idle_timeout`](../pgdog.toml/general.md#idle_timeout).
45+
4246
### `pooler_mode`
4347

4448
Overrides [`pooler_mode`](../pgdog.toml/general.md) for this user. This allows users in [session mode](../../features/session-mode.md) to connect to the
@@ -70,3 +74,15 @@ Sets the `statement_timeout` on all server connections at connection creation. T
7074

7175
!!! note
7276
Nothing is preventing the user from manually changing this setting at runtime, e.g., by running `SET statement_timeout TO 0`;
77+
78+
### `replication_mode`
79+
80+
Sets the `replication=database` parameter on user connections to Postgres. Allows this user to use replication commands.
81+
82+
Default: **`false`** (disabled)
83+
84+
### `idle_timeout`
85+
86+
Overrides [`idle_timeout`](../pgdog.toml/general.md#idle_timeout) for this user. Server connections that have been idle for this long, without affecting [`min_pool_size`](../pgdog.toml/general.md#min_pool_size), will be closed.
87+
88+
Default: **none** (not set)

0 commit comments

Comments
 (0)