psqlrc

psqlrc is the startup file for the PostgreSQL interactive terminal psql. It contains commands that are automatically executed when psql starts, allowing users to customize their session. The file is processed as if its contents were entered at the psql prompt, so it can include both standard SQL statements and psql meta-commands.

psql looks for startup files in a two-tier arrangement. There is a system-wide or global startup file, typically named psqlrc, which is installed with PostgreSQL in the program’s shared or system-wide directories. In addition, a user-specific startup file named .psqlrc is read from the user’s home directory. The user file can override settings defined in the system file. Users may also influence startup behavior by setting the PSQLRC environment variable to specify an alternate startup file path.

The kinds of customization commonly placed in psqlrc include appearance and behavior settings such as timing, pager usage, and formatting options (for example, \pset pager, \pset border, or \pset format). It can also include variables via \set, or simple informational output via \echo. In addition, SQL statements can be provided to establish initial session state or connect to a preferred database using commands like \c database.

Because startup files are read automatically, care should be taken to secure sensitive information and to avoid unintended commands. See also the psql client and PostgreSQL documentation for details on available meta-commands and formatting options.