pgserviceconf

pg_service.conf, often referred to in the context of pgserviceconf, is a PostgreSQL feature that stores named connection configurations for libpq-based clients such as psql. It enables users to define multiple service entries that specify host, port, database name, user, and various optional parameters, allowing connections to be made by service name rather than by supplying all parameters each time. The approach reduces duplication and simplifies switching between environments.

A service file is a plain text INI-style file named pg_service.conf. Each connection service is defined in its own section, identified by the service name in square brackets. Within a section, key-value pairs set connection parameters, for example host, port, dbname, user, and sslmode. Password values can be included, but storing passwords in this file is generally discouraged in favor of more secure mechanisms such as a dedicated password file or environment-based credentials.

Common locations and discovery mechanisms include a user-specific file in the home directory, typically ~/.pg_service.conf, and a system-wide file such as /etc/pg_service.conf. libpq can also be directed to a specific service file via environment variables like PGSERVICEFILE, and a default service can be selected with PGSERVICE. When connecting, a client can specify service=name or rely on the default service if configured.

Example:

[prod]

host=prod.db.example.com

port=5432

dbname=prod

user=app

sslmode=require

Usage and portability notes: pg_service.conf is supported by libpq-based clients and enables consistent configuration across tools. Passwords should be handled securely, and not all drivers or clients may support all options in the file. For detailed behavior, consult the PostgreSQL official documentation on libpq service files.