Wiki / psql Commands / Scripting and assistance

\prompt

Prompts the user to supply text, which is assigned to the variable name . An optional prompt string, text , can be specified. (For multiword prompts, surround the text with single quotes.)

Reading PostgreSQL 18.6.

Description

Prompts the user to supply text, which is assigned to the variable name . An optional prompt string, text , can be specified. (For multiword prompts, surround the text with single quotes.)

Client: psql 18.6
Case-sensitive spelling: \prompt

Usage

\prompt [ text ] name

Spellings in this manual definition

Command	Documented suffix modifiers
\prompt	None listed in this signature

Manual definition

\prompt [ text ] name

Prompts the user to supply text, which is assigned to the variable name. An optional prompt string, text, can be specified. (For multiword prompts, surround the text with single quotes.)

By default, \prompt uses the terminal for input and output. However, if the -f command line switch was used, \prompt uses standard input and standard output.

Related entries

psql command-line options and complete manual

Documentation and source

18.6 English manual · app-psql.html

Source build

Version: 18.6
Build: https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2
Source fingerprint: ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8

Compare versions

PostgreSQL 17 → 18: unchanged.

Compares recorded interfaces and attributes. Source fingerprints and build metadata are excluded; an absent sample is not proof of the introduction or removal release.

Related entries

Export JSON · Back to psql Commands · Recorded in PostgreSQL 10 through 20; the first sample is not necessarily its introduction.