psql \? help display

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: PostgreSQL-development <pgsql-hackers(at)postgreSQL(dot)org>
Subject: psql \? help display
Date: 2008-05-13 15:15:51
Message-ID: 200805131515.m4DFFpV06218@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

I promised to review our psql \? output to see if I could improve it,
particularly the "General" section at the top. Below are the results.

Are the new sections ideal, and in the best ordering? Should \copyright
be kept in "General" at the top? Should \? be listed?

I also pulled up some descriptive text that caused the options to have
blank lines between them.

---------------------------------------------------------------------------

General
\copyright show PostgreSQL usage and distribution terms
\h [NAME] help on syntax of SQL commands, * for all commands
\q quit psql

Query Buffer
\e [FILE] edit the query buffer (or file) with external editor
\g [FILE] send query buffer to server (and results to file or |pipe)
\p show the contents of the query buffer
\r reset (clear) the query buffer
\s [FILE] display history or save it to file
\w FILE write query buffer to file

Input/Output
\echo [STRING] write string to standard output
\i FILE execute commands from file
\o [FILE] send all query results to file or |pipe
\qecho [STRING] write string to query output stream (see \o)

Informational
\d [NAME] describe table, index, sequence, or view
\d{t|i|s|v|S} [PATTERN] (add "+" for more detail)
list tables/indexes/sequences/views/system tables
\da [PATTERN] list aggregate functions
\db [PATTERN] list tablespaces (add "+" for more detail)
\dc [PATTERN] list conversions
\dC list casts
\dd [PATTERN] show comment for object
\dD [PATTERN] list domains
\df [PATTERN] list functions (add "+" for more detail)
\dF [PATTERN] list text search configurations (add "+" for more detail)
\dFd [PATTERN] list text search dictionaries (add "+" for more detail)
\dFt [PATTERN] list text search templates
\dFp [PATTERN] list text search parsers (add "+" for more detail)
\dg [PATTERN] list roles (groups)
\dn [PATTERN] list schemas (add "+" for more detail)
\do [NAME] list operators
\dl list large objects, same as \lo_list
\dp [PATTERN] list table, view, and sequence access privileges
\dT [PATTERN] list data types (add "+" for more detail)
\du [PATTERN] list roles (users)
\l list all databases (add "+" for more detail)
\z [PATTERN] list table, view, and sequence access privileges (same as \dp)

Formatting
\a toggle between unaligned and aligned output mode
\C [STRING] set table title, or unset if none
\f [STRING] show or set field separator for unaligned query output
\H toggle HTML output mode (currently off)
\pset NAME [VALUE] set table output option
(NAME := {format|border|expanded|fieldsep|footer|null|
numericlocale|recordsep|tuples_only|title|tableattr|pager})
\t show only rows (currently off)
\T [STRING] set HTML <table> tag attributes, or unset if none
\x toggle expanded output (currently off)

Connection
\c[onnect] [DBNAME|- USER|- HOST|- PORT|-]
connect to new database (currently "test")
\encoding [ENCODING] show or set client encoding
\password [USERNAME] securely change the password for a user

External
\cd [DIR] change the current working directory
\timing toggle timing of commands (currently off)
\! [COMMAND] execute command in shell or start interactive shell

Variable
\prompt [TEXT] NAME prompt user to set internal variable
\set [NAME [VALUE]] set internal variable, or list all if no parameters
\unset NAME unset (delete) internal variable

Copy, Large Object
\copy ... perform SQL COPY with data stream to the client host
\lo_export LOBOID FILE
\lo_import FILE [COMMENT]
\lo_list
\lo_unlink LOBOID large object operations

--
Bruce Momjian <bruce(at)momjian(dot)us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ If your life is a hard drive, Christ can be your backup. +

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Alvaro Herrera 2008-05-13 15:22:10 Re: psql \? help display
Previous Message Alvaro Herrera 2008-05-13 15:08:52 Re: odd output in restore mode