PostgreSQL Source Code git master
Loading...
Searching...
No Matches
Macros | Functions
help.c File Reference
#include "postgres_fe.h"
#include <unistd.h>
#include <sys/ioctl.h>
#include "help.h"
#include "input.h"
#include "settings.h"
#include "sql_help.h"
Include dependency graph for help.c:

Go to the source code of this file.

Macros

#define HELP0(str)   appendPQExpBufferStr(&buf, _(str))
 
#define HELPN(str, ...)   appendPQExpBuffer(&buf, _(str), __VA_ARGS__)
 
#define ON(var)   ((var) ? _("on") : _("off"))
 
#define VALUE_OR_NULL(a)   ((a) ? (a) : "")
 

Functions

void usage (unsigned short int pager)
 
void slashUsage (unsigned short int pager)
 
void helpVariables (unsigned short int pager)
 
void helpSQL (const char *topic, unsigned short int pager)
 
void print_copyright (void)
 

Macro Definition Documentation

◆ HELP0

#define HELP0 (   str)    appendPQExpBufferStr(&buf, _(str))

Definition at line 37 of file help.c.

◆ HELPN

#define HELPN (   str,
  ... 
)    appendPQExpBuffer(&buf, _(str), __VA_ARGS__)

Definition at line 38 of file help.c.

◆ ON

#define ON (   var)    ((var) ? _("on") : _("off"))

Definition at line 39 of file help.c.

◆ VALUE_OR_NULL

#define VALUE_OR_NULL (   a)    ((a) ? (a) : "")

Function Documentation

◆ helpSQL()

void helpSQL ( const char *  topic,
unsigned short int  pager 
)

Definition at line 593 of file help.c.

594{
595#define VALUE_OR_NULL(a) ((a) ? (a) : "")
596
597 if (!topic || strlen(topic) == 0)
598 {
599 /* Print all the available command names */
600 int screen_width;
601 int ncolumns;
602 int nrows;
603 FILE *output;
604 int i;
605 int j;
606
607 /* Find screen width to determine how many columns will fit */
608#ifdef TIOCGWINSZ
609 struct winsize screen_size;
610
611 if (ioctl(fileno(stdout), TIOCGWINSZ, &screen_size) == -1)
612 screen_width = 80; /* ioctl failed, assume 80 */
613 else
614 screen_width = screen_size.ws_col;
615#else
616 screen_width = 80; /* default assumption */
617#endif
618
619 ncolumns = (screen_width - 3) / (QL_MAX_CMD_LEN + 1);
620 ncolumns = Max(ncolumns, 1);
621 nrows = (QL_HELP_COUNT + (ncolumns - 1)) / ncolumns;
622
623 output = PageOutput(nrows + 1, pager ? &(pset.popt.topt) : NULL);
624
625 fputs(_("Available help:\n"), output);
626
627 for (i = 0; i < nrows; i++)
628 {
629 fprintf(output, " ");
630 for (j = 0; j < ncolumns - 1; j++)
631 fprintf(output, "%-*s",
632 QL_MAX_CMD_LEN + 1,
633 VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
634 if (i + j * nrows < QL_HELP_COUNT)
635 fprintf(output, "%s",
636 VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
637 fputc('\n', output);
638 }
639
640 ClosePager(output);
641 }
642 else
643 {
644 int i,
645 pass;
646 FILE *output = NULL;
647 size_t len,
648 wordlen,
649 j;
650 int nl_count;
651
652 /*
653 * len is the amount of the input to compare to the help topic names.
654 * We first try exact match, then first + second words, then first
655 * word only.
656 */
657 len = strlen(topic);
658
659 for (pass = 1; pass <= 3; pass++)
660 {
661 if (pass > 1) /* Nothing on first pass - try the opening
662 * word(s) */
663 {
664 wordlen = j = 1;
665 while (j < len && topic[j++] != ' ')
666 wordlen++;
667 if (pass == 2 && j < len)
668 {
669 wordlen++;
670 while (j < len && topic[j++] != ' ')
671 wordlen++;
672 }
673 if (wordlen >= len)
674 {
675 /* Failed to shorten input, so try next pass if any */
676 continue;
677 }
678 len = wordlen;
679 }
680
681 /*
682 * Count newlines for pager. This logic must agree with what the
683 * following loop will do!
684 */
685 nl_count = 0;
686 for (i = 0; QL_HELP[i].cmd; i++)
687 {
688 if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
689 strcmp(topic, "*") == 0)
690 {
691 /* magic constant here must match format below! */
692 nl_count += 7 + QL_HELP[i].nl_count;
693
694 /* If we have an exact match, exit. Fixes \h SELECT */
695 if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
696 break;
697 }
698 }
699 /* If no matches, don't open the output yet */
700 if (nl_count == 0)
701 continue;
702
703 if (!output)
704 output = PageOutput(nl_count, pager ? &(pset.popt.topt) : NULL);
705
706 for (i = 0; QL_HELP[i].cmd; i++)
707 {
708 if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
709 strcmp(topic, "*") == 0)
710 {
711 PQExpBufferData buffer;
712 char *url;
713
714 initPQExpBuffer(&buffer);
715 QL_HELP[i].syntaxfunc(&buffer);
716 url = psprintf("https://www.postgresql.org/docs/%s/%s.html",
717 strstr(PG_VERSION, "devel") ? "devel" : PG_MAJORVERSION,
718 QL_HELP[i].docbook_id);
719 /* # of newlines in format must match constant above! */
720 fprintf(output, _("Command: %s\n"
721 "Description: %s\n"
722 "Syntax:\n%s\n\n"
723 "URL: %s\n\n"),
724 QL_HELP[i].cmd,
725 _(QL_HELP[i].help),
726 buffer.data,
727 url);
728 free(url);
729 termPQExpBuffer(&buffer);
730
731 /* If we have an exact match, exit. Fixes \h SELECT */
732 if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
733 break;
734 }
735 }
736 break;
737 }
738
739 /* If we never found anything, report that */
740 if (!output)
741 {
742 output = PageOutput(2, pager ? &(pset.popt.topt) : NULL);
743 fprintf(output, _("No help available for \"%s\".\n"
744 "Try \\h with no arguments to see available help.\n"),
745 topic);
746 }
747
748 ClosePager(output);
749 }
750}
help
static void help(void)
Definition pg_config.c:71
Max
#define Max(x, y)
Definition c.h:1087
fprintf
#define fprintf(file, fmt, msg)
Definition cubescan.l:21
_
#define _(x)
Definition elog.c:95
PageOutput
FILE * PageOutput(int lines, const printTableOpt *topt)
Definition print.c:3078
ClosePager
void ClosePager(FILE *pagerpipe)
Definition print.c:3160
VALUE_OR_NULL
#define VALUE_OR_NULL(a)
output
FILE * output
Definition pg_test_timing.c:235
j
int j
Definition isn.c:78
i
int i
Definition isn.c:77
len
const void size_t len
Definition pg_crc32c_sse42.c:31
pg_strcasecmp
int pg_strcasecmp(const char *s1, const char *s2)
Definition pgstrcasecmp.c:32
pg_strncasecmp
int pg_strncasecmp(const char *s1, const char *s2, size_t n)
Definition pgstrcasecmp.c:65
initPQExpBuffer
void initPQExpBuffer(PQExpBuffer str)
Definition pqexpbuffer.c:90
termPQExpBuffer
void termPQExpBuffer(PQExpBuffer str)
Definition pqexpbuffer.c:129
fb
static int fb(int x)
Definition preproc-init.c:92
psprintf
char * psprintf(const char *fmt,...)
Definition psprintf.c:43
pset
PsqlSettings pset
Definition startup.c:32
free
#define free(a)
Definition snowball_runtime.h:65
_psqlSettings::popt
printQueryOpt popt
Definition settings.h:112
printQueryOpt::topt
printTableOpt topt
Definition print.h:185

References _, ClosePager(), PQExpBufferData::data, fb(), fprintf, free, help(), i, initPQExpBuffer(), j, len, Max, output, PageOutput(), pg_strcasecmp(), pg_strncasecmp(), _psqlSettings::popt, pset, psprintf(), termPQExpBuffer(), printQueryOpt::topt, and VALUE_OR_NULL.

Referenced by exec_command_help().

◆ helpVariables()

void helpVariables ( unsigned short int  pager)

Definition at line 370 of file help.c.

371{
372 PQExpBufferData buf;
373 int nlcount;
374 FILE *output;
375
376 /*
377 * To avoid counting the output lines manually, build the output in "buf"
378 * and then count them.
379 */
380 initPQExpBuffer(&buf);
381
382 HELP0("List of specially treated variables\n\n");
383
384 HELP0("psql variables:\n");
385 HELP0("Usage:\n");
386 HELP0(" psql --set=NAME=VALUE\n or \\set NAME VALUE inside psql\n\n");
387
388 HELP0(" AUTOCOMMIT\n"
389 " if set, successful SQL commands are automatically committed\n");
390 HELP0(" COMP_KEYWORD_CASE\n"
391 " determines the case used to complete SQL key words\n"
392 " [lower, upper, preserve-lower, preserve-upper]\n");
393 HELP0(" DBNAME\n"
394 " the currently connected database name\n");
395 HELP0(" ECHO\n"
396 " controls what input is written to standard output\n"
397 " [all, errors, none, queries]\n");
398 HELP0(" ECHO_HIDDEN\n"
399 " if set, display internal queries executed by backslash commands;\n"
400 " if set to \"noexec\", just show them without execution\n");
401 HELP0(" ENCODING\n"
402 " current client character set encoding\n");
403 HELP0(" ERROR\n"
404 " \"true\" if last query failed, else \"false\"\n");
405 HELP0(" FETCH_COUNT\n"
406 " the number of result rows to fetch and display at a time (0 = unlimited)\n");
407 HELP0(" HIDE_TABLEAM\n"
408 " if set, table access methods are not displayed\n");
409 HELP0(" HIDE_TOAST_COMPRESSION\n"
410 " if set, compression methods are not displayed\n");
411 HELP0(" HISTCONTROL\n"
412 " controls command history [ignorespace, ignoredups, ignoreboth]\n");
413 HELP0(" HISTFILE\n"
414 " file name used to store the command history\n");
415 HELP0(" HISTSIZE\n"
416 " maximum number of commands to store in the command history\n");
417 HELP0(" HOST\n"
418 " the currently connected database server host\n");
419 HELP0(" IGNOREEOF\n"
420 " number of EOFs needed to terminate an interactive session\n");
421 HELP0(" LASTOID\n"
422 " value of the last affected OID\n");
423 HELP0(" LAST_ERROR_MESSAGE\n"
424 " LAST_ERROR_SQLSTATE\n"
425 " message and SQLSTATE of last error, or empty string and \"00000\" if none\n");
426 HELP0(" ON_ERROR_ROLLBACK\n"
427 " if set, an error doesn't stop a transaction (uses implicit savepoints)\n");
428 HELP0(" ON_ERROR_STOP\n"
429 " stop batch execution after error\n");
430 HELP0(" PORT\n"
431 " server port of the current connection\n");
432 HELP0(" PROMPT1\n"
433 " specifies the standard psql prompt\n");
434 HELP0(" PROMPT2\n"
435 " specifies the prompt used when a statement continues from a previous line\n");
436 HELP0(" PROMPT3\n"
437 " specifies the prompt used during COPY ... FROM STDIN\n");
438 HELP0(" QUIET\n"
439 " run quietly (same as -q option)\n");
440 HELP0(" ROW_COUNT\n"
441 " number of rows returned or affected by last query, or 0\n");
442 HELP0(" SERVER_VERSION_NAME\n"
443 " SERVER_VERSION_NUM\n"
444 " server's version (in short string or numeric format)\n");
445 HELP0(" SHELL_ERROR\n"
446 " \"true\" if the last shell command failed, \"false\" if it succeeded\n");
447 HELP0(" SHELL_EXIT_CODE\n"
448 " exit status of the last shell command\n");
449 HELP0(" SHOW_ALL_RESULTS\n"
450 " show all results of a combined query (\\;) instead of only the last\n");
451 HELP0(" SHOW_CONTEXT\n"
452 " controls display of message context fields [never, errors, always]\n");
453 HELP0(" SINGLELINE\n"
454 " if set, end of line terminates SQL commands (same as -S option)\n");
455 HELP0(" SINGLESTEP\n"
456 " single-step mode (same as -s option)\n");
457 HELP0(" SQLSTATE\n"
458 " SQLSTATE of last query, or \"00000\" if no error\n");
459 HELP0(" USER\n"
460 " the currently connected database user\n");
461 HELP0(" VERBOSITY\n"
462 " controls verbosity of error reports [default, verbose, terse, sqlstate]\n");
463 HELP0(" VERSION\n"
464 " VERSION_NAME\n"
465 " VERSION_NUM\n"
466 " psql's version (in verbose string, short string, or numeric format)\n");
467 HELPN(" WATCH_INTERVAL\n"
468 " number of seconds \\watch waits between executions (default %s)\n",
469 DEFAULT_WATCH_INTERVAL);
470
471 HELP0("\nDisplay settings:\n");
472 HELP0("Usage:\n");
473 HELP0(" psql --pset=NAME[=VALUE]\n or \\pset NAME [VALUE] inside psql\n\n");
474
475 HELP0(" border\n"
476 " border style (number)\n");
477 HELP0(" columns\n"
478 " target width for the wrapped format\n");
479 HELPN(" csv_fieldsep\n"
480 " field separator for CSV output format (default \"%c\")\n",
481 DEFAULT_CSV_FIELD_SEP);
482 HELP0(" display_false\n"
483 " set the string to be printed in place of a boolean 'false'\n");
484 HELP0(" display_true\n"
485 " set the string to be printed in place of a boolean 'true'\n");
486 HELP0(" expanded (or x)\n"
487 " expanded output [on, off, auto]\n");
488 HELPN(" fieldsep\n"
489 " field separator for unaligned output (default \"%s\")\n",
490 DEFAULT_FIELD_SEP);
491 HELP0(" fieldsep_zero\n"
492 " set field separator for unaligned output to a zero byte\n");
493 HELP0(" footer\n"
494 " enable or disable display of the table footer [on, off]\n");
495 HELP0(" format\n"
496 " set output format [unaligned, aligned, wrapped, html, asciidoc, ...]\n");
497 HELP0(" linestyle\n"
498 " set the border line drawing style [ascii, old-ascii, unicode]\n");
499 HELP0(" null\n"
500 " set the string to be printed in place of a null value\n");
501 HELP0(" numericlocale\n"
502 " enable display of a locale-specific character to separate groups of digits\n");
503 HELP0(" pager\n"
504 " control when an external pager is used [yes, no, always]\n");
505 HELP0(" recordsep\n"
506 " record (line) separator for unaligned output\n");
507 HELP0(" recordsep_zero\n"
508 " set record separator for unaligned output to a zero byte\n");
509 HELP0(" tableattr (or T)\n"
510 " specify attributes for table tag in html format, or proportional\n"
511 " column widths for left-aligned data types in latex-longtable format\n");
512 HELP0(" title\n"
513 " set the table title for subsequently printed tables\n");
514 HELP0(" tuples_only\n"
515 " if set, only actual table data is shown\n");
516 HELP0(" unicode_border_linestyle\n"
517 " unicode_column_linestyle\n"
518 " unicode_header_linestyle\n"
519 " set the style of Unicode line drawing [single, double]\n");
520 HELP0(" xheader_width\n"
521 " set the maximum width of the header for expanded output\n"
522 " [full, column, page, integer value]\n");
523
524 HELP0("\nEnvironment variables:\n");
525 HELP0("Usage:\n");
526
527#ifndef WIN32
528 HELP0(" NAME=VALUE [NAME=VALUE] psql ...\n or \\setenv NAME [VALUE] inside psql\n\n");
529#else
530 HELP0(" set NAME=VALUE\n psql ...\n or \\setenv NAME [VALUE] inside psql\n\n");
531#endif
532
533 HELP0(" COLUMNS\n"
534 " number of columns for wrapped format\n");
535 HELP0(" PGAPPNAME\n"
536 " same as the application_name connection parameter\n");
537 HELP0(" PGDATABASE\n"
538 " same as the dbname connection parameter\n");
539 HELP0(" PGHOST\n"
540 " same as the host connection parameter\n");
541 HELP0(" PGPASSFILE\n"
542 " password file name\n");
543 HELP0(" PGPASSWORD\n"
544 " connection password (not recommended)\n");
545 HELP0(" PGPORT\n"
546 " same as the port connection parameter\n");
547 HELP0(" PGUSER\n"
548 " same as the user connection parameter\n");
549 HELP0(" PSQL_EDITOR, EDITOR, VISUAL\n"
550 " editor used by the \\e, \\ef, and \\ev commands\n");
551 HELP0(" PSQL_EDITOR_LINENUMBER_ARG\n"
552 " how to specify a line number when invoking the editor\n");
553 HELP0(" PSQL_HISTORY\n"
554 " alternative location for the command history file\n");
555 HELP0(" PSQL_PAGER, PAGER\n"
556 " name of external pager program\n");
557#ifndef WIN32
558 HELP0(" PSQL_WATCH_PAGER\n"
559 " name of external pager program used for \\watch\n");
560#endif
561 HELP0(" PSQLRC\n"
562 " alternative location for the user's .psqlrc file\n");
563 HELP0(" SHELL\n"
564 " shell used by the \\! command\n");
565 HELP0(" TMPDIR\n"
566 " directory for temporary files\n");
567
568 /* Now we can count the lines. */
569 nlcount = 0;
570 for (const char *ptr = buf.data; *ptr; ptr++)
571 {
572 if (*ptr == '\n')
573 nlcount++;
574 }
575
576 /* And dump the output, with appropriate pagination. */
577 output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
578
579 fputs(buf.data, output);
580
581 ClosePager(output);
582
583 termPQExpBuffer(&buf);
584}
HELPN
#define HELPN(str,...)
Definition help.c:38
HELP0
#define HELP0(str)
Definition help.c:37
buf
static char buf[DEFAULT_XLOG_SEG_SIZE]
Definition pg_test_fsync.c:71
DEFAULT_FIELD_SEP
#define DEFAULT_FIELD_SEP
Definition settings.h:15
DEFAULT_WATCH_INTERVAL
#define DEFAULT_WATCH_INTERVAL
Definition settings.h:30
DEFAULT_CSV_FIELD_SEP
#define DEFAULT_CSV_FIELD_SEP
Definition settings.h:14

References buf, ClosePager(), DEFAULT_CSV_FIELD_SEP, DEFAULT_FIELD_SEP, DEFAULT_WATCH_INTERVAL, fb(), HELP0, HELPN, initPQExpBuffer(), output, PageOutput(), _psqlSettings::popt, pset, termPQExpBuffer(), and printQueryOpt::topt.

Referenced by exec_command_slash_command_help(), and parse_psql_options().

◆ print_copyright()

void print_copyright ( void  )

Definition at line 755 of file help.c.

756{
757 puts("PostgreSQL Database Management System\n"
758 "(also known as Postgres, formerly known as Postgres95)\n\n"
759 "Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group\n\n"
760 "Portions Copyright (c) 1994, The Regents of the University of California\n\n"
761 "Permission to use, copy, modify, and distribute this software and its\n"
762 "documentation for any purpose, without fee, and without a written agreement\n"
763 "is hereby granted, provided that the above copyright notice and this\n"
764 "paragraph and the following two paragraphs appear in all copies.\n\n"
765 "IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR\n"
766 "DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING\n"
767 "LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS\n"
768 "DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE\n"
769 "POSSIBILITY OF SUCH DAMAGE.\n\n"
770 "THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,\n"
771 "INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\n"
772 "AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS\n"
773 "ON AN \"AS IS\" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO\n"
774 "PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n");
775}

References fb().

Referenced by exec_command_copyright().

◆ slashUsage()

void slashUsage ( unsigned short int  pager)

Definition at line 148 of file help.c.

149{
150 PQExpBufferData buf;
151 int nlcount;
152 FILE *output;
153 char *currdb;
154
155 currdb = PQdb(pset.db);
156
157 /*
158 * To avoid counting the output lines manually, build the output in "buf"
159 * and then count them.
160 */
161 initPQExpBuffer(&buf);
162
163 HELP0("General\n");
164 HELP0(" \\copyright show PostgreSQL usage and distribution terms\n");
165 HELP0(" \\crosstabview [COLUMNS] execute query and display result in crosstab\n");
166 HELP0(" \\errverbose show most recent error message at maximum verbosity\n");
167 HELP0(" \\g [(OPTIONS)] [FILE] execute query (and send result to file or |pipe);\n"
168 " \\g with no arguments is equivalent to a semicolon\n");
169 HELP0(" \\gdesc describe result of query, without executing it\n");
170 HELP0(" \\gexec execute query, then execute each value in its result\n");
171 HELP0(" \\gset [PREFIX] execute query and store result in psql variables\n");
172 HELP0(" \\gx [(OPTIONS)] [FILE] as \\g, but forces expanded output mode\n");
173 HELP0(" \\q quit psql\n");
174 HELP0(" \\restrict RESTRICT_KEY\n"
175 " enter restricted mode with provided key\n");
176 HELP0(" \\unrestrict RESTRICT_KEY\n"
177 " exit restricted mode if key matches\n");
178 HELP0(" \\watch [[i=]SEC] [c=N] [m=MIN]\n"
179 " execute query every SEC seconds, up to N times,\n"
180 " stop if less than MIN rows are returned\n");
181 HELP0("\n");
182
183 HELP0("Help\n");
184
185 HELP0(" \\? [commands] show help on backslash commands\n");
186 HELP0(" \\? options show help on psql command-line options\n");
187 HELP0(" \\? variables show help on special variables\n");
188 HELP0(" \\h [NAME] help on syntax of SQL commands, * for all commands\n");
189 HELP0("\n");
190
191 HELP0("Query Buffer\n");
192 HELP0(" \\e [FILE] [LINE] edit the query buffer (or file) with external editor\n");
193 HELP0(" \\ef [FUNCNAME [LINE]] edit function definition with external editor\n");
194 HELP0(" \\ev [VIEWNAME [LINE]] edit view definition with external editor\n");
195 HELP0(" \\p show the contents of the query buffer\n");
196 HELP0(" \\r reset (clear) the query buffer\n");
197#ifdef USE_READLINE
198 HELP0(" \\s [FILE] display history or save it to file\n");
199#endif
200 HELP0(" \\w FILE write query buffer to file\n");
201 HELP0("\n");
202
203 HELP0("Input/Output\n");
204 HELP0(" \\copy ... perform SQL COPY with data stream to the client host\n");
205 HELP0(" \\echo [-n] [STRING] write string to standard output (-n for no newline)\n");
206 HELP0(" \\i FILE execute commands from file\n");
207 HELP0(" \\ir FILE as \\i, but relative to location of current script\n");
208 HELP0(" \\o [FILE] send all query results to file or |pipe\n");
209 HELP0(" \\qecho [-n] [STRING] write string to \\o output stream (-n for no newline)\n");
210 HELP0(" \\warn [-n] [STRING] write string to standard error (-n for no newline)\n");
211 HELP0("\n");
212
213 HELP0("Conditional\n");
214 HELP0(" \\if EXPR begin conditional block\n");
215 HELP0(" \\elif EXPR alternative within current conditional block\n");
216 HELP0(" \\else final alternative within current conditional block\n");
217 HELP0(" \\endif end conditional block\n");
218 HELP0("\n");
219
220 HELP0("Informational\n");
221 HELP0(" (options: S = show system objects, x = expanded mode, + = additional detail)\n");
222 HELP0(" \\d[Sx+] list tables, views, sequences, and property graphs\n");
223 HELP0(" \\d[S+] NAME describe table, view, sequence, index, or property graph\n");
224 HELP0(" \\da[Sx] [PATTERN] list aggregates\n");
225 HELP0(" \\dA[x+] [PATTERN] list access methods\n");
226 HELP0(" \\dAc[x+] [AMPTRN [TYPEPTRN]] list operator classes\n");
227 HELP0(" \\dAf[x+] [AMPTRN [TYPEPTRN]] list operator families\n");
228 HELP0(" \\dAo[x+] [AMPTRN [OPFPTRN]] list operators of operator families\n");
229 HELP0(" \\dAp[x+] [AMPTRN [OPFPTRN]] list support functions of operator families\n");
230 HELP0(" \\db[x+] [PATTERN] list tablespaces\n");
231 HELP0(" \\dc[Sx+] [PATTERN] list conversions\n");
232 HELP0(" \\dconfig[x+] [PATTERN] list configuration parameters\n");
233 HELP0(" \\dC[x+] [PATTERN] list casts\n");
234 HELP0(" \\dd[Sx] [PATTERN] show object descriptions not displayed elsewhere\n");
235 HELP0(" \\dD[Sx+] [PATTERN] list domains\n");
236 HELP0(" \\ddp[x] [PATTERN] list default privileges\n");
237 HELP0(" \\dE[Sx+] [PATTERN] list foreign tables\n");
238 HELP0(" \\des[x+] [PATTERN] list foreign servers\n");
239 HELP0(" \\det[x+] [PATTERN] list foreign tables\n");
240 HELP0(" \\deu[x+] [PATTERN] list user mappings\n");
241 HELP0(" \\dew[x+] [PATTERN] list foreign-data wrappers\n");
242 HELP0(" \\df[anptw][Sx+] [FUNCPTRN [TYPEPTRN ...]]\n"
243 " list [only agg/normal/procedure/trigger/window] functions\n");
244 HELP0(" \\dF[x+] [PATTERN] list text search configurations\n");
245 HELP0(" \\dFd[x+] [PATTERN] list text search dictionaries\n");
246 HELP0(" \\dFp[x+] [PATTERN] list text search parsers\n");
247 HELP0(" \\dFt[x+] [PATTERN] list text search templates\n");
248 HELP0(" \\dg[Sx+] [PATTERN] list roles\n");
249 HELP0(" \\dG[Sx+] [PATTERN] list property graphs\n");
250 HELP0(" \\di[Sx+] [PATTERN] list indexes\n");
251 HELP0(" \\dl[x+] list large objects, same as \\lo_list\n");
252 HELP0(" \\dL[Sx+] [PATTERN] list procedural languages\n");
253 HELP0(" \\dm[Sx+] [PATTERN] list materialized views\n");
254 HELP0(" \\dn[Sx+] [PATTERN] list schemas\n");
255 HELP0(" \\do[Sx+] [OPPTRN [TYPEPTRN [TYPEPTRN]]]\n"
256 " list operators\n");
257 HELP0(" \\dO[Sx+] [PATTERN] list collations\n");
258 HELP0(" \\dp[Sx] [PATTERN] list table, view, and sequence access privileges\n");
259 HELP0(" \\dP[itnx+] [PATTERN] list [only index/table] partitioned relations [n=nested]\n");
260 HELP0(" \\drds[x] [ROLEPTRN [DBPTRN]]\n"
261 " list per-database role settings\n");
262 HELP0(" \\drg[Sx] [PATTERN] list role grants\n");
263 HELP0(" \\dRp[x+] [PATTERN] list replication publications\n");
264 HELP0(" \\dRs[x+] [PATTERN] list replication subscriptions\n");
265 HELP0(" \\ds[Sx+] [PATTERN] list sequences\n");
266 HELP0(" \\dt[Sx+] [PATTERN] list tables\n");
267 HELP0(" \\dT[Sx+] [PATTERN] list data types\n");
268 HELP0(" \\du[Sx+] [PATTERN] list roles\n");
269 HELP0(" \\dv[Sx+] [PATTERN] list views\n");
270 HELP0(" \\dx[x+] [PATTERN] list extensions\n");
271 HELP0(" \\dX[x+] [PATTERN] list extended statistics\n");
272 HELP0(" \\dy[x+] [PATTERN] list event triggers\n");
273 HELP0(" \\l[x+] [PATTERN] list databases\n");
274 HELP0(" \\sf[+] FUNCNAME show a function's definition\n");
275 HELP0(" \\sv[+] VIEWNAME show a view's definition\n");
276 HELP0(" \\z[Sx] [PATTERN] same as \\dp\n");
277 HELP0("\n");
278
279 HELP0("Large Objects\n");
280 HELP0(" \\lo_export LOBOID FILE write large object to file\n");
281 HELP0(" \\lo_import FILE [COMMENT]\n"
282 " read large object from file\n");
283 HELP0(" \\lo_list[x+] list large objects\n");
284 HELP0(" \\lo_unlink LOBOID delete a large object\n");
285 HELP0("\n");
286
287 HELP0("Formatting\n");
288 HELP0(" \\a toggle between unaligned and aligned output mode\n");
289 HELP0(" \\C [STRING] set table title, or unset if none\n");
290 HELP0(" \\f [STRING] show or set field separator for unaligned query output\n");
291 HELPN(" \\H toggle HTML output mode (currently %s)\n",
292 ON(pset.popt.topt.format == PRINT_HTML));
293 HELP0(" \\pset [NAME [VALUE]] set table output option\n"
294 " see \"\\? variables\" for valid options\n");
295 HELPN(" \\t [on|off] show only rows (currently %s)\n",
296 ON(pset.popt.topt.tuples_only));
297 HELP0(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n");
298 HELPN(" \\x [on|off|auto] toggle expanded output (currently %s)\n",
299 pset.popt.topt.expanded == 2 ? _("auto") : ON(pset.popt.topt.expanded));
300 HELP0("\n");
301
302 HELP0("Connection\n");
303 if (currdb)
304 HELPN(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
305 " connect to new database (currently \"%s\")\n",
306 currdb);
307 else
308 HELP0(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
309 " connect to new database (currently no connection)\n");
310 HELP0(" \\conninfo display information about current connection\n");
311 HELP0(" \\encoding [ENCODING] show or set client encoding\n");
312 HELP0(" \\password [USERNAME] securely change the password for a user\n");
313 HELP0("\n");
314
315 HELP0("Operating System\n");
316 HELP0(" \\cd [DIR] change the current working directory\n");
317 HELP0(" \\getenv PSQLVAR ENVVAR fetch environment variable\n");
318 HELP0(" \\setenv NAME [VALUE] set or unset environment variable\n");
319 HELPN(" \\timing [on|off] toggle timing of commands (currently %s)\n",
320 ON(pset.timing));
321 HELP0(" \\! [COMMAND] execute command in shell or start interactive shell\n");
322 HELP0("\n");
323
324 HELP0("Variables\n");
325 HELP0(" \\prompt [TEXT] NAME prompt user to set internal variable\n");
326 HELP0(" \\set [NAME [VALUE]] set internal variable, or list all if no parameters\n");
327 HELP0(" \\unset NAME unset (delete) internal variable\n");
328 HELP0("\n");
329
330 HELP0("Extended Query Protocol\n");
331 HELP0(" \\bind [PARAM]... set query parameters\n");
332 HELP0(" \\bind_named STMT_NAME [PARAM]...\n"
333 " set query parameters for an existing prepared statement\n");
334 HELP0(" \\close_prepared STMT_NAME\n"
335 " close an existing prepared statement\n");
336 HELP0(" \\endpipeline exit pipeline mode\n");
337 HELP0(" \\flush flush output data to the server\n");
338 HELP0(" \\flushrequest send request to the server to flush its output buffer\n");
339 HELP0(" \\getresults [NUM_RES] read NUM_RES pending results, or all if no argument\n");
340 HELP0(" \\parse STMT_NAME create a prepared statement\n");
341 HELP0(" \\sendpipeline send an extended query to an ongoing pipeline\n");
342 HELP0(" \\startpipeline enter pipeline mode\n");
343 HELP0(" \\syncpipeline add a synchronisation point to an ongoing pipeline\n");
344
345 /* Now we can count the lines. */
346 nlcount = 0;
347 for (const char *ptr = buf.data; *ptr; ptr++)
348 {
349 if (*ptr == '\n')
350 nlcount++;
351 }
352
353 /* And dump the output, with appropriate pagination. */
354 output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
355
356 fputs(buf.data, output);
357
358 ClosePager(output);
359
360 termPQExpBuffer(&buf);
361}
PQdb
char * PQdb(const PGconn *conn)
Definition fe-connect.c:7571
PRINT_HTML
@ PRINT_HTML
Definition print.h:34
ON
#define ON(var)
Definition help.c:39
_psqlSettings::timing
bool timing
Definition settings.h:147
_psqlSettings::db
PGconn * db
Definition settings.h:103
printTableOpt::expanded
unsigned short int expanded
Definition print.h:114
printTableOpt::tuples_only
bool tuples_only
Definition print.h:126
printTableOpt::format
enum printFormat format
Definition print.h:113

References _, buf, ClosePager(), _psqlSettings::db, printTableOpt::expanded, fb(), 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().

◆ usage()

void usage ( unsigned short int  pager)

Definition at line 48 of file help.c.

49{
50 PQExpBufferData buf;
51 int nlcount;
52 FILE *output;
53
54 /*
55 * To avoid counting the output lines manually, build the output in "buf"
56 * and then count them.
57 */
58 initPQExpBuffer(&buf);
59
60 HELP0("psql is the PostgreSQL interactive terminal.\n\n");
61 HELP0("Usage:\n");
62 HELP0(" psql [OPTION]... [DBNAME [USERNAME]]\n\n");
63
64 HELP0("General options:\n");
65 HELP0(" -c, --command=COMMAND run only single command (SQL or internal) and exit\n");
66 HELP0(" -d, --dbname=DBNAME database name to connect to\n");
67 HELP0(" -f, --file=FILENAME execute commands from file, then exit\n");
68 HELP0(" -l, --list list available databases, then exit\n");
69 HELP0(" -v, --set=, --variable=NAME=VALUE\n"
70 " set psql variable NAME to VALUE\n"
71 " (e.g., -v ON_ERROR_STOP=1)\n");
72 HELP0(" -V, --version output version information, then exit\n");
73 HELP0(" -X, --no-psqlrc do not read startup file (~/.psqlrc)\n");
74 HELP0(" -1 (\"one\"), --single-transaction\n"
75 " execute as a single transaction (if non-interactive)\n");
76 HELP0(" -?, --help[=options] show this help, then exit\n");
77 HELP0(" --help=commands list backslash commands, then exit\n");
78 HELP0(" --help=variables list special variables, then exit\n");
79
80 HELP0("\nInput and output options:\n");
81 HELP0(" -a, --echo-all echo all input from script\n");
82 HELP0(" -b, --echo-errors echo failed commands\n");
83 HELP0(" -e, --echo-queries echo commands sent to server\n");
84 HELP0(" -E, --echo-hidden display queries that internal commands generate\n");
85 HELP0(" -L, --log-file=FILENAME send session log to file\n");
86 HELP0(" -n, --no-readline disable enhanced command line editing (readline)\n");
87 HELP0(" -o, --output=FILENAME send query results to file (or |pipe)\n");
88 HELP0(" -q, --quiet run quietly (no messages, only query output)\n");
89 HELP0(" -s, --single-step single-step mode (confirm each query)\n");
90 HELP0(" -S, --single-line single-line mode (end of line terminates SQL command)\n");
91
92 HELP0("\nOutput format options:\n");
93 HELP0(" -A, --no-align unaligned table output mode\n");
94 HELP0(" --csv CSV (Comma-Separated Values) table output mode\n");
95 HELPN(" -F, --field-separator=STRING\n"
96 " field separator for unaligned output (default: \"%s\")\n",
97 DEFAULT_FIELD_SEP);
98 HELP0(" -H, --html HTML table output mode\n");
99 HELP0(" -P, --pset=VAR[=ARG] set printing option VAR to ARG (see \\pset command)\n");
100 HELP0(" -R, --record-separator=STRING\n"
101 " record separator for unaligned output (default: newline)\n");
102 HELP0(" -t, --tuples-only print rows only\n");
103 HELP0(" -T, --table-attr=TEXT set HTML table tag attributes (e.g., width, border)\n");
104 HELP0(" -x, --expanded turn on expanded table output\n");
105 HELP0(" -z, --field-separator-zero\n"
106 " set field separator for unaligned output to zero byte\n");
107 HELP0(" -0, --record-separator-zero\n"
108 " set record separator for unaligned output to zero byte\n");
109
110 HELP0("\nConnection options:\n");
111 HELP0(" -h, --host=HOSTNAME database server host or socket directory\n");
112 HELP0(" -p, --port=PORT database server port\n");
113 HELP0(" -U, --username=USERNAME database user name\n");
114 HELP0(" -w, --no-password never prompt for password\n");
115 HELP0(" -W, --password force password prompt (should happen automatically)\n");
116
117 HELP0("\nFor more information, type \"\\?\" (for internal commands) or \"\\help\" (for SQL\n"
118 "commands) from within psql, or consult the psql section in the PostgreSQL\n"
119 "documentation.\n\n");
120 HELPN("Report bugs to <%s>.\n", PACKAGE_BUGREPORT);
121 HELPN("%s home page: <%s>\n", PACKAGE_NAME, PACKAGE_URL);
122
123 /* Now we can count the lines. */
124 nlcount = 0;
125 for (const char *ptr = buf.data; *ptr; ptr++)
126 {
127 if (*ptr == '\n')
128 nlcount++;
129 }
130
131 /* And dump the output, with appropriate pagination. */
132 output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
133
134 fputs(buf.data, output);
135
136 ClosePager(output);
137
138 termPQExpBuffer(&buf);
139}

References buf, ClosePager(), DEFAULT_FIELD_SEP, fb(), HELP0, HELPN, initPQExpBuffer(), output, PageOutput(), _psqlSettings::popt, pset, termPQExpBuffer(), and printQueryOpt::topt.