Skip to content

feat: document prefer_primary #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
levkk merged 1 commit into from
Jul 24, 2026
+3 −0
Merged

feat: document prefer_primary #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/configuration/pgdog.toml/general.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,11 +305,14 @@ Available options:
- `include_primary`
- `exclude_primary`
- `include_primary_if_replica_banned`
- `prefer_primary`

`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.

`include_primary_if_replica_banned` strategy will only send reads to the primary if one or more replicas have been banned. This is useful in case you want to use the primary as a failover for reads.

`prefer_primary` will route all queries to the primary unless you explicitely set the `pgdog.role` session parameter or the `/* pgdog_role */` comment to `replica`.

Default: **`include_primary`**

### `healthcheck_port`
Expand Down
Loading