Difference between revisions of "Psql --help"
Jump to navigation
Jump to search
(Created page with "<pre> psql --help psql is the PostgreSQL interactive terminal. Usage: psql [OPTION]... [DBNAME [USERNAME]] General options: -c, --command=COMMAND run only single comm...") |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{lc}} | ||
| + | |||
| + | [[psql]] --help | ||
| + | psql is the PostgreSQL interactive terminal. | ||
| + | |||
| + | Usage: | ||
| + | psql [OPTION]... [DBNAME [USERNAME]] | ||
| + | |||
| + | General options: | ||
| + | -c, --command=COMMAND run only single command (SQL or internal) and exit | ||
| + | -d, --dbname=DBNAME database name to connect to (default: "k") | ||
| + | -f, --file=FILENAME execute commands from file, then exit | ||
| + | [[-l]], --list list available databases, then exit | ||
| + | -v, --set=, --variable=NAME=VALUE | ||
| + | set psql variable NAME to VALUE | ||
| + | (e.g., -v ON_ERROR_STOP=1) | ||
| + | -V, --version output version information, then exit | ||
| + | -X, --no-psqlrc do not read startup file ([[~/.psqlrc]]) | ||
| + | -1 ("one"), --single-transaction | ||
| + | execute as a single transaction (if non-interactive) | ||
| + | -?, --help[=options] show this help, then exit | ||
| + | --help=commands list backslash commands, then exit | ||
| + | --help=variables list special variables, then exit | ||
<pre> | <pre> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Input and output options: | Input and output options: | ||
-a, --echo-all echo all input from script | -a, --echo-all echo all input from script | ||
| Line 68: | Line 69: | ||
== See also == | == See also == | ||
* {{psql}} | * {{psql}} | ||
| + | |||
| + | [[Category:psql]] | ||
Latest revision as of 03:53, 3 May 2023
psql --help psql is the PostgreSQL interactive terminal. Usage: psql [OPTION]... [DBNAME [USERNAME]] General options: -c, --command=COMMAND run only single command (SQL or internal) and exit -d, --dbname=DBNAME database name to connect to (default: "k") -f, --file=FILENAME execute commands from file, then exit -l, --list list available databases, then exit -v, --set=, --variable=NAME=VALUE set psql variable NAME to VALUE (e.g., -v ON_ERROR_STOP=1) -V, --version output version information, then exit -X, --no-psqlrc do not read startup file (~/.psqlrc) -1 ("one"), --single-transaction execute as a single transaction (if non-interactive) -?, --help[=options] show this help, then exit --help=commands list backslash commands, then exit --help=variables list special variables, then exit
Input and output options:
-a, --echo-all echo all input from script
-b, --echo-errors echo failed commands
-e, --echo-queries echo commands sent to server
-E, --echo-hidden display queries that internal commands generate
-L, --log-file=FILENAME send session log to file
-n, --no-readline disable enhanced command line editing (readline)
-o, --output=FILENAME send query results to file (or |pipe)
-q, --quiet run quietly (no messages, only query output)
-s, --single-step single-step mode (confirm each query)
-S, --single-line single-line mode (end of line terminates SQL command)
Output format options:
-A, --no-align unaligned table output mode
--csv CSV (Comma-Separated Values) table output mode
-F, --field-separator=STRING
field separator for unaligned output (default: "|")
-H, --html HTML table output mode
-P, --pset=VAR[=ARG] set printing option VAR to ARG (see \pset command)
-R, --record-separator=STRING
record separator for unaligned output (default: newline)
-t, --tuples-only print rows only
-T, --table-attr=TEXT set HTML table tag attributes (e.g., width, border)
-x, --expanded turn on expanded table output
-z, --field-separator-zero
set field separator for unaligned output to zero byte
-0, --record-separator-zero
set record separator for unaligned output to zero byte
Connection options:
-h, --host=HOSTNAME database server host or socket directory (default: "local socket")
-p, --port=PORT database server port (default: "5432")
-U, --username=USERNAME database user name (default: "k")
-w, --no-password never prompt for password
-W, --password force password prompt (should happen automatically)
For more information, type "\?" (for internal commands) or "\help" (for SQL
commands) from within psql, or consult the psql section in the PostgreSQL
documentation.
Report bugs to <[email protected]>.
PostgreSQL home page: <https://www.postgresql.org/>
See also[edit]
Advertising:
