Users configuration

This configuration controls which users are allowed to connect to PgDog. This is a TOML list so for each user, add a [[users]] section to users.toml. For example:

[[users]]
name = "alice"
database = "prod"
password = "hunter2"

[[users]]
name = "bob"
database = "prod"
password = "opensesame"

name

Name of the user. Clients that connect to PgDog will need to use this username.

Default: none (required)

database

Name of the database cluster this user belongs to. This refers to name setting in pgdog.toml, databases section.

Default: none (required)

password

The password for the user. Clients will need to provide this when connecting to PgDog.

Default: none (required)

pool_size

Overrides default_pool_size for this user. No more than this many server connections will be open at any given time to serve requests for this connection pool.

Default: none (defaults to default_pool_size from pgdog.toml)

pooler_mode

Overrides pooler_mode for this user. This allows users in session mode to connect to the same PgDog instance as users in transaction mode.

Default: none (defaults to pooler_mode from pgdog.toml)

server_user

Which user to connect with when creating backend connections from PgDog to PostgreSQL. By default, the user configured in name is used. This setting allows to override this configuration and use a different user.

Note

Values specified in pgdog.toml take priority over this configuration.

Default: none (defaults to name)

server_password

Which password to connect with when creating backend connections from PgDog to PostgreSQL. By default, the password configured in password is used. This setting allows to override this configuration and use a different password, decoupling server passwords from user passwords given to clients.

Default: none (defaults to password)

Note

Values specified in pgdog.toml take priority over this configuration.

statement_timeout

Sets the statement_timeout on all server connections at connection creation. This allows to set a reasonable default for each user without modifying postgresql.conf or using ALTER USER.

Note

Nothing is preventing the user from manually changing this setting at runtime, e.g., by running SET statement_timeout TO 0;