psql-ref.sgml 104 KB
Newer Older
1
<!--
2
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.174 2006/10/31 02:29:15 tgl Exp $
3
PostgreSQL documentation
4 5
-->

6
<refentry id="APP-PSQL">
7
  <refmeta>
8 9
    <refentrytitle id="app-psql-title"><application>psql</application></refentrytitle>
    <manvolnum>1</manvolnum>
10 11 12 13
    <refmiscinfo>Application</refmiscinfo>
  </refmeta>

  <refnamediv>
14
    <refname><application>psql</application></refname>
15
    <refpurpose>
16
      <productname>PostgreSQL</productname> interactive terminal
17 18 19
    </refpurpose>
  </refnamediv>

Peter Eisentraut's avatar
Peter Eisentraut committed
20 21 22 23
 <indexterm zone="app-psql">
  <primary>psql</primary>
 </indexterm>

24 25 26
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>psql</command>
27
   <arg rep="repeat"><replaceable class="parameter">option</replaceable></arg>
28
   <arg><replaceable class="parameter">dbname</replaceable>
29
   <arg><replaceable class="parameter">username</replaceable></arg></arg>
30 31
  </cmdsynopsis>
 </refsynopsisdiv>
32

33 34
 <refsect1>
  <title>Description</title>
35

36
    <para>
37 38 39 40 41 42 43
     <application>psql</application> is a terminal-based front-end to
     <productname>PostgreSQL</productname>. It enables you to type in
     queries interactively, issue them to
     <productname>PostgreSQL</productname>, and see the query results.
     Alternatively, input can be from a file. In addition, it provides a
     number of meta-commands and various shell-like features to
     facilitate writing scripts and automating a wide variety of tasks.
44
    </para>
45
 </refsect1>
46

47 48
 <refsect1 id="R1-APP-PSQL-3">
  <title>Options</title>
49

50 51
  <variablelist>
    <varlistentry>
52 53
      <term><option>-a</></term>
      <term><option>--echo-all</></term>
54 55
      <listitem>
      <para>
56
      Print all input lines to standard output as they are read. This is more
57
      useful for script processing rather than interactive mode. This is
58
      equivalent to setting the variable <varname>ECHO</varname> to
59 60 61 62
      <literal>all</literal>.
      </para>
      </listitem>
    </varlistentry>
63

64
    <varlistentry>
65 66
      <term><option>-A</></term>
      <term><option>--no-align</></term>
67 68 69 70 71 72 73
      <listitem>
      <para>
      Switches to unaligned output mode. (The default output mode is
      otherwise aligned.)
      </para>
      </listitem>
    </varlistentry>
74

75
    <varlistentry>
76 77
      <term><option>-c <replaceable class="parameter">command</replaceable></></term>
      <term><option>--command <replaceable class="parameter">command</replaceable></></term>
78 79 80
      <listitem>
      <para>
      Specifies that <application>psql</application> is to execute one
81
      command string, <replaceable class="parameter">command</replaceable>,
82 83 84
      and then exit. This is useful in shell scripts.
      </para>
      <para>
85 86
      <replaceable class="parameter">command</replaceable> must be either
      a command string that is completely parsable by the server (i.e.,
87
      it contains no <application>psql</application> specific features),
88
      or a single backslash command. Thus you cannot mix
89 90 91 92
      <acronym>SQL</acronym> and <application>psql</application>
      meta-commands. To achieve that, you could pipe the string into
      <application>psql</application>, like this: <literal>echo "\x \\
      select * from foo;" | psql</literal>.
93 94
      </para>
      <para>
95 96
       If the command string contains multiple SQL commands, they are
       processed in a single transaction, unless there are explicit
97 98 99 100
       <command>BEGIN</>/<command>COMMIT</> commands included in the
       string to divide it into multiple transactions.  This is
       different from the behavior when the same string is fed to
       <application>psql</application>'s standard input.
101 102 103
      </para>
      </listitem>
    </varlistentry>
104

105
    <varlistentry>
106 107
      <term><option>-d <replaceable class="parameter">dbname</replaceable></></term>
      <term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term>
108 109 110 111 112 113 114 115 116
      <listitem>
      <para>
      Specifies the name of the database to connect to. This is
      equivalent to specifying <replaceable
      class="parameter">dbname</replaceable> as the first non-option
      argument on the command line.
      </para>
      </listitem>
    </varlistentry>
117

118
    <varlistentry>
119 120
      <term><option>-e</></term>
      <term><option>--echo-queries</></term>
121 122
      <listitem>
      <para>
123 124
      Copy all SQL commands sent to the server to standard output as well.
      This is equivalent
125
      to setting the variable <varname>ECHO</varname> to
126 127 128 129
      <literal>queries</literal>.
      </para>
      </listitem>
    </varlistentry>
130

131
    <varlistentry>
132 133
      <term><option>-E</></term>
      <term><option>--echo-hidden</></term>
134 135
      <listitem>
      <para>
136
      Echo the actual queries generated by <command>\d</command> and other backslash
137 138
      commands. You can use this to study <application>psql</application>'s
      internal operations. This is equivalent to
139
      setting the variable <varname>ECHO_HIDDEN</varname> from within
140 141 142 143
      <application>psql</application>.
      </para>
      </listitem>
    </varlistentry>
144

145
    <varlistentry>
146 147
      <term><option>-f <replaceable class="parameter">filename</replaceable></></term>
      <term><option>--file <replaceable class="parameter">filename</replaceable></></term>
148 149 150
      <listitem>
      <para>
      Use the file <replaceable class="parameter">filename</replaceable>
151
      as the source of commands instead of reading commands interactively.
152 153 154 155
      After the file is processed, <application>psql</application>
      terminates. This is in many ways equivalent to the internal
      command <command>\i</command>.
      </para>
156

157 158 159 160
      <para>
       If <replaceable>filename</replaceable> is <literal>-</literal>
       (hyphen), then standard input is read.
      </para>
161

162 163 164 165 166 167 168 169 170 171 172 173 174 175
      <para>
      Using this option is subtly different from writing <literal>psql
      &lt; <replaceable
      class="parameter">filename</replaceable></literal>. In general,
      both will do what you expect, but using <literal>-f</literal>
      enables some nice features such as error messages with line
      numbers. There is also a slight chance that using this option will
      reduce the start-up overhead. On the other hand, the variant using
      the shell's input redirection is (in theory) guaranteed to yield
      exactly the same output that you would have gotten had you entered
      everything by hand.
      </para>
      </listitem>
    </varlistentry>
Bruce Momjian's avatar
Bruce Momjian committed
176

177
    <varlistentry>
178 179
      <term><option>-F <replaceable class="parameter">separator</replaceable></></term>
      <term><option>--field-separator <replaceable class="parameter">separator</replaceable></></term>
180 181 182
      <listitem>
      <para>
      Use <replaceable class="parameter">separator</replaceable> as the
183 184
      field separator for unaligned output. This is equivalent to
      <command>\pset fieldsep</command> or <command>\f</command>.
185 186 187
      </para>
      </listitem>
    </varlistentry>
188

189
    <varlistentry>
190 191
      <term><option>-h <replaceable class="parameter">hostname</replaceable></></term>
      <term><option>--host <replaceable class="parameter">hostname</replaceable></></term>
192 193 194
      <listitem>
      <para>
      Specifies the host name of the machine on which the
195
      server is running. If the value begins
196
      with a slash, it is used as the directory for the Unix-domain
197 198 199 200
      socket.
      </para>
      </listitem>
    </varlistentry>
201

202
    <varlistentry>
203 204
      <term><option>-H</></term>
      <term><option>--html</></term>
205 206
      <listitem>
      <para>
207
      Turn on <acronym>HTML</acronym> tabular output. This is
208 209 210 211 212
      equivalent to <literal>\pset format html</literal> or the
      <command>\H</command> command.
      </para>
      </listitem>
    </varlistentry>
213

214
    <varlistentry>
215 216
      <term><option>-l</></term>
      <term><option>--list</></term>
217 218
      <listitem>
      <para>
219
      List all available databases, then exit. Other non-connection
220 221 222 223 224
      options are ignored. This is similar to the internal command
      <command>\list</command>.
      </para>
      </listitem>
    </varlistentry>
225

226 227
    <varlistentry>
      <term><option>-L <replaceable class="parameter">filename</replaceable></></term>
228
      <term><option>--log-file <replaceable class="parameter">filename</replaceable></></term>
229 230
      <listitem>
      <para>
231 232 233
       Write all query output into file <replaceable
       class="parameter">filename</replaceable>, in addition to the
       normal output destination.
234 235 236 237
      </para>
      </listitem>
    </varlistentry>

238
    <varlistentry>
239 240
      <term><option>-o <replaceable class="parameter">filename</replaceable></></term>
      <term><option>--output <replaceable class="parameter">filename</replaceable></></term>
241 242 243 244 245 246 247 248
      <listitem>
      <para>
      Put all query output into file <replaceable
      class="parameter">filename</replaceable>. This is equivalent to
      the command <command>\o</command>.
      </para>
      </listitem>
    </varlistentry>
249

250
    <varlistentry>
251 252
      <term><option>-p <replaceable class="parameter">port</replaceable></></term>
      <term><option>--port <replaceable class="parameter">port</replaceable></></term>
253 254
      <listitem>
      <para>
255
      Specifies the TCP port or the local Unix-domain
256
      socket file extension on which the server is listening for
257 258 259 260 261 262
      connections. Defaults to the value of the <envar>PGPORT</envar>
      environment variable or, if not set, to the port specified at
      compile time, usually 5432.
      </para>
      </listitem>
    </varlistentry>
263

264
    <varlistentry>
265 266
      <term><option>-P <replaceable class="parameter">assignment</replaceable></></term>
      <term><option>--pset <replaceable class="parameter">assignment</replaceable></></term>
267 268 269 270 271 272 273 274 275 276
      <listitem>
      <para>
      Allows you to specify printing options in the style of
      <command>\pset</command> on the command line. Note that here you
      have to separate name and value with an equal sign instead of a
      space. Thus to set the output format to LaTeX, you could write
      <literal>-P format=latex</literal>.
      </para>
      </listitem>
    </varlistentry>
277

278
    <varlistentry>
279 280
      <term><option>-q</></term>
      <term><option>--quiet</></term>
281 282 283 284 285 286 287
      <listitem>
      <para>
      Specifies that <application>psql</application> should do its work
      quietly. By default, it prints welcome messages and various
      informational output. If this option is used, none of this
      happens. This is useful with the <option>-c</option> option.
      Within <application>psql</application> you can also set the
288
      <varname>QUIET</varname> variable to achieve the same effect.
289 290 291
      </para>
      </listitem>
    </varlistentry>
292

293
    <varlistentry>
294 295
      <term><option>-R <replaceable class="parameter">separator</replaceable></></term>
      <term><option>--record-separator <replaceable class="parameter">separator</replaceable></></term>
296 297 298
      <listitem>
      <para>
      Use <replaceable class="parameter">separator</replaceable> as the
299 300
      record separator for unaligned output. This is equivalent to the
      <command>\pset recordsep</command> command.
301 302 303
      </para>
      </listitem>
    </varlistentry>
304

305
    <varlistentry>
306 307
      <term><option>-s</></term>
      <term><option>--single-step</></term>
308 309 310
      <listitem>
      <para>
      Run in single-step mode. That means the user is prompted before
311
      each command is sent to the server, with the option to cancel
312 313 314 315
      execution as well. Use this to debug scripts.
      </para>
      </listitem>
    </varlistentry>
316

317
    <varlistentry>
318 319
      <term><option>-S</></term>
      <term><option>--single-line</></term>
320 321
      <listitem>
      <para>
322
      Runs in single-line mode where a newline terminates an SQL command, as a
323 324
      semicolon does.
      </para>
Peter Eisentraut's avatar
Peter Eisentraut committed
325

326 327 328 329 330 331 332 333 334 335
      <note>
      <para>
      This mode is provided for those who insist on it, but you are not
      necessarily encouraged to use it. In particular, if you mix
      <acronym>SQL</acronym> and meta-commands on a line the order of
      execution might not always be clear to the inexperienced user.
      </para>
      </note>
      </listitem>
    </varlistentry>
Peter Eisentraut's avatar
Peter Eisentraut committed
336

337
    <varlistentry>
338 339
      <term><option>-t</></term>
      <term><option>--tuples-only</></term>
340 341 342
      <listitem>
      <para>
      Turn off printing of column names and result row count footers,
343
      etc. This is equivalent to the <command>\t</command> command.
344 345 346
      </para>
      </listitem>
    </varlistentry>
347

348
    <varlistentry>
349 350
      <term><option>-T <replaceable class="parameter">table_options</replaceable></></term>
      <term><option>--table-attr <replaceable class="parameter">table_options</replaceable></></term>
351 352 353 354 355 356 357 358
      <listitem>
      <para>
      Allows you to specify options to be placed within the
      <acronym>HTML</acronym> <sgmltag>table</sgmltag> tag. See
      <command>\pset</command> for details.
      </para>
      </listitem>
    </varlistentry>
359

360
    <varlistentry>
361
      <term><option>-u</></term>
362 363
      <listitem>
      <para>
364
      Forces <application>psql</application> to prompt for the user name and
365 366
      password before connecting to the database.
      </para>
367

368 369 370
      <para>
      This option is deprecated, as it is conceptually flawed.
      (Prompting for a non-default user name and prompting for a
371
      password because the server requires it are really two different
372 373 374 375 376
      things.) You are encouraged to look at the <option>-U</option> and
      <option>-W</option> options instead.
      </para>
      </listitem>
    </varlistentry>
377

378
    <varlistentry>
379 380
      <term><option>-U <replaceable class="parameter">username</replaceable></></term>
      <term><option>--username <replaceable class="parameter">username</replaceable></></term>
381 382
      <listitem>
      <para>
383
      Connect to the database as the user <replaceable
384 385
      class="parameter">username</replaceable> instead of the default.
      (You must have permission to do so, of course.)
386
      </para>
387 388
      </listitem>
    </varlistentry>
389

390
    <varlistentry>
391 392 393
      <term><option>-v <replaceable class="parameter">assignment</replaceable></></term>
      <term><option>--set <replaceable class="parameter">assignment</replaceable></></term>
      <term><option>--variable <replaceable class="parameter">assignment</replaceable></></term>
394 395
      <listitem>
      <para>
396
      Perform a variable assignment, like the <command>\set</command>
397 398 399 400 401 402 403 404 405
      internal command. Note that you must separate name and value, if
      any, by an equal sign on the command line. To unset a variable,
      leave off the equal sign. To just set a variable without a value,
      use the equal sign but leave off the value. These assignments are
      done during a very early stage of start-up, so variables reserved
      for internal purposes might get overwritten later.
      </para>
      </listitem>
    </varlistentry>
406

407
    <varlistentry>
408 409
      <term><option>-V</></term>
      <term><option>--version</></term>
410 411
      <listitem>
      <para>
412
      Print the <application>psql</application> version and exit.
413 414 415
      </para>
      </listitem>
    </varlistentry>
416

417
    <varlistentry>
418 419
      <term><option>-W</></term>
      <term><option>--password</></term>
420 421
      <listitem>
      <para>
422 423
      Forces <application>psql</application> to prompt for a
      password before connecting to a database.  
424
      </para>
425

426
      <para>
427 428 429 430 431 432
      <application>psql</application> should automatically prompt for a
      password whenever the server requests password authentication.
      However, currently password request detection is not totally
      reliable, hence this option to force a prompt. If no password
      prompt is issued and the server requires password authentication,
      the connection attempt will fail.
433
      </para>
434 435 436 437 438 439 440

      <para>
      This option will remain set for the entire session, even if you
      change the database connection with the meta-command
      <command>\connect</command>.
      </para>

441 442
      </listitem>
    </varlistentry>
443

444
    <varlistentry>
445 446
      <term><option>-x</></term>
      <term><option>--expanded</></term>
447 448
      <listitem>
      <para>
449 450
      Turn on the expanded table formatting mode. This is equivalent to the
      <command>\x</command> command.
451 452 453
      </para>
      </listitem>
    </varlistentry>
454

455
    <varlistentry>
456 457
      <term><option>-X,</></term>
      <term><option>--no-psqlrc</></term>
458 459
      <listitem>
      <para>
460 461 462
      Do not read the start-up file (neither the system-wide
      <filename>psqlrc</filename> file nor the user's
      <filename>~/.psqlrc</filename> file).
463 464 465
      </para>
      </listitem>
    </varlistentry>
466

Bruce Momjian's avatar
Bruce Momjian committed
467 468 469 470 471
     <varlistentry>
      <term><option>-1</option></term>
      <term><option>--single-transaction</option></term>
      <listitem>
       <para>
472 473 474 475
        When <application>psql</application> executes a script with the
        <option>-f</> option, adding this option wraps
        <command>BEGIN</>/<command>COMMIT</> around the script to execute it
        as a single transaction.  This ensures that either all the commands
476 477 478 479
        complete successfully, or no changes are applied.  
       </para>

       <para>
480 481 482 483 484 485
        If the script itself uses <command>BEGIN</>, <command>COMMIT</>,
        or <command>ROLLBACK</>, this option will not have the desired
        effects.
        Also, if the script contains any command that cannot be executed
        inside a transaction block, specifying this option will cause that
        command (and hence the whole transaction) to fail.
Bruce Momjian's avatar
Bruce Momjian committed
486 487 488 489
       </para>
      </listitem>
     </varlistentry>

490
    <varlistentry>
491 492
      <term><option>-?</></term>
      <term><option>--help</></term>
493 494
      <listitem>
      <para>
495
      Show help about <application>psql</application> command line
496
      arguments, and exit.
497 498 499 500 501
      </para>
      </listitem>
    </varlistentry>
  </variablelist>
 </refsect1>
502 503


504 505
 <refsect1>
  <title>Exit Status</title>
506

507 508 509
  <para>
   <application>psql</application> returns 0 to the shell if it
   finished normally, 1 if a fatal error of its own (out of memory,
510 511
   file not found) occurs, 2 if the connection to the server went bad
   and the session was not interactive, and 3 if an error occurred in a
512
   script and the variable <varname>ON_ERROR_STOP</varname> was set.
513 514
  </para>
 </refsect1>
515 516


517 518
 <refsect1>
  <title>Usage</title>
519

520 521
  <refsect2 id="R2-APP-PSQL-connecting">
    <title>Connecting To A Database</title>
522

523 524 525 526 527 528 529 530 531 532
    <para>
    <application>psql</application> is a regular
    <productname>PostgreSQL</productname> client application. In order
    to connect to a database you need to know the name of your target
    database, the host name and port number of the server and what user
    name you want to connect as. <application>psql</application> can be
    told about those parameters via command line options, namely
    <option>-d</option>, <option>-h</option>, <option>-p</option>, and
    <option>-U</option> respectively. If an argument is found that does
    not belong to any option it will be interpreted as the database name
533 534 535 536 537 538
    (or the user name, if the database name is already given). Not all
    these options are required; there are useful defaults. If you omit the host
    name, <application>psql</> will connect via a Unix-domain socket
    to a server on the local host, or via TCP/IP to <literal>localhost</> on
    machines that don't have Unix-domain sockets. The default port number is
    determined at compile time.
539 540 541 542
    Since the database server uses the same default, you will not have
    to specify the port in most cases. The default user name is your
    Unix user name, as is the default database name. Note that you can't
    just connect to any database under any user name. Your database
543 544 545 546 547 548
    administrator should have informed you about your access rights.
    </para>

    <para>
    When the defaults aren't quite right, you can save yourself
    some typing by setting the environment variables
549
    <envar>PGDATABASE</envar>, <envar>PGHOST</envar>,
550
    <envar>PGPORT</envar> and/or <envar>PGUSER</envar> to appropriate
551 552 553 554
    values. (For additional environment variables, see <xref
    linkend="libpq-envars">.) It is also convenient to have a
    <filename>~/.pgpass</> file to avoid regularly having to type in
    passwords. See <xref linkend="libpq-pgpass"> for more information.
555
    </para>
556

557 558
    <para>
    If the connection could not be made for any reason (e.g., insufficient
559
    privileges, server is not running on the targeted host, etc.),
560 561 562
    <application>psql</application> will return an error and terminate.
    </para>
  </refsect2>
563

564
  <refsect2 id="R2-APP-PSQL-4">
565
    <title>Entering SQL Commands</title>
566

567 568 569 570 571 572 573
    <para>
    In normal operation, <application>psql</application> provides a
    prompt with the name of the database to which
    <application>psql</application> is currently connected, followed by
    the string <literal>=&gt;</literal>. For example,
<programlisting>
$ <userinput>psql testdb</userinput>
574
Welcome to psql &version;, the PostgreSQL interactive terminal.
575

576 577
Type:  \copyright for distribution terms
       \h for help with SQL commands
578
       \? for help with psql commands
579 580
       \g or terminate with semicolon to execute query
       \q to quit
581

582
testdb=&gt;
583 584
</programlisting>
    </para>
585

586
    <para>
587 588 589 590
    At the prompt, the user may type in <acronym>SQL</acronym> commands.
    Ordinarily, input lines are sent to the server when a
    command-terminating semicolon is reached. An end of line does not
    terminate a command.  Thus commands can be spread over several lines for
591 592
    clarity. If the command was sent and executed without error, the results
    of the command are displayed on the screen.
593
    </para>
594

595
    <para>
596
    Whenever a command is executed, <application>psql</application> also polls
597 598 599 600 601
    for asynchronous notification events generated by
    <xref linkend="SQL-LISTEN" endterm="SQL-LISTEN-title"> and
    <xref linkend="SQL-NOTIFY" endterm="SQL-NOTIFY-title">.
    </para>
  </refsect2>
602

603 604
  <refsect2>
    <title>Meta-Commands</title>
605

606 607 608 609
    <para>
    Anything you enter in <application>psql</application> that begins
    with an unquoted backslash is a <application>psql</application>
    meta-command that is processed by <application>psql</application>
610 611
    itself. These commands help make
    <application>psql</application> more useful for administration or
612 613 614
    scripting. Meta-commands are more commonly called slash or backslash
    commands.
    </para>
615

616
    <para>
617
    The format of a <application>psql</application> command is the backslash,
618
    followed immediately by a command verb, then any arguments. The arguments
619
    are separated from the command verb and each other by any number of
620 621
    whitespace characters.
    </para>
622

623
    <para>
624
    To include whitespace into an argument you may quote it with a
625
    single quote. To include a single quote into such an argument,
626
    use two single quotes. Anything contained in single quotes is
627
    furthermore subject to C-like substitutions for
628
    <literal>\n</literal> (new line), <literal>\t</literal> (tab),
629
    <literal>\</literal><replaceable>digits</replaceable> (octal), and
630
    <literal>\x</literal><replaceable>digits</replaceable> (hexadecimal).
631
    </para>
632

633 634
    <para>
    If an unquoted argument begins with a colon (<literal>:</literal>),
635 636
    it is taken as a <application>psql</> variable and the value of the
    variable is used as the argument instead.
637 638 639
    </para>

    <para>
640 641 642 643 644
    Arguments that are enclosed in backquotes (<literal>`</literal>)
    are taken as a command line that is passed to the shell. The
    output of the command (with any trailing newline removed) is taken
    as the argument value. The above escape sequences also apply in
    backquotes.
645
    </para>
646

647
    <para>
648 649 650 651 652 653 654 655 656 657
    Some commands take an <acronym>SQL</acronym> identifier (such as a
    table name) as argument. These arguments follow the syntax rules
    of <acronym>SQL</acronym>: Unquoted letters are forced to
    lowercase, while double quotes (<literal>"</>) protect letters
    from case conversion and allow incorporation of whitespace into
    the identifier.  Within double quotes, paired double quotes reduce
    to a single double quote in the resulting name.  For example,
    <literal>FOO"BAR"BAZ</> is interpreted as <literal>fooBARbaz</>,
    and <literal>"A weird"" name"</> becomes <literal>A weird"
    name</>.
658
    </para>
659

660 661 662 663
    <para>
    Parsing for arguments stops when another unquoted backslash occurs.
    This is taken as the beginning of a new meta-command. The special
    sequence <literal>\\</literal> (two backslashes) marks the end of
664
    arguments and continues parsing <acronym>SQL</acronym> commands, if
665 666 667 668 669
    any. That way <acronym>SQL</acronym> and
    <application>psql</application> commands can be freely mixed on a
    line. But in any case, the arguments of a meta-command cannot
    continue beyond the end of the line.
    </para>
670

671 672
    <para>
    The following meta-commands are defined:
673

674
    <variablelist>
675
      <varlistentry>
676
        <term><literal>\a</literal></term>
677 678
        <listitem>
        <para>
679 680 681
        If the current table output format is unaligned, it is switched to aligned.
        If it is not unaligned, it is set to unaligned. This command is
        kept for backwards compatibility. See <command>\pset</command> for a
682
        more general solution.
683 684 685 686 687
        </para>
        </listitem>
      </varlistentry>

      <varlistentry>
688
       <term><literal>\cd [ <replaceable>directory</replaceable> ]</literal></term>
689
       <listitem>
690
        <para>
691 692 693
         Changes the current working directory to
         <replaceable>directory</replaceable>. Without argument, changes
         to the current user's home directory.
694 695
        </para>

696 697 698 699 700
        <tip>
         <para>
          To print your current working directory, use <literal>\!pwd</literal>.
         </para>
        </tip>
701 702
       </listitem>
      </varlistentry>
703

704
      <varlistentry>
705
        <term><literal>\C [ <replaceable class="parameter">title</replaceable> ]</literal></term>
706 707
        <listitem>
        <para>
708
        Sets the title of any tables being printed as the result of a
709 710 711 712 713 714
        query or unset any such title. This command is equivalent to
        <literal>\pset title <replaceable
        class="parameter">title</replaceable></literal>. (The name of
        this command derives from <quote>caption</quote>, as it was
        previously only used to set the caption in an
        <acronym>HTML</acronym> table.)
715 716 717 718
        </para>
        </listitem>
      </varlistentry>

719
      <varlistentry>
720
        <term><literal>\connect</literal> (or <literal>\c</literal>) <literal>[ <replaceable class="parameter">dbname</replaceable> [ <replaceable class="parameter">username</replaceable> ] [ <replaceable class="parameter">host</replaceable> ] [ <replaceable class="parameter">port</replaceable> ] ]</literal></term>
721 722
        <listitem>
        <para>
723 724 725 726 727 728 729 730 731 732 733
        Establishes a new connection to a <productname>PostgreSQL</>
        server. If the new connection is successfully made, the
        previous connection is closed. If any of <replaceable
        class="parameter">dbname</replaceable>, <replaceable
        class="parameter">username</replaceable>, <replaceable
        class="parameter">host</replaceable> or <replaceable
        class="parameter">port</replaceable> are omitted or specified
        as <literal>-</literal>, the value of that parameter from the
        previous connection is used. If there is no previous
        connection, the <application>libpq</application> default for
        the parameter's value is used.
734
        </para>
735

736 737
        <para>
        If the connection attempt failed (wrong user name, access
738 739 740 741 742 743 744
        denied, etc.), the previous connection will only be kept if
        <application>psql</application> is in interactive mode. When
        executing a non-interactive script, processing will
        immediately stop with an error. This distinction was chosen as
        a user convenience against typos on the one hand, and a safety
        mechanism that scripts are not accidentally acting on the
        wrong database on the other hand.
745
        </para>
746
        </listitem>
747 748
      </varlistentry>

749
      <varlistentry>
750
        <term><literal>\copy { <replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column_list</replaceable> ) ] | ( <replaceable class="parameter">query</replaceable> ) }
751
        { <literal>from</literal> | <literal>to</literal> }
752 753
        { <replaceable class="parameter">filename</replaceable> | stdin | stdout | pstdin | pstdout }
        [ with ]
754
            [ binary ]
755
            [ oids ]
756 757
            [ delimiter [ as ] '<replaceable class="parameter">character</replaceable>' ]
            [ null [ as ] '<replaceable class="parameter">string</replaceable>' ]
758 759 760 761 762 763
            [ csv
              [ header ]
              [ quote [ as ] '<replaceable class="parameter">character</replaceable>' ]
              [ escape [ as ] '<replaceable class="parameter">character</replaceable>' ]
              [ force quote <replaceable class="parameter">column_list</replaceable> ]
              [ force not null <replaceable class="parameter">column_list</replaceable> ] ]</literal>
764
        </term>
765 766 767

        <listitem>
        <para>
768 769
        Performs a frontend (client) copy. This is an operation that
        runs an <acronym>SQL</acronym> <xref linkend="SQL-COPY"
770
        endterm="SQL-COPY-title"> command, but instead of the server
771
        reading or writing the specified file,
772
        <application>psql</application> reads or writes the file and
773
        routes the data between the server and the local file system.
774 775 776
        This means that file accessibility and privileges are those of
        the local user, not the server, and no SQL superuser
        privileges are required.
777 778 779 780 781 782 783 784 785 786 787 788
        </para>

        <para>
        The syntax of the command is similar to that of the
        <acronym>SQL</acronym> <xref linkend="sql-copy"
        endterm="sql-copy-title"> command.  Note that, because of this,
        special parsing rules apply to the <command>\copy</command>
        command. In particular, the variable substitution rules and
        backslash escapes do not apply.
        </para>

        <para>
789
        <literal>\copy ... from stdin | to stdout</literal>
790 791 792 793 794 795 796 797 798
        reads/writes based on the command input and output respectively.
        All rows are read from the same source that issued the command,
        continuing until <literal>\.</literal> is read or the stream
        reaches <acronym>EOF</>. Output is sent to the same place as
        command output. To read/write from
        <application>psql</application>'s standard input or output, use
        <literal>pstdin</> or <literal>pstdout</>. This option is useful
        for populating tables in-line within a SQL script file.
        </para>
799

800 801
        <tip>
        <para>
802 803 804 805
        This operation is not as efficient as the <acronym>SQL</acronym>
        <command>COPY</command> command because all data must pass
        through the client/server connection. For large
        amounts of data the <acronym>SQL</acronym> command may be preferable.
806 807
        </para>
        </tip>
808 809 810 811 812

        </listitem>
      </varlistentry>

      <varlistentry>
813
        <term><literal>\copyright</literal></term>
814 815
        <listitem>
        <para>
816
        Shows the copyright and distribution terms of
817
        <productname>PostgreSQL</productname>.
818 819 820 821 822
        </para>
        </listitem>
      </varlistentry>

      <varlistentry>
823 824
        <term><literal>\d [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
        <term><literal>\d+ [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
825

826 827
        <listitem>
        <para>
828 829
        For each relation (table, view, index, or sequence) matching the
        <replaceable class="parameter">pattern</replaceable>, show all
830
        columns, their types, the tablespace (if not the default) and any special
831 832 833 834 835
        attributes such as <literal>NOT NULL</literal> or defaults, if
        any. Associated indexes, constraints, rules, and triggers are
        also shown, as is the view definition if the relation is a view.
        (<quote>Matching the pattern</> is defined below.)
        </para>
836

837 838 839 840 841 842
        <para>
        The command form <literal>\d+</literal> is identical, except that
        more information is displayed: any comments associated with the
        columns of the table are shown, as is the presence of OIDs in the
        table.
        </para>
843

844 845 846 847 848 849 850 851 852 853
        <note>
        <para>
        If <command>\d</command> is used without a
        <replaceable class="parameter">pattern</replaceable> argument, it is
        equivalent to <command>\dtvs</command> which will show a list of
        all tables, views, and sequences. This is purely a convenience
        measure.
        </para>
        </note>
        </listitem>
854 855 856
      </varlistentry>

      <varlistentry>
857
        <term><literal>\da [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
858

859 860
        <listitem>
        <para>
861
        Lists all available aggregate functions, together with the data
862
        types they operate on. If <replaceable
863
        class="parameter">pattern</replaceable>
Tom Lane's avatar
Tom Lane committed
864
        is specified, only aggregates whose names match the pattern are shown.
865 866 867 868
        </para>
        </listitem>
      </varlistentry>

869

870 871
      <varlistentry>
        <term><literal>\db [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
872
        <term><literal>\db+ [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
873 874 875 876 877 878

        <listitem>
        <para>
        Lists all available tablespaces. If <replaceable
        class="parameter">pattern</replaceable>
        is specified, only tablespaces whose names match the pattern are shown.
879 880
        If <literal>+</literal> is appended to the command name, each object 
        is listed with its associated permissions.
881 882 883 884 885
        </para>
        </listitem>
      </varlistentry>


886
      <varlistentry>
887
        <term><literal>\dc [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
888 889 890
        <listitem>
        <para>
        Lists all available conversions between character-set encodings.
891
        If <replaceable class="parameter">pattern</replaceable>
Tom Lane's avatar
Tom Lane committed
892
        is specified, only conversions whose names match the pattern are
893
        listed.
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
        </para>
        </listitem>
      </varlistentry>


      <varlistentry>
        <term><literal>\dC</literal></term>
        <listitem>
        <para>
        Lists all available type casts.
        </para>
        </listitem>
      </varlistentry>


909
      <varlistentry>
910
        <term><literal>\dd [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
911 912
        <listitem>
        <para>
913 914
        Shows the descriptions of objects matching the <replaceable
        class="parameter">pattern</replaceable>, or of all visible objects if
915 916
        no argument is given.  But in either case, only objects that have
        a description are listed.
917 918 919 920
        (<quote>Object</quote> covers aggregates, functions, operators,
        types, relations (tables, views, indexes, sequences, large
        objects), rules, and triggers.) For example:
<programlisting>
921
=&gt; <userinput>\dd version</userinput>
922 923 924 925
                     Object descriptions
   Schema   |  Name   |  Object  |        Description
------------+---------+----------+---------------------------
 pg_catalog | version | function | PostgreSQL version string
926 927
(1 row)
</programlisting>
928
        </para>
929 930

        <para>
931 932 933 934
        Descriptions for objects can be created with the <xref
        linkend="sql-comment" endterm="sql-comment-title">
        <acronym>SQL</acronym> command.
       </para>
935 936 937 938 939
        </listitem>
      </varlistentry>


      <varlistentry>
940
        <term><literal>\dD [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
941 942
        <listitem>
        <para>
943
        Lists all available domains. If <replaceable
944
        class="parameter">pattern</replaceable>
945
        is specified, only matching domains are shown.
946 947 948 949 950 951
        </para>
        </listitem>
      </varlistentry>


      <varlistentry>
952
        <term><literal>\df [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
953
        <term><literal>\df+ [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
954

955 956 957 958
        <listitem>
        <para>
        Lists available functions, together with their argument and
        return types. If <replaceable
959
        class="parameter">pattern</replaceable>
Tom Lane's avatar
Tom Lane committed
960
        is specified, only functions whose names match the pattern are shown.
961
        If the form <literal>\df+</literal> is used, additional information about
962 963
        each function, including language and description, is shown.
        </para>
964 965

        <note>
966 967 968 969 970 971
        <para>
        To look up functions taking argument or returning values of a specific
        type, use your pager's search capability to scroll through the <literal>\df</>
        output.
        </para>

972
        <para>
973
        To reduce clutter, <literal>\df</> does not show data type I/O
974 975
        functions.  This is implemented by ignoring functions that accept
        or return type <type>cstring</>.
976 977 978
        </para>
        </note>

979
        </listitem>
980 981 982
      </varlistentry>


983 984 985 986
      <varlistentry>
        <term><literal>\dg [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
        <listitem>
        <para>
987
        Lists all database roles. If <replaceable
988
        class="parameter">pattern</replaceable> is specified, only
989 990
        those roles whose names match the pattern are listed.
        (This command is now effectively the same as <literal>\du</>.)
991 992 993 994 995
        </para>
        </listitem>
      </varlistentry>


996
      <varlistentry>
997
        <term><literal>\distvS [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
998

999 1000 1001
        <listitem>
        <para>
        This is not the actual command name: the letters
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
        <literal>i</literal>, <literal>s</literal>,
        <literal>t</literal>, <literal>v</literal>,
        <literal>S</literal> stand for index, sequence, table, view,
        and system table, respectively. You can specify any or all of
        these letters, in any order, to obtain a listing of all the
        matching objects.  The letter <literal>S</literal> restricts
        the listing to system objects; without <literal>S</literal>,
        only non-system objects are shown.  If <literal>+</literal> is
        appended to the command name, each object is listed with its
        associated description, if any.
1012
        </para>
1013

1014 1015 1016 1017 1018
        <para>
        If <replaceable class="parameter">pattern</replaceable> is
        specified, only objects whose names match the pattern are listed.
        </para>
        </listitem>
1019 1020
      </varlistentry>

1021

1022
      <varlistentry>
1023
        <term><literal>\dl</literal></term>
1024 1025 1026 1027 1028 1029
        <listitem>
        <para>
        This is an alias for <command>\lo_list</command>, which shows a
        list of large objects.
        </para>
        </listitem>
1030 1031
      </varlistentry>

1032

1033
      <varlistentry>
1034
        <term><literal>\dn [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1035
        <term><literal>\dn+ [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1036 1037 1038 1039 1040

        <listitem>
        <para>
        Lists all available schemas (namespaces). If <replaceable
        class="parameter">pattern</replaceable> (a regular expression)
Tom Lane's avatar
Tom Lane committed
1041
        is specified, only schemas whose names match the pattern are listed.
1042 1043 1044
        Non-local temporary schemas are suppressed.  If <literal>+</literal>
        is appended to the command name, each object is listed with its associated
        permissions and description, if any.
1045 1046 1047 1048 1049
        </para>
        </listitem>
      </varlistentry>


1050
      <varlistentry>
1051
        <term><literal>\do [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1052 1053 1054
        <listitem>
        <para>
        Lists available operators with their operand and return types.
1055 1056
        If <replaceable class="parameter">pattern</replaceable> is
        specified, only operators whose names match the pattern are listed.
1057 1058 1059
        </para>
        </listitem>
      </varlistentry>
1060 1061


1062
      <varlistentry>
1063
        <term><literal>\dp [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1064 1065
        <listitem>
        <para>
1066
        Produces a list of all available tables, views and sequences with their
1067
        associated access privileges.
1068 1069 1070
        If <replaceable class="parameter">pattern</replaceable> is
        specified, only tables, views and sequences whose names match the pattern are listed.
        </para>
1071

1072
        <para>
1073 1074 1075
        The <xref linkend="sql-grant" endterm="sql-grant-title"> and
        <xref linkend="sql-revoke" endterm="sql-revoke-title">
        commands are used to set access privileges.
1076 1077
        </para>
        </listitem>
1078 1079 1080 1081
      </varlistentry>


      <varlistentry>
1082
        <term><literal>\dT [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1083
        <term><literal>\dT+ [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1084 1085
        <listitem>
        <para>
1086 1087 1088
        Lists all data types or only those that match <replaceable
        class="parameter">pattern</replaceable>. The command form
        <literal>\dT+</literal> shows extra information.
1089 1090 1091 1092 1093 1094
        </para>
        </listitem>
      </varlistentry>


      <varlistentry>
1095
        <term><literal>\du [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1096 1097
        <listitem>
        <para>
1098
        Lists all database roles, or only those that match <replaceable
1099
        class="parameter">pattern</replaceable>.
1100 1101 1102 1103 1104 1105
        </para>
        </listitem>
      </varlistentry>


      <varlistentry>
1106
        <term><literal>\edit</literal> (or <literal>\e</literal>) <literal>[ <replaceable class="parameter">filename</replaceable> ]</literal></term>
1107

1108 1109 1110 1111 1112 1113 1114 1115
        <listitem>
        <para>
        If <replaceable class="parameter">filename</replaceable> is
        specified, the file is edited; after the editor exits, its
        content is copied back to the query buffer. If no argument is
        given, the current query buffer is copied to a temporary file
        which is then edited in the same fashion.
        </para>
1116

1117 1118 1119 1120 1121 1122 1123 1124 1125
        <para>
        The new query buffer is then re-parsed according to the normal
        rules of <application>psql</application>, where the whole buffer
        is treated as a single line. (Thus you cannot make scripts this
        way. Use <command>\i</command> for that.) This means also that
        if the query ends with (or rather contains) a semicolon, it is
        immediately executed. In other cases it will merely wait in the
        query buffer.
        </para>
1126

1127 1128 1129 1130 1131
        <tip>
        <para>
        <application>psql</application> searches the environment
        variables <envar>PSQL_EDITOR</envar>, <envar>EDITOR</envar>, and
        <envar>VISUAL</envar> (in that order) for an editor to use. If
1132 1133
        all of them are unset, <filename>vi</filename> is used on Unix
        systems, <filename>notepad.exe</filename> on Windows systems.
1134 1135 1136 1137 1138 1139 1140
        </para>
        </tip>
        </listitem>
      </varlistentry>


      <varlistentry>
1141
        <term><literal>\echo <replaceable class="parameter">text</replaceable> [ ... ]</literal></term>
1142
        <listitem>
1143
        <para>
1144 1145 1146 1147
        Prints the arguments to the standard output, separated by one
        space and followed by a newline. This can be useful to
        intersperse information in the output of scripts. For example:
<programlisting>
1148
=&gt; <userinput>\echo `date`</userinput>
1149 1150
Tue Oct 26 21:40:57 CEST 1999
</programlisting>
1151
        If the first argument is an unquoted <literal>-n</literal> the trailing
1152
        newline is not written.
1153
        </para>
1154

1155 1156 1157 1158 1159 1160 1161 1162
        <tip>
        <para>
        If you use the <command>\o</command> command to redirect your
        query output you may wish to use <command>\qecho</command>
        instead of this command.
        </para>
        </tip>
        </listitem>
1163
      </varlistentry>
1164 1165


1166
      <varlistentry>
1167
        <term><literal>\encoding [ <replaceable class="parameter">encoding</replaceable> ]</literal></term>
1168 1169 1170

        <listitem>
        <para>
1171
        Sets the client character set encoding.  Without an argument, this command
1172
        shows the current encoding.
1173 1174
        </para>
        </listitem>
1175 1176 1177 1178
      </varlistentry>


      <varlistentry>
1179
        <term><literal>\f [ <replaceable class="parameter">string</replaceable> ]</literal></term>
1180

1181 1182
        <listitem>
        <para>
1183
        Sets the field separator for unaligned query output. The default
1184
        is the vertical bar (<literal>|</literal>). See also
1185 1186
        <command>\pset</command> for a generic way of setting output
        options.
1187 1188 1189 1190 1191 1192
        </para>
        </listitem>
      </varlistentry>


      <varlistentry>
1193 1194
        <term><literal>\g</literal> [ { <replaceable class="parameter">filename</replaceable> | <literal>|</literal><replaceable class="parameter">command</replaceable> } ]</term>

1195 1196
        <listitem>
        <para>
1197
        Sends the current query input buffer to the server and
1198
        optionally stores the query's output in <replaceable
1199
        class="parameter">filename</replaceable> or pipes the output
1200
        into a separate Unix shell executing <replaceable
1201 1202 1203 1204 1205 1206 1207 1208 1209
        class="parameter">command</replaceable>. A bare
        <literal>\g</literal> is virtually equivalent to a semicolon. A
        <literal>\g</literal> with argument is a <quote>one-shot</quote>
        alternative to the <command>\o</command> command.
        </para>
        </listitem>
      </varlistentry>

      <varlistentry>
1210
        <term><literal>\help</literal> (or <literal>\h</literal>) <literal>[ <replaceable class="parameter">command</replaceable> ]</literal></term>
1211 1212
        <listitem>
        <para>
1213
        Gives syntax help on the specified <acronym>SQL</acronym>
1214 1215 1216 1217
        command. If <replaceable class="parameter">command</replaceable>
        is not specified, then <application>psql</application> will list
        all the commands for which syntax help is available. If
        <replaceable class="parameter">command</replaceable> is an
1218
        asterisk (<literal>*</literal>), then syntax help on all
1219
        <acronym>SQL</acronym> commands is shown.
1220
        </para>
1221

1222 1223 1224 1225 1226 1227 1228
        <note>
        <para>
        To simplify typing, commands that consists of several words do
        not have to be quoted. Thus it is fine to type <userinput>\help
        alter table</userinput>.
        </para>
        </note>
1229 1230 1231 1232 1233
        </listitem>
      </varlistentry>


      <varlistentry>
1234
        <term><literal>\H</literal></term>
1235 1236
        <listitem>
        <para>
1237 1238 1239 1240 1241
        Turns on <acronym>HTML</acronym> query output format. If the
        <acronym>HTML</acronym> format is already on, it is switched
        back to the default aligned text format. This command is for
        compatibility and convenience, but see <command>\pset</command>
        about setting other output options.
1242 1243 1244 1245 1246 1247
        </para>
        </listitem>
      </varlistentry>


      <varlistentry>
1248
        <term><literal>\i <replaceable class="parameter">filename</replaceable></literal></term>
1249 1250
        <listitem>
        <para>
1251 1252 1253 1254
        Reads input from the file <replaceable
        class="parameter">filename</replaceable> and executes it as
        though it had been typed on the keyboard.
        </para>
1255 1256 1257 1258 1259 1260 1261
        <note>
        <para>
        If you want to see the lines on the screen as they are read you
        must set the variable <varname>ECHO</varname> to
        <literal>all</literal>.
        </para>
        </note>
1262 1263 1264 1265 1266 1267
        </listitem>
      </varlistentry>


      <varlistentry>
        <term><literal>\l</literal> (or <literal>\list</literal>)</term>
1268
        <term><literal>\l+</literal> (or <literal>\list+</literal>)</term>
1269 1270
        <listitem>
        <para>
1271
        List the names, owners, and character set encodings of all the databases in
1272 1273
        the server. If <literal>+</literal> is appended to the command
        name, database descriptions are also displayed.
1274
        </para>
1275 1276 1277 1278 1279
        </listitem>
      </varlistentry>


      <varlistentry>
1280
        <term><literal>\lo_export <replaceable class="parameter">loid</replaceable> <replaceable class="parameter">filename</replaceable></literal></term>
1281

1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
        <listitem>
        <para>
        Reads the large object with <acronym>OID</acronym> <replaceable
        class="parameter">loid</replaceable> from the database and
        writes it to <replaceable
        class="parameter">filename</replaceable>. Note that this is
        subtly different from the server function
        <function>lo_export</function>, which acts with the permissions
        of the user that the database server runs as and on the server's
        file system.
        </para>
        <tip>
        <para>
        Use <command>\lo_list</command> to find out the large object's
        <acronym>OID</acronym>.
        </para>
        </tip>
        </listitem>
1300 1301 1302 1303
      </varlistentry>


      <varlistentry>
1304
        <term><literal>\lo_import <replaceable class="parameter">filename</replaceable> [ <replaceable class="parameter">comment</replaceable> ]</literal></term>
1305

1306 1307 1308 1309 1310
        <listitem>
        <para>
        Stores the file into a <productname>PostgreSQL</productname>
        large object. Optionally, it associates the given
        comment with the object. Example:
1311
<programlisting>
1312
foo=&gt; <userinput>\lo_import '/home/peter/pictures/photo.xcf' 'a picture of me'</userinput>
1313 1314
lo_import 152801
</programlisting>
1315 1316 1317 1318 1319 1320
        The response indicates that the large object received object ID
        152801 which one ought to remember if one wants to access the
        object ever again. For that reason it is recommended to always
        associate a human-readable comment with every object. Those can
        then be seen with the <command>\lo_list</command> command.
        </para>
1321

1322 1323 1324 1325 1326 1327 1328
        <para>
        Note that this command is subtly different from the server-side
        <function>lo_import</function> because it acts as the local user
        on the local file system, rather than the server's user and file
        system.
        </para>
        </listitem>
1329 1330 1331 1332
      </varlistentry>

      <varlistentry>
        <term><literal>\lo_list</literal></term>
1333 1334 1335 1336 1337 1338 1339
        <listitem>
        <para>
        Shows a list of all <productname>PostgreSQL</productname>
        large objects currently stored in the database,
        along with any comments provided for them.
        </para>
        </listitem>
1340 1341 1342
      </varlistentry>

      <varlistentry>
1343
        <term><literal>\lo_unlink <replaceable class="parameter">loid</replaceable></literal></term>
1344

1345 1346 1347 1348 1349 1350
        <listitem>
        <para>
        Deletes the large object with <acronym>OID</acronym>
        <replaceable class="parameter">loid</replaceable> from the
        database.
        </para>
1351

1352 1353 1354 1355 1356 1357 1358
        <tip>
        <para>
        Use <command>\lo_list</command> to find out the large object's
        <acronym>OID</acronym>.
        </para>
        </tip>
        </listitem>
1359 1360 1361 1362
      </varlistentry>


      <varlistentry>
1363
        <term><literal>\o</literal> [ {<replaceable class="parameter">filename</replaceable> | <literal>|</literal><replaceable class="parameter">command</replaceable>} ]</term>
1364 1365 1366

        <listitem>
        <para>
1367 1368 1369 1370
        Saves future query results to the file <replaceable
        class="parameter">filename</replaceable> or pipes future results
        into a separate Unix shell to execute <replaceable
        class="parameter">command</replaceable>. If no arguments are
1371
        specified, the query output will be reset to the standard output.
1372 1373
        </para>

1374 1375 1376 1377 1378 1379 1380
        <para>
        <quote>Query results</quote> includes all tables, command
        responses, and notices obtained from the database server, as
        well as output of various backslash commands that query the
        database (such as <command>\d</command>), but not error
        messages.
        </para>
1381

1382 1383 1384 1385 1386 1387
        <tip>
        <para>
        To intersperse text output in between query results, use
        <command>\qecho</command>.
        </para>
        </tip>
1388
        </listitem>
1389 1390 1391
      </varlistentry>


1392
      <varlistentry>
1393
        <term><literal>\p</literal></term>
1394 1395
        <listitem>
        <para>
1396
        Print the current query buffer to the standard output.
1397 1398 1399 1400
        </para>
        </listitem>
      </varlistentry>

1401
      <varlistentry>
Tom Lane's avatar
Tom Lane committed
1402
        <term><literal>\password [ <replaceable class="parameter">username</replaceable> ]</literal></term>
1403 1404
        <listitem>
        <para>
Tom Lane's avatar
Tom Lane committed
1405 1406 1407 1408 1409
        Changes the password of the specified user (by default, the current
        user).  This command prompts for the new password, encrypts it, and
        sends it to the server as an <command>ALTER ROLE</> command.  This
        makes sure that the new password does not appear in cleartext in the
        command history, the server log, or elsewhere.
1410 1411 1412 1413
        </para>
        </listitem>
      </varlistentry>

1414
      <varlistentry>
1415
        <term><literal>\pset <replaceable class="parameter">parameter</replaceable> [ <replaceable class="parameter">value</replaceable> ]</literal></term>
1416

1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
        <listitem>
        <para>
        This command sets options affecting the output of query result
        tables. <replaceable class="parameter">parameter</replaceable>
        describes which option is to be set. The semantics of
        <replaceable class="parameter">value</replaceable> depend
        thereon.
        </para>

        <para>
        Adjustable printing options are:
        <variablelist>
          <varlistentry>
          <term><literal>format</literal></term>
          <listitem>
          <para>
          Sets the output format to one of <literal>unaligned</literal>,
1434 1435 1436
          <literal>aligned</literal>, <literal>html</literal>,
          <literal>latex</literal>, or <literal>troff-ms</literal>.
          Unique abbreviations are allowed.  (That would mean one letter
1437
          is enough.)
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
          </para>

          <para>
          <quote>Unaligned</quote> writes all columns of a row on a
          line, separated by the currently active field separator. This
          is intended to create output that might be intended to be read
          in by other programs (tab-separated, comma-separated).
          <quote>Aligned</quote> mode is the standard, human-readable,
          nicely formatted text output that is default. The
          <quote><acronym>HTML</acronym></quote> and
          <quote>LaTeX</quote> modes put out tables that are intended to
          be included in documents using the respective mark-up
          language. They are not complete documents! (This might not be
          so dramatic in <acronym>HTML</acronym>, but in LaTeX you must
          have a complete document wrapper.)
          </para>
          </listitem>
1455
          </varlistentry>
1456

1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
          <varlistentry>
          <term><literal>border</literal></term>
          <listitem>
          <para>
          The second argument must be a number. In general, the higher
          the number the more borders and lines the tables will have,
          but this depends on the particular format. In
          <acronym>HTML</acronym> mode, this will translate directly
          into the <literal>border=...</literal> attribute, in the
          others only values 0 (no border), 1 (internal dividing lines),
          and 2 (table frame) make sense.
          </para>
          </listitem>
          </varlistentry>

          <varlistentry>
          <term><literal>expanded</literal> (or <literal>x</literal>)</term>
          <listitem>
          <para>
          Toggles between regular and expanded format. When expanded
1477 1478
          format is enabled, query results are displayed in two
          columns, with the column name on the left and the data on
1479
          the right. This mode is useful if the data wouldn't fit on the
1480
          screen in the normal <quote>horizontal</quote> mode.
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
          </para>

          <para>
          Expanded mode is supported by all four output formats.
          </para>
          </listitem>
          </varlistentry>

          <varlistentry>
          <term><literal>null</literal></term>
          <listitem>
          <para>
          The second argument is a string that should be printed
          whenever a column is null. The default is not to print
          anything, which can easily be mistaken for, say, an empty
          string. Thus, one might choose to write <literal>\pset null
          '(null)'</literal>.
          </para>
          </listitem>
          </varlistentry>

          <varlistentry>
          <term><literal>fieldsep</literal></term>
          <listitem>
          <para>
          Specifies the field separator to be used in unaligned output
          mode. That way one can create, for example, tab- or
          comma-separated output, which other programs might prefer. To
          set a tab as field separator, type <literal>\pset fieldsep
          '\t'</literal>. The default field separator is
          <literal>'|'</literal> (a vertical bar).
          </para>
          </listitem>
          </varlistentry>

          <varlistentry>
          <term><literal>footer</literal></term>
          <listitem>
          <para>
          Toggles the display of the default footer <literal>(x
          rows)</literal>.
          </para>
          </listitem>
          </varlistentry>

1526
          <varlistentry>
1527
          <term><literal>numericlocale</literal></term>
1528 1529
          <listitem>
          <para>
1530 1531 1532
          Toggles the display of a locale-aware character to separate groups
          of digits to the left of the decimal marker.  It also enables
          a locale-aware decimal marker.
1533 1534 1535 1536
          </para>
          </listitem>
          </varlistentry>

1537 1538 1539 1540
          <varlistentry>
          <term><literal>recordsep</literal></term>
          <listitem>
          <para>
1541 1542
          Specifies the record (line) separator to use in unaligned
          output mode. The default is a newline character.
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
          </para>
          </listitem>
          </varlistentry>

          <varlistentry>
          <term><literal>tuples_only</literal> (or <literal>t</literal>)</term>
          <listitem>
          <para>
          Toggles between tuples only and full display. Full display may
          show extra information such as column headers, titles, and
          various footers. In tuples only mode, only actual table data
          is shown.
          </para>
          </listitem>
          </varlistentry>

          <varlistentry>
          <term><literal>title [ <replaceable class="parameter">text</replaceable> ]</literal></term>
          <listitem>
          <para>
          Sets the table title for any subsequently printed tables. This
          can be used to give your output descriptive tags. If no
          argument is given, the title is unset.
          </para>
          </listitem>
          </varlistentry>

          <varlistentry>
          <term><literal>tableattr</literal> (or <literal>T</literal>) <literal>[ <replaceable class="parameter">text</replaceable> ]</literal></term>
          <listitem>
          <para>
          Allows you to specify any attributes to be placed inside the
          <acronym>HTML</acronym> <sgmltag>table</sgmltag> tag. This
          could for example be <literal>cellpadding</literal> or
          <literal>bgcolor</literal>. Note that you probably don't want
          to specify <literal>border</literal> here, as that is already
          taken care of by <literal>\pset border</literal>.
          </para>
          </listitem>
          </varlistentry>


          <varlistentry>
          <term><literal>pager</literal></term>
          <listitem>
          <para>
          Controls use of a pager for query and <application>psql</>
          help output. If the environment variable <envar>PAGER</envar>
          is set, the output is piped to the specified program.
          Otherwise a platform-dependent default (such as
          <filename>more</filename>) is used.
          </para>

          <para>
          When the pager is off, the pager is not used. When the pager
          is on, the pager is used only when appropriate, i.e. the
          output is to a terminal and will not fit on the screen.
          (<application>psql</> does not do a perfect job of estimating
          when to use the pager.) <literal>\pset pager</> turns the
          pager on and off. Pager can also be set to <literal>always</>,
          which causes the pager to be always used.
          </para>
          </listitem>
          </varlistentry>
        </variablelist>
        </para>

        <para>
        Illustrations on how these different formats look can be seen in
        the <xref linkend="APP-PSQL-examples"
        endterm="APP-PSQL-examples-title"> section.
        </para>

        <tip>
        <para>
        There are various shortcut commands for <command>\pset</command>. See
        <command>\a</command>, <command>\C</command>, <command>\H</command>,
        <command>\t</command>, <command>\T</command>, and <command>\x</command>.
        </para>
        </tip>

        <note>
        <para>
        It is an error to call <command>\pset</command> without
        arguments. In the future this call might show the current status
        of all printing options.
        </para>
        </note>

        </listitem>
1633
      </varlistentry>
1634 1635


1636 1637 1638 1639
      <varlistentry>
        <term><literal>\q</literal></term>
        <listitem>
        <para>
1640
        Quits the <application>psql</application> program.
1641 1642 1643
        </para>
        </listitem>
      </varlistentry>
1644 1645


1646
      <varlistentry>
1647
        <term><literal>\qecho <replaceable class="parameter">text</replaceable> [ ... ] </literal></term>
1648 1649
        <listitem>
        <para>
1650
        This command is identical to <command>\echo</command> except
1651
        that the output will be written to the query output channel, as
1652
        set by <command>\o</command>.
1653 1654 1655
        </para>
        </listitem>
      </varlistentry>
1656 1657


1658 1659 1660 1661 1662 1663 1664 1665
      <varlistentry>
        <term><literal>\r</literal></term>
        <listitem>
        <para>
        Resets (clears) the query buffer.
        </para>
        </listitem>
      </varlistentry>
1666 1667


1668
      <varlistentry>
1669
        <term><literal>\s [ <replaceable class="parameter">filename</replaceable> ]</literal></term>
1670 1671 1672 1673 1674 1675 1676
        <listitem>
        <para>
        Print or save the command line history to <replaceable
        class="parameter">filename</replaceable>. If <replaceable
        class="parameter">filename</replaceable> is omitted, the history
        is written to the standard output. This option is only available
        if <application>psql</application> is configured to use the
Peter Eisentraut's avatar
Peter Eisentraut committed
1677
        <acronym>GNU</acronym> <application>Readline</application> library.
1678 1679 1680
        </para>
        </listitem>
      </varlistentry>
1681

1682

1683
      <varlistentry>
1684
        <term><literal>\set [ <replaceable class="parameter">name</replaceable> [ <replaceable class="parameter">value</replaceable> [ ... ] ] ]</literal></term>
1685

1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
        <listitem>
        <para>
        Sets the internal variable <replaceable
        class="parameter">name</replaceable> to <replaceable
        class="parameter">value</replaceable> or, if more than one value
        is given, to the concatenation of all of them. If no second
        argument is given, the variable is just set with no value. To
        unset a variable, use the <command>\unset</command> command.
        </para>

        <para>
        Valid variable names can contain characters, digits, and
        underscores. See the section <xref
        linkend="APP-PSQL-variables"
        endterm="APP-PSQL-variables-title"> below for details.
        Variable names are case-sensitive.
        </para>

        <para>
        Although you are welcome to set any variable to anything you
        want, <application>psql</application> treats several variables
        as special. They are documented in the section about variables.
        </para>

        <note>
        <para>
        This command is totally separate from the <acronym>SQL</acronym>
        command <xref linkend="SQL-SET" endterm="SQL-SET-title">.
        </para>
        </note>
        </listitem>
1717
      </varlistentry>
1718

1719

1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
      <varlistentry>
        <term><literal>\t</literal></term>
        <listitem>
        <para>
        Toggles the display of output column name headings and row count
        footer. This command is equivalent to <literal>\pset
        tuples_only</literal> and is provided for convenience.
        </para>
        </listitem>
      </varlistentry>
1730 1731


1732
      <varlistentry>
1733
        <term><literal>\T <replaceable class="parameter">table_options</replaceable></literal></term>
1734 1735
        <listitem>
        <para>
1736
        Allows you to specify attributes to be placed within the
1737 1738 1739 1740 1741 1742 1743
        <sgmltag>table</sgmltag> tag in <acronym>HTML</acronym> tabular
        output mode. This command is equivalent to <literal>\pset
        tableattr <replaceable
        class="parameter">table_options</replaceable></literal>.
        </para>
        </listitem>
      </varlistentry>
1744 1745


1746 1747 1748 1749
      <varlistentry>
       <term><literal>\timing</literal></term>
        <listitem>
        <para>
1750
         Toggles a display of how long each SQL statement takes, in milliseconds.
1751 1752 1753
        </para>
       </listitem>
      </varlistentry>
1754

1755

1756 1757 1758 1759 1760 1761 1762 1763 1764 1765
      <varlistentry>
        <term><literal>\w</literal> {<replaceable class="parameter">filename</replaceable> | <replaceable class="parameter">|command</replaceable>}</term>
        <listitem>
        <para>
        Outputs the current query buffer to the file <replaceable
        class="parameter">filename</replaceable> or pipes it to the Unix
        command <replaceable class="parameter">command</replaceable>.
        </para>
        </listitem>
      </varlistentry>
1766 1767


1768 1769 1770 1771
      <varlistentry>
        <term><literal>\x</literal></term>
        <listitem>
        <para>
1772
        Toggles expanded table formatting mode. As such it is equivalent to
1773
        <literal>\pset expanded</literal>.
1774 1775 1776
       </para>
       </listitem>
      </varlistentry>
1777 1778


1779
      <varlistentry>
1780
        <term><literal>\z [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1781 1782
        <listitem>
        <para>
1783
        Produces a list of all available tables, views and sequences with their
1784
        associated access privileges.
1785 1786 1787
        If a <replaceable class="parameter">pattern</replaceable> is
        specified, only tables,views and sequences whose names match the pattern are listed.
        </para>
1788

1789
        <para>
1790 1791 1792
        The <xref linkend="sql-grant" endterm="sql-grant-title"> and
        <xref linkend="sql-revoke" endterm="sql-revoke-title">
        commands are used to set access privileges.
1793
        </para>
1794

1795 1796 1797
        <para>
        This is an alias for <command>\dp</command> (<quote>display
        privileges</quote>).
1798
        </para>
1799 1800
        </listitem>
      </varlistentry>
1801

1802

1803
      <varlistentry>
1804
        <term><literal>\! [ <replaceable class="parameter">command</replaceable> ]</literal></term>
1805 1806 1807 1808 1809 1810 1811 1812 1813
        <listitem>
        <para>
        Escapes to a separate Unix shell or executes the Unix command
        <replaceable class="parameter">command</replaceable>. The
        arguments are not further interpreted, the shell will see them
        as is.
        </para>
        </listitem>
      </varlistentry>
1814 1815


1816 1817 1818 1819
      <varlistentry>
        <term><literal>\?</literal></term>
        <listitem>
        <para>
1820
        Shows help information about the backslash commands.
1821 1822 1823
        </para>
        </listitem>
      </varlistentry>
1824

1825 1826
    </variablelist>
  </para>
1827

1828 1829 1830 1831 1832 1833 1834 1835
  <refsect3 id="APP-PSQL-patterns">
   <title id="APP-PSQL-patterns-title">Patterns</title>

   <indexterm>
    <primary>patterns</primary>
    <secondary>in psql and pg_dump</secondary>
   </indexterm>

1836 1837 1838
  <para>
   The various <literal>\d</> commands accept a <replaceable
   class="parameter">pattern</replaceable> parameter to specify the
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
   object name(s) to be displayed.  In the simplest case, a pattern
   is just the exact name of the object.  The characters within a
   pattern are normally folded to lower case, just as in SQL names;
   for example, <literal>\dt FOO</> will display the table named
   <literal>foo</>.  As in SQL names, placing double quotes around
   a pattern stops folding to lower case.  Should you need to include
   an actual double quote character in a pattern, write it as a pair
   of double quotes within a double-quote sequence; again this is in
   accord with the rules for SQL quoted identifiers.  For example,
   <literal>\dt "FOO""BAR"</> will display the table named
   <literal>FOO"BAR</> (not <literal>foo"bar</>).  Unlike the normal
   rules for SQL names, you can put double quotes around just part
   of a pattern, for instance <literal>\dt FOO"FOO"BAR</> will display
   the table named <literal>fooFOObar</>.
  </para>

  <para>
   Within a pattern, <literal>*</> matches any sequence of characters
   (including no characters) and <literal>?</> matches any single character.
   (This notation is comparable to Unix shell file name patterns.)
   For example, <literal>\dt int*</> displays all tables whose names
   begin with <literal>int</>.  But within double quotes, <literal>*</>
   and <literal>?</> lose these special meanings and are just matched
   literally.
1863 1864 1865
  </para>

  <para>
1866
   A pattern that contains a dot (<literal>.</>) is interpreted as a schema
1867
   name pattern followed by an object name pattern.  For example,
1868 1869 1870
   <literal>\dt foo*.bar*</> displays all tables whose table name
   starts with <literal>bar</> that are in schemas whose schema name
   starts with <literal>foo</>.  When no dot appears, then the pattern
1871
   matches only objects that are visible in the current schema search path.
1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896
   Again, a dot within double quotes loses its special meaning and is matched
   literally.
  </para>

  <para>
   Advanced users can use regular-expression notations such as character
   classes, for example <literal>[0-9]</> to match any digit.  All regular
   expression special characters work as specified in
   <xref linkend="functions-posix-regexp">, except for <literal>.</> which
   is taken as a separator as mentioned above, <literal>*</> which is
   translated to the regular-expression notation <literal>.*</>, and
   <literal>?</> which is translated to <literal>.</>.  You can emulate
   these pattern characters at need by writing
   <literal>?</> for <literal>.</>,
   <literal>(<replaceable class="parameter">R</replaceable>+|)</literal> for
   <literal><replaceable class="parameter">R</replaceable>*</literal>, or
   <literal>(<replaceable class="parameter">R</replaceable>|)</literal> for
   <literal><replaceable class="parameter">R</replaceable>?</literal>.
   Remember that the pattern must match the whole name, unlike the usual
   interpretation of regular expressions; write <literal>*</> at the beginning
   and/or end if you don't wish the pattern to be anchored.
   Note that within double quotes, all regular expression special characters
   lose their special meanings and are matched literally.  Also, the regular
   expression special characters are matched literally in operator name
   patterns (i.e., the argument of <literal>\do</>).
1897 1898 1899 1900 1901
  </para>

  <para>
   Whenever the <replaceable class="parameter">pattern</replaceable> parameter
   is omitted completely, the <literal>\d</> commands display all objects
1902 1903 1904
   that are visible in the current schema search path &mdash; this is
   equivalent to using the pattern <literal>*</>.
   To see all objects in the database, use the pattern <literal>*.*</>.
1905
  </para>
1906
  </refsect3>
1907
 </refsect2>
1908

1909 1910
 <refsect2>
  <title>Advanced features</title>
1911

1912
   <refsect3 id="APP-PSQL-variables">
1913 1914 1915
    <title id="APP-PSQL-variables-title">Variables</title>

    <para>
1916
    <application>psql</application> provides variable substitution
1917 1918
    features similar to common Unix command shells.
    Variables are simply name/value pairs, where the value
1919 1920 1921
    can be any string of any length. To set variables, use the
    <application>psql</application> meta-command
    <command>\set</command>:
1922
<programlisting>
1923
testdb=&gt; <userinput>\set foo bar</userinput>
1924
</programlisting>
1925 1926
    sets the variable <literal>foo</literal> to the value
    <literal>bar</literal>. To retrieve the content of the variable, precede
1927 1928
    the name with a colon and use it as the argument of any slash
    command:
1929
<programlisting>
1930
testdb=&gt; <userinput>\echo :foo</userinput>
1931
bar
1932
</programlisting>
1933 1934 1935 1936
    </para>

    <note>
    <para>
1937 1938 1939 1940 1941 1942 1943 1944 1945 1946
    The arguments of <command>\set</command> are subject to the same
    substitution rules as with other commands. Thus you can construct
    interesting references such as <literal>\set :foo
    'something'</literal> and get <quote>soft links</quote> or
    <quote>variable variables</quote> of <productname>Perl</productname>
    or <productname><acronym>PHP</acronym></productname> fame,
    respectively. Unfortunately (or fortunately?), there is no way to do
    anything useful with these constructs. On the other hand,
    <literal>\set bar :foo</literal> is a perfectly valid way to copy a
    variable.
1947 1948 1949 1950
    </para>
    </note>

    <para>
1951
    If you call <command>\set</command> without a second argument, the
1952
    variable is set, with an empty string as value. To unset (or delete) a
1953
    variable, use the command <command>\unset</command>.
1954 1955 1956
    </para>

    <para>
1957 1958
    <application>psql</application>'s internal variable names can
    consist of letters, numbers, and underscores in any order and any
1959
    number of them. A number of these variables are treated specially
1960 1961 1962 1963 1964 1965 1966 1967
    by <application>psql</application>. They indicate certain option
    settings that can be changed at run time by altering the value of
    the variable or represent some state of the application. Although
    you can use these variables for any other purpose, this is not
    recommended, as the program behavior might grow really strange
    really quickly. By convention, all specially treated variables
    consist of all upper-case letters (and possibly numbers and
    underscores). To ensure maximum compatibility in the future, avoid
1968 1969
    using such variable names for your own purposes. A list of all specially
    treated variables follows.
1970 1971
   </para>

1972
    <variablelist>
1973
      <varlistentry>
1974 1975 1976 1977
      <indexterm>
       <primary>autocommit</primary>
       <secondary>psql</secondary>
      </indexterm>
1978
        <term><varname>AUTOCOMMIT</varname></term>
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
        <listitem>
        <para>
        When <literal>on</> (the default), each SQL command is automatically
        committed upon successful completion.  To postpone commit in this
        mode, you must enter a <command>BEGIN</> or <command>START
        TRANSACTION</> SQL command.  When <literal>off</> or unset, SQL
        commands are not committed until you explicitly issue
        <command>COMMIT</> or <command>END</>.  The autocommit-off
        mode works by issuing an implicit <command>BEGIN</> for you, just
        before any command that is not already in a transaction block and
        is not itself a <command>BEGIN</> or other transaction-control
1990 1991
        command, nor a command that cannot be executed inside a transaction
        block (such as <command>VACUUM</>).
1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
        </para>

        <note>
        <para>
         In autocommit-off mode, you must explicitly abandon any failed
         transaction by entering <command>ABORT</> or <command>ROLLBACK</>.
         Also keep in mind that if you exit the session
         without committing, your work will be lost.
        </para>
        </note>

        <note>
        <para>
         The autocommit-on mode is <productname>PostgreSQL</>'s traditional
         behavior, but autocommit-off is closer to the SQL spec.  If you
         prefer autocommit-off, you may wish to set it in the system-wide
2008 2009
         <filename>psqlrc</filename> file or your
         <filename>~/.psqlrc</filename> file.
2010 2011 2012
        </para>
        </note>
        </listitem>
2013 2014
      </varlistentry>

2015
      <varlistentry>
2016
        <term><varname>DBNAME</varname></term>
2017 2018
        <listitem>
        <para>
2019 2020 2021
        The name of the database you are currently connected to. This is
        set every time you connect to a database (including program
        start-up), but can be unset.
2022 2023
        </para>
        </listitem>
2024 2025 2026
      </varlistentry>

      <varlistentry>
2027
        <term><varname>ECHO</varname></term>
2028 2029 2030
        <listitem>
        <para>
        If set to <literal>all</literal>, all lines
2031
        entered from the keyboard or from a script are written to the standard output
2032 2033 2034 2035 2036 2037 2038 2039
        before they are parsed or executed. To select this behavior on program
        start-up, use the switch <option>-a</option>. If set to
        <literal>queries</literal>,
        <application>psql</application> merely prints all queries as
        they are sent to the server. The switch for this is
        <option>-e</option>.
        </para>
        </listitem>
2040 2041 2042
      </varlistentry>

      <varlistentry>
2043
        <term><varname>ECHO_HIDDEN</varname></term>
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054
        <listitem>
        <para>
        When this variable is set and a backslash command queries the
        database, the query is first shown. This way you can study the
        <productname>PostgreSQL</productname> internals and provide
        similar functionality in your own programs. (To select this behavior
        on program start-up, use the switch <option>-E</option>.)  If you set
        the variable to the value <literal>noexec</literal>, the queries are
        just shown but are not actually sent to the server and executed.
        </para>
        </listitem>
2055 2056
      </varlistentry>

2057
      <varlistentry>
2058
        <term><varname>ENCODING</varname></term>
2059 2060
        <listitem>
        <para>
2061
        The current client character set encoding.
2062 2063
        </para>
        </listitem>
2064 2065
      </varlistentry>

2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092
      <varlistentry>
        <term><varname>FETCH_COUNT</varname></term>
        <listitem>
        <para>
        If this variable is set to an integer value &gt; 0,
        the results of <command>SELECT</command> queries are fetched
        and displayed in groups of that many rows, rather than the
        default behavior of collecting the entire result set before
        display.  Therefore only a
        limited amount of memory is used, regardless of the size of
        the result set.  Settings of 100 to 1000 are commonly used
        when enabling this feature.
        Keep in mind that when using this feature, a query may
        fail after having already displayed some rows.
        </para>
        <tip>
        <para>
        Although you can use any output format with this feature,
        the default <literal>aligned</> format tends to look bad
        because each group of <varname>FETCH_COUNT</varname> rows
        will be formatted separately, leading to varying column
        widths across the row groups.  The other output formats work better.
        </para>
        </tip>
        </listitem>
      </varlistentry>

2093
      <varlistentry>
2094
        <term><varname>HISTCONTROL</varname></term>
2095 2096
        <listitem>
        <para>
2097 2098 2099 2100 2101 2102 2103
         If this variable is set to <literal>ignorespace</literal>,
         lines which begin with a space are not entered into the history
         list. If set to a value of <literal>ignoredups</literal>, lines
         matching the previous history line are not entered. A value of
         <literal>ignoreboth</literal> combines the two options. If
         unset, or if set to any other value than those above, all lines
         read in interactive mode are saved on the history list.
2104
        </para>
2105 2106
        <note>
        <para>
2107
        This feature was shamelessly plagiarized from
2108
        <application>Bash</application>.
2109
        </para>
2110 2111 2112 2113 2114 2115 2116 2117
        </note>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>HISTFILE</varname></term>
        <listitem>
        <para>
2118
        The file name that will be used to store the history list. The default
2119
        value is <filename>~/.psql_history</filename>.  For example, putting
2120
<programlisting>
2121
\set HISTFILE ~/.psql_history- :DBNAME
2122
</programlisting>
2123 2124 2125
        in <filename>~/.psqlrc</filename> will cause
        <application>psql</application> to maintain a separate history for
        each database.
2126 2127 2128 2129 2130 2131
        </para>
        <note>
        <para>
        This feature was shamelessly plagiarized from
        <application>Bash</application>.
        </para>
2132
        </note>
2133
        </listitem>
2134 2135 2136
      </varlistentry>

      <varlistentry>
2137
        <term><varname>HISTSIZE</varname></term>
2138 2139
        <listitem>
        <para>
2140 2141
        The number of commands to store in the command history. The
        default value is 500.
2142
        </para>
2143 2144
        <note>
        <para>
2145
        This feature was shamelessly plagiarized from
2146
        <application>Bash</application>.
2147 2148
        </para>
        </note>
2149
        </listitem>
2150 2151 2152
      </varlistentry>

      <varlistentry>
2153
        <term><varname>HOST</varname></term>
2154 2155
        <listitem>
        <para>
2156 2157 2158
        The database server host you are currently connected to. This is
        set every time you connect to a database (including program
        start-up), but can be unset.
2159 2160
        </para>
        </listitem>
2161 2162 2163
      </varlistentry>

      <varlistentry>
2164
        <term><varname>IGNOREEOF</varname></term>
2165 2166
        <listitem>
        <para>
2167 2168 2169 2170 2171 2172 2173
         If unset, sending an <acronym>EOF</> character (usually
         <keycombo action="simul"><keycap>Control</><keycap>D</></>)
         to an interactive session of <application>psql</application>
         will terminate the application. If set to a numeric value,
         that many <acronym>EOF</> characters are ignored before the
         application terminates.  If the variable is set but has no
         numeric value, the default is 10.
2174
        </para>
2175 2176
        <note>
        <para>
2177
        This feature was shamelessly plagiarized from
2178
        <application>Bash</application>.
2179 2180
        </para>
        </note>
2181
        </listitem>
2182 2183 2184
      </varlistentry>

      <varlistentry>
2185
        <term><varname>LASTOID</varname></term>
2186 2187
        <listitem>
        <para>
2188
        The value of the last affected OID, as returned from an
2189 2190 2191 2192
        <command>INSERT</command> or <command>lo_insert</command>
        command. This variable is only guaranteed to be valid until
        after the result of the next <acronym>SQL</acronym> command has
        been displayed.
2193 2194
        </para>
        </listitem>
2195 2196
      </varlistentry>

2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211
      <varlistentry>
      <indexterm>
       <primary>rollback</primary>
       <secondary>psql</secondary>
      </indexterm>
        <term><varname>ON_ERROR_ROLLBACK</varname></term>
        <listitem>
        <para>
        When <literal>on</>, if a statement in a transaction block
        generates an error, the error is ignored and the transaction
        continues. When <literal>interactive</>, such errors are only
        ignored in interactive sessions, and not when reading script
        files. When <literal>off</> (the default), a statement in a
        transaction block that generates an error aborts the entire
        transaction. The on_error_rollback-on mode works by issuing an
Bruce Momjian's avatar
Bruce Momjian committed
2212
        implicit <command>SAVEPOINT</> for you, just before each command
2213 2214 2215 2216 2217 2218
        that is in a transaction block, and rolls back to the savepoint
        on error.
        </para>
        </listitem>
      </varlistentry>

2219
      <varlistentry>
2220
        <term><varname>ON_ERROR_STOP</varname></term>
2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
        <listitem>
        <para>
        By default, if non-interactive scripts encounter an error, such
        as a malformed <acronym>SQL</acronym> command or internal
        meta-command, processing continues. This has been the
        traditional behavior of <application>psql</application> but it
        is sometimes not desirable. If this variable is set, script
        processing will immediately terminate. If the script was called
        from another script it will terminate in the same fashion. If
        the outermost script was not called from an interactive
        <application>psql</application> session but rather using the
        <option>-f</option> option, <application>psql</application> will
        return error code 3, to distinguish this case from fatal error
        conditions (error code 1).
        </para>
        </listitem>
2237 2238
      </varlistentry>

2239
      <varlistentry>
2240
        <term><varname>PORT</varname></term>
2241 2242
        <listitem>
        <para>
2243 2244 2245
        The database server port to which you are currently connected.
        This is set every time you connect to a database (including
        program start-up), but can be unset.
2246 2247
        </para>
        </listitem>
2248 2249 2250
      </varlistentry>

      <varlistentry>
2251 2252 2253
        <term><varname>PROMPT1</varname></term>
        <term><varname>PROMPT2</varname></term>
        <term><varname>PROMPT3</varname></term>
2254 2255 2256 2257 2258 2259 2260 2261
        <listitem>
        <para>
        These specify what the prompts <application>psql</application>
        issues should look like. See <xref
        linkend="APP-PSQL-prompting"
        endterm="APP-PSQL-prompting-title"> below.
        </para>
        </listitem>
2262 2263 2264
      </varlistentry>

      <varlistentry>
2265
        <term><varname>QUIET</varname></term>
2266 2267 2268 2269 2270 2271 2272
        <listitem>
        <para>
        This variable is equivalent to the command line option
        <option>-q</option>. It is probably not too useful in
        interactive mode.
        </para>
        </listitem>
2273 2274 2275
      </varlistentry>

      <varlistentry>
2276
        <term><varname>SINGLELINE</varname></term>
2277 2278 2279 2280 2281 2282
        <listitem>
        <para>
        This variable is equivalent to the command line option
        <option>-S</option>.
        </para>
        </listitem>
2283 2284 2285
      </varlistentry>

      <varlistentry>
2286
        <term><varname>SINGLESTEP</varname></term>
2287 2288 2289 2290 2291 2292
        <listitem>
        <para>
        This variable is equivalent to the command line option
        <option>-s</option>.
        </para>
        </listitem>
2293
      </varlistentry>
2294 2295

      <varlistentry>
2296
        <term><varname>USER</varname></term>
2297 2298
        <listitem>
        <para>
2299 2300 2301
        The database user you are currently connected as. This is set
        every time you connect to a database (including program
        start-up), but can be unset.
2302 2303
        </para>
        </listitem>
2304 2305
      </varlistentry>

2306
      <varlistentry>
2307
        <term><varname>VERBOSITY</varname></term>
2308 2309 2310 2311 2312 2313 2314
        <listitem>
        <para>
        This variable can be set to the values <literal>default</>,
        <literal>verbose</>, or <literal>terse</> to control the verbosity
        of error reports.
        </para>
        </listitem>
2315 2316
      </varlistentry>

2317 2318
    </variablelist>

2319
   </refsect3>
2320

2321 2322
   <refsect3>
    <title><acronym>SQL</acronym> Interpolation</title>
2323 2324

    <para>
2325 2326 2327 2328 2329
    An additional useful feature of <application>psql</application>
    variables is that you can substitute (<quote>interpolate</quote>)
    them into regular <acronym>SQL</acronym> statements. The syntax for
    this is again to prepend the variable name with a colon
    (<literal>:</literal>).
2330
<programlisting>
2331 2332
testdb=&gt; <userinput>\set foo 'my_table'</userinput>
testdb=&gt; <userinput>SELECT * FROM :foo;</userinput>
2333
</programlisting>
2334 2335 2336 2337 2338
    would then query the table <literal>my_table</literal>. The value of
    the variable is copied literally, so it can even contain unbalanced
    quotes or backslash commands. You must make sure that it makes sense
    where you put it. Variable interpolation will not be performed into
    quoted <acronym>SQL</acronym> entities.
2339 2340 2341
    </para>

    <para>
2342 2343 2344
    A popular application of this facility is to refer to the last
    inserted <acronym>OID</acronym> in subsequent statements to build a
    foreign key scenario. Another possible use of this mechanism is to
2345
    copy the contents of a file into a table column. First load the file into a
2346
    variable and then proceed as above.
2347
<programlisting>
2348
testdb=&gt; <userinput>\set content '''' `cat my_file.txt` ''''</userinput>
2349
testdb=&gt; <userinput>INSERT INTO my_table VALUES (:content);</userinput>
2350
</programlisting>
2351
    One problem with this approach is that <filename>my_file.txt</filename>
2352
    might contain single quotes. These need to be escaped so that
2353 2354
    they don't cause a syntax error when the second line is processed. This
    could be done with the program <command>sed</command>:
2355
<programlisting>
2356
testdb=&gt; <userinput>\set content '''' `sed -e "s/'/''/g" &lt; my_file.txt` ''''</userinput>
2357
</programlisting>
2358 2359 2360 2361 2362 2363 2364 2365 2366
    If you are using non-standard-conforming strings then you'll also need
    to double backslashes.  This is a bit tricky:
<programlisting>
testdb=&gt; <userinput>\set content '''' `sed -e "s/'/''/g" -e 's/\\/\\\\/g' &lt; my_file.txt` ''''</userinput>
</programlisting>
    Note the use of different shell quoting conventions so that neither
    the single quote marks nor the backslashes are special to the shell.
    Backslashes are still special to <command>sed</command>, however, so
    we need to double them.  (Perhaps
2367
    at one point you thought it was great that all Unix commands use the
2368
    same escape character.)
2369 2370
    </para>

2371
    <para>
2372
    Since colons may legally appear in SQL commands, the following rule
2373 2374 2375 2376
    applies: the character sequence
    <quote>:name</quote> is not changed unless <quote>name</> is the name
    of a variable that is currently set. In any case you can escape
    a colon with a backslash to protect it from substitution. (The
2377
    colon syntax for variables is standard <acronym>SQL</acronym> for
2378
    embedded query languages, such as <application>ECPG</application>.
2379 2380 2381
    The colon syntax for array slices and type casts are
    <productname>PostgreSQL</productname> extensions, hence the
    conflict.)
2382 2383
    </para>

2384
   </refsect3>
2385

2386
   <refsect3 id="APP-PSQL-prompting">
2387 2388 2389
    <title id="APP-PSQL-prompting-title">Prompting</title>

    <para>
2390
    The prompts <application>psql</application> issues can be customized
2391 2392
    to your preference. The three variables <varname>PROMPT1</varname>,
    <varname>PROMPT2</varname>, and <varname>PROMPT3</varname> contain strings
2393 2394
    and special escape sequences that describe the appearance of the
    prompt. Prompt 1 is the normal prompt that is issued when
2395 2396 2397
    <application>psql</application> requests a new command. Prompt 2 is
    issued when more input is expected during command input because the
    command was not terminated with a semicolon or a quote was not closed.
2398 2399
    Prompt 3 is issued when you run an <acronym>SQL</acronym>
    <command>COPY</command> command and you are expected to type in the
2400
    row values on the terminal.
2401 2402 2403
    </para>

    <para>
2404
    The value of the selected prompt variable is printed literally,
2405
    except where a percent sign (<literal>%</literal>) is encountered.
2406 2407
    Depending on the next character, certain other text is substituted
    instead. Defined substitutions are:
2408 2409 2410 2411

    <variablelist>
      <varlistentry>
        <term><literal>%M</literal></term>
2412
        <listitem>
2413
         <para>
2414
          The full host name (with domain name) of the database server,
2415 2416
          or <literal>[local]</literal> if the connection is over a Unix
          domain socket, or
2417 2418
          <literal>[local:<replaceable>/dir/name</replaceable>]</literal>, 
          if the Unix domain socket is not at the compiled in default
2419 2420 2421
          location.
        </para>
       </listitem>
2422 2423 2424 2425
      </varlistentry>

      <varlistentry>
        <term><literal>%m</literal></term>
2426
        <listitem>
2427
         <para>
2428
          The host name of the database server, truncated at the
2429 2430
          first dot, or <literal>[local]</literal> if the connection is
          over a Unix domain socket.
2431 2432
         </para>
        </listitem>
2433 2434 2435 2436
      </varlistentry>

      <varlistentry>
        <term><literal>%&gt;</literal></term>
2437
        <listitem><para>The port number at which the database server is listening.</para></listitem>
2438 2439 2440 2441
      </varlistentry>

      <varlistentry>
        <term><literal>%n</literal></term>
2442
        <listitem>
2443 2444 2445 2446 2447 2448 2449
         <para>
          The database session user name.  (The expansion of this
          value might change during a database session as the result
          of the command <command>SET SESSION
          AUTHORIZATION</command>.)
         </para>
        </listitem>
2450 2451 2452 2453
      </varlistentry>

      <varlistentry>
        <term><literal>%/</literal></term>
2454
        <listitem><para>The name of the current database.</para></listitem>
2455 2456 2457 2458
      </varlistentry>

      <varlistentry>
        <term><literal>%~</literal></term>
2459
        <listitem><para>Like <literal>%/</literal>, but the output is <literal>~</literal>
Peter Eisentraut's avatar
Peter Eisentraut committed
2460
         (tilde) if the database is your default database.</para></listitem>
2461 2462 2463 2464
      </varlistentry>

      <varlistentry>
        <term><literal>%#</literal></term>
2465
        <listitem>
2466 2467 2468 2469 2470 2471 2472 2473
         <para>
          If the session user is a database superuser, then a
          <literal>#</literal>, otherwise a <literal>&gt;</literal>.
          (The expansion of this value might change during a database
          session as the result of the command <command>SET SESSION
          AUTHORIZATION</command>.)
         </para>
        </listitem>
2474 2475 2476 2477
      </varlistentry>

      <varlistentry>
        <term><literal>%R</literal></term>
2478 2479 2480 2481 2482 2483 2484
        <listitem>
        <para>
        In prompt 1 normally <literal>=</literal>, but <literal>^</literal> if
        in single-line mode, and <literal>!</literal> if the session is
        disconnected from the database (which can happen if
        <command>\connect</command> fails). In prompt 2 the sequence is
        replaced by <literal>-</literal>, <literal>*</literal>, a single quote,
2485
        a double quote, or a dollar sign, depending on whether
2486 2487 2488
        <application>psql</application> expects more input because the
        command wasn't terminated yet, because you are inside a
        <literal>/* ... */</literal> comment, or because you are inside
2489 2490
        a quoted or dollar-escaped string. In prompt 3 the sequence doesn't
        produce anything.
2491 2492
        </para>
        </listitem>
2493 2494 2495
      </varlistentry>

      <varlistentry>
2496
        <term><literal>%x</literal></term>
2497 2498 2499 2500 2501 2502 2503 2504 2505
        <listitem>
        <para>
        Transaction status: an empty string when not in a transaction
        block, or <literal>*</> when in a transaction block, or
        <literal>!</> when in a failed transaction block, or <literal>?</>
        when the transaction state is indeterminate (for example, because
        there is no connection).
        </para>
        </listitem>
2506 2507 2508 2509
      </varlistentry>

      <varlistentry>
        <term><literal>%</literal><replaceable class="parameter">digits</replaceable></term>
2510 2511
        <listitem>
        <para>
2512
        The character with the indicated octal code is substituted.
2513 2514
        </para>
        </listitem>
2515 2516 2517
      </varlistentry>

      <varlistentry>
2518
        <term><literal>%:</literal><replaceable class="parameter">name</replaceable><literal>:</literal></term>
2519 2520 2521 2522 2523 2524 2525 2526
        <listitem>
        <para>
        The value of the <application>psql</application> variable
        <replaceable class="parameter">name</replaceable>. See the
        section <xref linkend="APP-PSQL-variables"
        endterm="APP-PSQL-variables-title"> for details.
        </para>
        </listitem>
2527 2528 2529 2530
      </varlistentry>

      <varlistentry>
        <term><literal>%`</literal><replaceable class="parameter">command</replaceable><literal>`</literal></term>
2531 2532 2533 2534 2535 2536 2537
        <listitem>
        <para>
        The output of <replaceable
        class="parameter">command</replaceable>, similar to ordinary
        <quote>back-tick</quote> substitution.
        </para>
        </listitem>
2538 2539
      </varlistentry>

2540 2541
      <varlistentry>
        <term><literal>%[</literal> ... <literal>%]</literal></term>
2542
        <listitem>
2543 2544 2545 2546
         <para>
         Prompts may contain terminal control characters which, for
         example, change the color, background, or style of the prompt
         text, or change the title of the terminal window. In order for
Peter Eisentraut's avatar
Peter Eisentraut committed
2547
         the line editing features of <application>Readline</application> to work properly, these
2548 2549 2550 2551 2552
         non-printing control characters must be designated as invisible
         by surrounding them with <literal>%[</literal> and
         <literal>%]</literal>. Multiple pairs of these may occur within
         the prompt.  For example,
<programlisting>
2553
testdb=&gt; \set PROMPT1 '%[%033[1;33;40m%]%n@%/%R%[%033[0m%]%# '
2554 2555 2556
</programlisting>
         results in a boldfaced (<literal>1;</literal>) yellow-on-black
         (<literal>33;40</literal>) prompt on VT100-compatible, color-capable
2557 2558
         terminals.
        </para>
2559 2560 2561
        </listitem>
      </varlistentry>

2562 2563
    </variablelist>

2564
    To insert a percent sign into your prompt, write
2565
    <literal>%%</literal>. The default prompts are
2566 2567
    <literal>'%/%R%# '</literal> for prompts 1 and 2, and
    <literal>'&gt;&gt; '</literal> for prompt 3.
2568 2569
    </para>

2570 2571
    <note>
    <para>
2572 2573
    This feature was shamelessly plagiarized from
    <application>tcsh</application>.
2574 2575 2576
    </para>
    </note>

2577
   </refsect3>
2578

2579
   <refsect3>
2580
    <title>Command-Line Editing</title>
2581 2582

    <para>
2583 2584
    <application>psql</application> supports the <application>Readline</application>
    library for convenient line editing and retrieval. The command
2585 2586
    history is automatically saved when <application>psql</application>
    exits and is reloaded when
2587 2588
    <application>psql</application> starts up. Tab-completion is also
    supported, although the completion logic makes no claim to be an
2589
    <acronym>SQL</acronym> parser.  If for some reason you do not like the tab completion, you
2590
    can turn it off by putting this in a file named
2591
    <filename>.inputrc</filename> in your home directory:
2592 2593 2594 2595 2596
<programlisting>
$if psql
set disable-completion on
$endif
</programlisting>
2597
    (This is not a <application>psql</application> but a
2598
    <application>Readline</application> feature. Read its documentation
2599
    for further details.)
2600
    </para>
2601
   </refsect3>
2602
  </refsect2>
2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628
 </refsect1>


 <refsect1>
  <title>Environment</title>

  <variablelist>
   <varlistentry>
    <term><envar>PAGER</envar></term>

    <listitem>
     <para>
      If the query results do not fit on the screen, they are piped
      through this command.  Typical values are
      <literal>more</literal> or <literal>less</literal>.  The default
      is platform-dependent.  The use of the pager can be disabled by
      using the <command>\pset</command> command.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><envar>PGDATABASE</envar></term>

    <listitem>
     <para>
2629
      Default connection database
2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><envar>PGHOST</envar></term>
    <term><envar>PGPORT</envar></term>
    <term><envar>PGUSER</envar></term>

    <listitem>
     <para>
      Default connection parameters
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><envar>PSQL_EDITOR</envar></term>
    <term><envar>EDITOR</envar></term>
    <term><envar>VISUAL</envar></term>

    <listitem>
     <para>
      Editor used by the <command>\e</command> command.  The variables
      are examined in the order listed; the first that is set is used.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><envar>SHELL</envar></term>

    <listitem>
     <para>
      Command executed by the <command>\!</command> command.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><envar>TMPDIR</envar></term>

    <listitem>
     <para>
      Directory for storing temporary files.  The default is
      <filename>/tmp</filename>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>


 <refsect1>
  <title>Files</title>

  <itemizedlist>
   <listitem>
    <para>
     Before starting up, <application>psql</application> attempts to
2690 2691 2692 2693
     read and execute commands from the system-wide
     <filename>psqlrc</filename> file and the user's
     <filename>~/.psqlrc</filename> file.
     (On Windows, the user's startup file is named
2694
     <filename>%APPDATA%\postgresql\psqlrc.conf</filename>.)
2695
     See <filename><replaceable>PREFIX</>/share/psqlrc.sample</>
2696
     for information on setting up the system-wide file.  It could be used
2697
     to set up the client or the server to taste (using the <command>\set
2698 2699 2700 2701
     </command> and <command>SET</command> commands).
    </para>
   </listitem>

2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712
   <listitem>
    <para>
     Both the system-wide <filename>psqlrc</filename> file and the user's
     <filename>~/.psqlrc</filename> file can be made version-specific
     by appending a dash and the <productname>PostgreSQL</productname>
     release number, for example <filename>~/.psqlrc-&version;</filename>.
     A matching version-specific file will be read in preference to a
     non-version-specific file.
    </para>
   </listitem>

2713 2714 2715
   <listitem>
    <para>
     The command-line history is stored in the file
2716
     <filename>~/.psql_history</filename>, or
2717
     <filename>%APPDATA%\postgresql\psql_history</filename> on Windows.
2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729
    </para>
   </listitem>
  </itemizedlist>
 </refsect1>


 <refsect1>
  <title>Notes</title>

    <itemizedlist>
      <listitem>
      <para>
2730 2731 2732 2733
      In an earlier life <application>psql</application> allowed the
      first argument of a single-letter backslash command to start
      directly after the command, without intervening whitespace. For
      compatibility this is still supported to some extent,
2734
      but we are not going to explain the details here as this use is
2735
      discouraged.  If you get strange messages, keep this in mind.
2736 2737
      For example
<programlisting>
2738
testdb=&gt; <userinput>\foo</userinput>
2739
Field separator is "oo".
2740 2741 2742 2743
</programlisting>
      which is perhaps not what one would expect.
      </para>
      </listitem>
2744

2745 2746 2747 2748 2749
      <listitem>
      <para>
      <application>psql</application> only works smoothly with servers
      of the same version. That does not mean other combinations will
      fail outright, but subtle and not-so-subtle problems might come
2750 2751
      up.  Backslash commands are particularly likely to fail if the
      server is of a different version.
2752 2753
      </para>
      </listitem>
2754

2755 2756
    </itemizedlist>
 </refsect1>
2757 2758


2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782
 <refsect1>
  <title>Notes for Windows users</title>

 <para>
  <application>psql</application> is built as a <quote>console
  application</>.  Since the Windows console windows use a different
  encoding than the rest of the system, you must take special care
  when using 8-bit characters within <application>psql</application>.
  If <application>psql</application> detects a problematic
  console code page, it will warn you at startup. To change the
  console code page, two things are necessary:

   <itemizedlist>
    <listitem>
     <para>
      Set the code page by entering <userinput>cmd.exe /c chcp
      1252</userinput>. (1252 is a code page that is appropriate for
      German; replace it with your value.) If you are using Cygwin,
      you can put this command in <filename>/etc/profile</filename>.
     </para>
    </listitem>

    <listitem>
     <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
2783
      Set the console font to <literal>Lucida Console</>, because the
2784 2785 2786 2787 2788 2789 2790 2791 2792
      raster font does not work with the ANSI code page.
     </para>
    </listitem>
   </itemizedlist>
 </para>

 </refsect1>


2793
 <refsect1 id="APP-PSQL-examples">
2794 2795 2796
  <title id="APP-PSQL-examples-title">Examples</title>

  <para>
2797
  The first example shows how to spread a command over several lines of
2798
  input. Notice the changing prompt:
2799
<programlisting>
2800
testdb=&gt; <userinput>CREATE TABLE my_table (</userinput>
2801 2802
testdb(&gt; <userinput> first integer not null default 0,</userinput>
testdb(&gt; <userinput> second text)</userinput>
2803
testdb-&gt; <userinput>;</userinput>
2804
CREATE TABLE
2805
</programlisting>
2806
  Now look at the table definition again:
2807
<programlisting>
2808
testdb=&gt; <userinput>\d my_table</userinput>
2809 2810 2811 2812 2813
             Table "my_table"
 Attribute |  Type   |      Modifier
-----------+---------+--------------------
 first     | integer | not null default 0
 second    | text    |
2814

2815
</programlisting>
2816
  Now we change the prompt to something more interesting:
2817
<programlisting>
2818 2819
testdb=&gt; <userinput>\set PROMPT1 '%n@%m %~%R%# '</userinput>
peter@localhost testdb=&gt;
2820
</programlisting>
2821 2822
  Let's assume you have filled the table with data and want to take a
  look at it:
2823
<programlisting>
2824
peter@localhost testdb=&gt; SELECT * FROM my_table;
2825 2826 2827 2828 2829 2830 2831 2832
 first | second
-------+--------
     1 | one
     2 | two
     3 | three
     4 | four
(4 rows)

2833
</programlisting>
2834
  You can display tables in different ways by using the
2835
  <command>\pset</command> command:
2836
<programlisting>
2837
peter@localhost testdb=&gt; <userinput>\pset border 2</userinput>
2838
Border style is 2.
2839
peter@localhost testdb=&gt; <userinput>SELECT * FROM my_table;</userinput>
2840 2841 2842 2843 2844 2845 2846 2847 2848 2849
+-------+--------+
| first | second |
+-------+--------+
|     1 | one    |
|     2 | two    |
|     3 | three  |
|     4 | four   |
+-------+--------+
(4 rows)

2850
peter@localhost testdb=&gt; <userinput>\pset border 0</userinput>
2851
Border style is 0.
2852
peter@localhost testdb=&gt; <userinput>SELECT * FROM my_table;</userinput>
2853 2854 2855 2856 2857 2858 2859 2860
first second
----- ------
    1 one
    2 two
    3 three
    4 four
(4 rows)

2861
peter@localhost testdb=&gt; <userinput>\pset border 1</userinput>
2862
Border style is 1.
2863
peter@localhost testdb=&gt; <userinput>\pset format unaligned</userinput>
2864
Output format is unaligned.
2865
peter@localhost testdb=&gt; <userinput>\pset fieldsep ","</userinput>
2866
Field separator is ",".
2867
peter@localhost testdb=&gt; <userinput>\pset tuples_only</userinput>
2868
Showing only tuples.
2869
peter@localhost testdb=&gt; <userinput>SELECT second, first FROM my_table;</userinput>
2870 2871 2872 2873
one,1
two,2
three,3
four,4
2874
</programlisting>
2875
  Alternatively, use the short commands:
2876
<programlisting>
2877
peter@localhost testdb=&gt; <userinput>\a \t \x</userinput>
2878 2879 2880
Output format is aligned.
Tuples only is off.
Expanded display is on.
2881
peter@localhost testdb=&gt; <userinput>SELECT * FROM my_table;</userinput>
2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893
-[ RECORD 1 ]-
first  | 1
second | one
-[ RECORD 2 ]-
first  | 2
second | two
-[ RECORD 3 ]-
first  | 3
second | three
-[ RECORD 4 ]-
first  | 4
second | four
2894
</programlisting>
2895 2896
  </para>

2897
 </refsect1>
2898

2899 2900 2901 2902 2903 2904 2905 2906
 <refsect1>
  <title>See Also</title>

  <simplelist type="inline">
   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
  </simplelist>
 </refsect1>

2907
</refentry>