\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 PG 18·Select a recorded version
- Client
- psql 18.7
- Case-sensitive spelling
- \help
- command
- \help
- manual path
- app-psql.html#APP-PSQL-META-COMMAND-HELP
- modifiers
- Unknown
- signature
- \h or \help [ command ]
- spellings
- \h, \help
Definition PG 18
\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.
Exact case-sensitive spellings
\h\help
Spellings in this manual definition
Compare versions
Complete source facts
documentation revision
{"inputs":[{"file":"app-psql.html","kind":"same-version-reviewed-manual","locale":"en","sha256":"af50448485df02bdef2b72b8347192ba029c7082b8d0392ecb17db44ad533aaf","version":"18.7"},{"file":"app-psql.html","kind":"same-version-reviewed-manual","locale":"zh-Hans","sha256":"cb475c53a16d9e06358f5e6c9c5649645db92568cfd319f230c62c9f57ae090b","version":"18.7"}],"release":"18.7","runtime_remeasured":false,"source_revision":"pgdoc:b9f0e7232f60f380d642ac9b99226606c254b552"}Source references
Full definition and evidence JSON
Definition sources
center · PostgreSQL 18 · 1b2d62b4845aa46374f2cb680f95d3392322cc8128646992ae4e18d0e7084915
Text language: en · 1b2d62b4845aa46374f2cb680f95d3392322cc8128646992ae4e18d0e7084915