Wiki / psql Commands / Scripting and assistance
\help
Gives syntax help on the specified SQL command. If command is not specified, then psql will list all the commands for which syntax help is available. If command is an asterisk ( * ), then syntax help on all SQL commands is shown.
Reading PostgreSQL 18.6.
Description
Gives syntax help on the specified SQL command. If command is not specified, then psql will list all the commands for which syntax help is available. If command is an asterisk ( * ), then syntax help on all SQL commands is shown.
- Client
- psql 18.6
- Case-sensitive spelling
- \help
Usage
\h or \help [ command ]Spellings in this manual definition
Manual definition
\hor\help[command]-
Gives syntax help on the specified SQL command. If
commandis not specified, then psql will list all the commands for which syntax help is available. Ifcommandis an asterisk (*), then syntax help on all SQL commands is shown.Unlike most other meta-commands, the entire remainder of the line is always taken to be the argument(s) of
\help, and neither variable interpolation nor backquote expansion are performed in the arguments.Note
To simplify typing, commands that consists of several words do not have to be quoted. Thus it is fine to type
\help alter table.
Related entries
Documentation and source
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.