Document users.toml databases and all_databases settings#78
Merged
Conversation
The users configuration page only documented the singular `database` setting, but PgDog also supports `databases` (a list of clusters a user belongs to) and `all_databases` (grant access to every configured database). Document both, including how they interact with `database`.
levkk
approved these changes
Jun 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The users configuration page documents the singular
databasesetting, but PgDog's user config also supports two related settings that are currently undocumented:databases— a list of database clusters a user belongs to, so a single[[users]]entry can grant access to more than one database.all_databases— grants the user access to every database defined inpgdog.toml. PgDog expands the entry into one user (and connection pool) per configured database.Both fields exist in
pgdog-config/src/users.rsand the users JSON schema, but aren't on the docs site.Details
This PR adds sections for both, placed right after
databaseto match the field order in the config struct. The notes capture the priority rules enforced byUsers::check:databasetakes priority overdatabasesif both are set.all_databasestakes priority over bothdatabaseanddatabases.