Definition at line 176 of file help.c.
192 HELP0(
" \\bind [PARAM]... set query parameters\n");
193 HELP0(
" \\copyright show PostgreSQL usage and distribution terms\n");
194 HELP0(
" \\crosstabview [COLUMNS] execute query and display result in crosstab\n");
195 HELP0(
" \\errverbose show most recent error message at maximum verbosity\n");
196 HELP0(
" \\g [(OPTIONS)] [FILE] execute query (and send result to file or |pipe);\n"
197 " \\g with no arguments is equivalent to a semicolon\n");
198 HELP0(
" \\gdesc describe result of query, without executing it\n");
199 HELP0(
" \\gexec execute query, then execute each value in its result\n");
200 HELP0(
" \\gset [PREFIX] execute query and store result in psql variables\n");
201 HELP0(
" \\gx [(OPTIONS)] [FILE] as \\g, but forces expanded output mode\n");
202 HELP0(
" \\q quit psql\n");
203 HELP0(
" \\watch [SEC] execute query every SEC seconds\n");
208 HELP0(
" \\? [commands] show help on backslash commands\n");
209 HELP0(
" \\? options show help on psql command-line options\n");
210 HELP0(
" \\? variables show help on special variables\n");
211 HELP0(
" \\h [NAME] help on syntax of SQL commands, * for all commands\n");
214 HELP0(
"Query Buffer\n");
215 HELP0(
" \\e [FILE] [LINE] edit the query buffer (or file) with external editor\n");
216 HELP0(
" \\ef [FUNCNAME [LINE]] edit function definition with external editor\n");
217 HELP0(
" \\ev [VIEWNAME [LINE]] edit view definition with external editor\n");
218 HELP0(
" \\p show the contents of the query buffer\n");
219 HELP0(
" \\r reset (clear) the query buffer\n");
221 HELP0(
" \\s [FILE] display history or save it to file\n");
223 HELP0(
" \\w FILE write query buffer to file\n");
226 HELP0(
"Input/Output\n");
227 HELP0(
" \\copy ... perform SQL COPY with data stream to the client host\n");
228 HELP0(
" \\echo [-n] [STRING] write string to standard output (-n for no newline)\n");
229 HELP0(
" \\i FILE execute commands from file\n");
230 HELP0(
" \\ir FILE as \\i, but relative to location of current script\n");
231 HELP0(
" \\o [FILE] send all query results to file or |pipe\n");
232 HELP0(
" \\qecho [-n] [STRING] write string to \\o output stream (-n for no newline)\n");
233 HELP0(
" \\warn [-n] [STRING] write string to standard error (-n for no newline)\n");
236 HELP0(
"Conditional\n");
237 HELP0(
" \\if EXPR begin conditional block\n");
238 HELP0(
" \\elif EXPR alternative within current conditional block\n");
239 HELP0(
" \\else final alternative within current conditional block\n");
240 HELP0(
" \\endif end conditional block\n");
243 HELP0(
"Informational\n");
244 HELP0(
" (options: S = show system objects, + = additional detail)\n");
245 HELP0(
" \\d[S+] list tables, views, and sequences\n");
246 HELP0(
" \\d[S+] NAME describe table, view, sequence, or index\n");
247 HELP0(
" \\da[S] [PATTERN] list aggregates\n");
248 HELP0(
" \\dA[+] [PATTERN] list access methods\n");
249 HELP0(
" \\dAc[+] [AMPTRN [TYPEPTRN]] list operator classes\n");
250 HELP0(
" \\dAf[+] [AMPTRN [TYPEPTRN]] list operator families\n");
251 HELP0(
" \\dAo[+] [AMPTRN [OPFPTRN]] list operators of operator families\n");
252 HELP0(
" \\dAp[+] [AMPTRN [OPFPTRN]] list support functions of operator families\n");
253 HELP0(
" \\db[+] [PATTERN] list tablespaces\n");
254 HELP0(
" \\dc[S+] [PATTERN] list conversions\n");
255 HELP0(
" \\dconfig[+] [PATTERN] list configuration parameters\n");
256 HELP0(
" \\dC[+] [PATTERN] list casts\n");
257 HELP0(
" \\dd[S] [PATTERN] show object descriptions not displayed elsewhere\n");
258 HELP0(
" \\dD[S+] [PATTERN] list domains\n");
259 HELP0(
" \\ddp [PATTERN] list default privileges\n");
260 HELP0(
" \\dE[S+] [PATTERN] list foreign tables\n");
261 HELP0(
" \\des[+] [PATTERN] list foreign servers\n");
262 HELP0(
" \\det[+] [PATTERN] list foreign tables\n");
263 HELP0(
" \\deu[+] [PATTERN] list user mappings\n");
264 HELP0(
" \\dew[+] [PATTERN] list foreign-data wrappers\n");
265 HELP0(
" \\df[anptw][S+] [FUNCPTRN [TYPEPTRN ...]]\n"
266 " list [only agg/normal/procedure/trigger/window] functions\n");
267 HELP0(
" \\dF[+] [PATTERN] list text search configurations\n");
268 HELP0(
" \\dFd[+] [PATTERN] list text search dictionaries\n");
269 HELP0(
" \\dFp[+] [PATTERN] list text search parsers\n");
270 HELP0(
" \\dFt[+] [PATTERN] list text search templates\n");
271 HELP0(
" \\dg[S+] [PATTERN] list roles\n");
272 HELP0(
" \\di[S+] [PATTERN] list indexes\n");
273 HELP0(
" \\dl[+] list large objects, same as \\lo_list\n");
274 HELP0(
" \\dL[S+] [PATTERN] list procedural languages\n");
275 HELP0(
" \\dm[S+] [PATTERN] list materialized views\n");
276 HELP0(
" \\dn[S+] [PATTERN] list schemas\n");
277 HELP0(
" \\do[S+] [OPPTRN [TYPEPTRN [TYPEPTRN]]]\n"
278 " list operators\n");
279 HELP0(
" \\dO[S+] [PATTERN] list collations\n");
280 HELP0(
" \\dp [PATTERN] list table, view, and sequence access privileges\n");
281 HELP0(
" \\dP[itn+] [PATTERN] list [only index/table] partitioned relations [n=nested]\n");
282 HELP0(
" \\drds [ROLEPTRN [DBPTRN]] list per-database role settings\n");
283 HELP0(
" \\dRp[+] [PATTERN] list replication publications\n");
284 HELP0(
" \\dRs[+] [PATTERN] list replication subscriptions\n");
285 HELP0(
" \\ds[S+] [PATTERN] list sequences\n");
286 HELP0(
" \\dt[S+] [PATTERN] list tables\n");
287 HELP0(
" \\dT[S+] [PATTERN] list data types\n");
288 HELP0(
" \\du[S+] [PATTERN] list roles\n");
289 HELP0(
" \\dv[S+] [PATTERN] list views\n");
290 HELP0(
" \\dx[+] [PATTERN] list extensions\n");
291 HELP0(
" \\dX [PATTERN] list extended statistics\n");
292 HELP0(
" \\dy[+] [PATTERN] list event triggers\n");
293 HELP0(
" \\l[+] [PATTERN] list databases\n");
294 HELP0(
" \\sf[+] FUNCNAME show a function's definition\n");
295 HELP0(
" \\sv[+] VIEWNAME show a view's definition\n");
296 HELP0(
" \\z [PATTERN] same as \\dp\n");
299 HELP0(
"Large Objects\n");
300 HELP0(
" \\lo_export LOBOID FILE write large object to file\n");
301 HELP0(
" \\lo_import FILE [COMMENT]\n"
302 " read large object from file\n");
303 HELP0(
" \\lo_list[+] list large objects\n");
304 HELP0(
" \\lo_unlink LOBOID delete a large object\n");
307 HELP0(
"Formatting\n");
308 HELP0(
" \\a toggle between unaligned and aligned output mode\n");
309 HELP0(
" \\C [STRING] set table title, or unset if none\n");
310 HELP0(
" \\f [STRING] show or set field separator for unaligned query output\n");
311 HELPN(
" \\H toggle HTML output mode (currently %s)\n",
313 HELP0(
" \\pset [NAME [VALUE]] set table output option\n"
314 " (border|columns|csv_fieldsep|expanded|fieldsep|\n"
315 " fieldsep_zero|footer|format|linestyle|null|\n"
316 " numericlocale|pager|pager_min_lines|recordsep|\n"
317 " recordsep_zero|tableattr|title|tuples_only|\n"
318 " unicode_border_linestyle|unicode_column_linestyle|\n"
319 " unicode_header_linestyle)\n");
320 HELPN(
" \\t [on|off] show only rows (currently %s)\n",
322 HELP0(
" \\T [STRING] set HTML <table> tag attributes, or unset if none\n");
323 HELPN(
" \\x [on|off|auto] toggle expanded output (currently %s)\n",
327 HELP0(
"Connection\n");
329 HELPN(
" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
330 " connect to new database (currently \"%s\")\n",
333 HELP0(
" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
334 " connect to new database (currently no connection)\n");
335 HELP0(
" \\conninfo display information about current connection\n");
336 HELP0(
" \\encoding [ENCODING] show or set client encoding\n");
337 HELP0(
" \\password [USERNAME] securely change the password for a user\n");
340 HELP0(
"Operating System\n");
341 HELP0(
" \\cd [DIR] change the current working directory\n");
342 HELP0(
" \\getenv PSQLVAR ENVVAR fetch environment variable\n");
343 HELP0(
" \\setenv NAME [VALUE] set or unset environment variable\n");
344 HELPN(
" \\timing [on|off] toggle timing of commands (currently %s)\n",
346 HELP0(
" \\! [COMMAND] execute command in shell or start interactive shell\n");
349 HELP0(
"Variables\n");
350 HELP0(
" \\prompt [TEXT] NAME prompt user to set internal variable\n");
351 HELP0(
" \\set [NAME [VALUE]] set internal variable, or list all if no parameters\n");
352 HELP0(
" \\unset NAME unset (delete) internal variable\n");
356 for (
const char *ptr =
buf.data; *ptr; ptr++)
char * PQdb(const PGconn *conn)
unsigned short int expanded
References _, buf, ClosePager(), _psqlSettings::db, printTableOpt::expanded, printTableOpt::format, HELP0, HELPN, initPQExpBuffer(), ON, output(), PageOutput(), _psqlSettings::popt, PQdb(), PRINT_HTML, pset, termPQExpBuffer(), _psqlSettings::timing, printQueryOpt::topt, and printTableOpt::tuples_only.
Referenced by exec_command_slash_command_help(), and parse_psql_options().