granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/pg_ctl-ref.sgml

   1 <!--
   2 doc/src/sgml/ref/pg_ctl-ref.sgml
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="app-pg-ctl">
   7  <refmeta>
   8   <refentrytitle><application>pg_ctl</application></refentrytitle>
   9   <manvolnum>1</manvolnum>
  10   <refmiscinfo>Application</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>pg_ctl</refname>
  15   <refpurpose>initialize, start, stop, or control a <productname>PostgreSQL</productname> server</refpurpose>
  16  </refnamediv>
  17
  18  <indexterm zone="app-pg-ctl">
  19   <primary>pg_ctl</primary>
  20  </indexterm>
  21
  22  <refsynopsisdiv>
  23   <cmdsynopsis>
  24    <command>pg_ctl</command>
  25    <arg choice="plain">init[db]</arg>
  26    <arg>-s</arg>
  27    <arg>-D <replaceable>datadir</replaceable></arg>
  28    <arg>-o <replaceable>initdb-options</replaceable></arg>
  29   </cmdsynopsis>
  30
  31   <cmdsynopsis>
  32    <command>pg_ctl</command>
  33    <arg choice="plain">start</arg>
  34    <arg>-w</arg>
  35    <arg>-t <replaceable>seconds</replaceable></arg>
  36    <arg>-s</arg>
  37    <arg>-D <replaceable>datadir</replaceable></arg>
  38    <arg>-l <replaceable>filename</replaceable></arg>
  39    <arg>-o <replaceable>options</replaceable></arg>
  40    <arg>-p <replaceable>path</replaceable></arg>
  41    <arg>-c</arg>
  42   </cmdsynopsis>
  43
  44   <cmdsynopsis>
  45    <command>pg_ctl</command>
  46    <arg choice="plain">stop</arg>
  47    <arg>-W</arg>
  48    <arg>-t <replaceable>seconds</replaceable></arg>
  49    <arg>-s</arg>
  50    <arg>-D <replaceable>datadir</replaceable></arg>
  51    <arg>-m
  52      <group choice="plain">
  53        <arg>s[mart]</arg>
  54        <arg>f[ast]</arg>
  55        <arg>i[mmediate]</arg>
  56      </group>
  57    </arg>
  58   </cmdsynopsis>
  59
  60   <cmdsynopsis>
  61    <command>pg_ctl</command>
  62    <arg choice="plain">restart</arg>
  63    <arg>-w</arg>
  64    <arg>-t <replaceable>seconds</replaceable></arg>
  65    <arg>-s</arg>
  66    <arg>-D <replaceable>datadir</replaceable></arg>
  67    <arg>-c</arg>
  68    <arg>-m
  69      <group choice="plain">
  70        <arg>s[mart]</arg>
  71        <arg>f[ast]</arg>
  72        <arg>i[mmediate]</arg>
  73      </group>
  74    </arg>
  75    <arg>-o <replaceable>options</replaceable></arg>
  76   </cmdsynopsis>
  77
  78   <cmdsynopsis>
  79    <command>pg_ctl</command>
  80    <arg choice="plain">reload</arg>
  81    <arg>-s</arg>
  82    <arg>-D <replaceable>datadir</replaceable></arg>
  83   </cmdsynopsis>
  84
  85   <cmdsynopsis>
  86    <command>pg_ctl</command>
  87    <arg choice="plain">status</arg>
  88    <arg>-D <replaceable>datadir</replaceable></arg>
  89   </cmdsynopsis>
  90
  91   <cmdsynopsis>
  92    <command>pg_ctl</command>
  93    <arg choice="plain">promote</arg>
  94    <arg>-s</arg>
  95    <arg>-D <replaceable>datadir</replaceable></arg>
  96   </cmdsynopsis>
  97
  98   <cmdsynopsis>
  99    <command>pg_ctl</command>
 100    <arg choice="plain">kill</arg>
 101    <arg choice="plain"><replaceable>signal_name</replaceable></arg>
 102    <arg choice="plain"><replaceable>process_id</replaceable></arg>
 103   </cmdsynopsis>
 104
 105   <cmdsynopsis>
 106    <command>pg_ctl</command>
 107    <arg choice="plain">register</arg>
 108    <arg>-N <replaceable>servicename</replaceable></arg>
 109    <arg>-U <replaceable>username</replaceable></arg>
 110    <arg>-P <replaceable>password</replaceable></arg>
 111    <arg>-D <replaceable>datadir</replaceable></arg>
 112    <arg>-S
 113      <group choice="plain">
 114        <arg>a[uto]</arg>
 115        <arg>d[emand]</arg>
 116      </group>
 117    </arg>
 118    <arg>-w</arg>
 119    <arg>-t <replaceable>seconds</replaceable></arg>
 120    <arg>-s</arg>
 121    <arg>-o <replaceable>options</replaceable></arg>
 122   </cmdsynopsis>
 123
 124   <cmdsynopsis>
 125    <command>pg_ctl</command>
 126    <arg choice="plain">unregister</arg>
 127    <arg>-N <replaceable>servicename</replaceable></arg>
 128   </cmdsynopsis>
 129  </refsynopsisdiv>
 130
 131
 132  <refsect1 id="app-pg-ctl-description">
 133   <title>Description</title>
 134   <para>
 135    <application>pg_ctl</application> is a utility for initializing a
 136    <productname>PostgreSQL</productname> database cluster, starting,
 137    stopping, or restarting the <productname>PostgreSQL</productname>
 138    database server (<xref linkend="app-postgres">), or displaying the
 139    status of a running server.  Although the server can be started
 140    manually, <application>pg_ctl</application> encapsulates tasks such
 141    as redirecting log output and properly detaching from the terminal
 142    and process group. It also provides convenient options for
 143    controlled shutdown.
 144   </para>
 145
 146   <para>
 147    The <option>init</option> or <option>initdb</option> mode creates a new
 148    <productname>PostgreSQL</productname> database cluster.  A database
 149    cluster is a collection of databases that are managed by a single
 150    server instance.  This mode invokes the <command>initdb</command>
 151    command.  See <xref linkend="app-initdb"> for details.
 152   </para>
 153
 154   <para>
 155    In <option>start</option> mode, a new server is launched.  The
 156    server is started in the background, and its standard input is attached
 157    to <filename>/dev/null</filename> (or <literal>nul</> on Windows).
 158    On Unix-like systems, by default, the server's standard output and
 159    standard error are sent to <application>pg_ctl</application>'s
 160    standard output (not standard error).  The standard output of
 161    <application>pg_ctl</application> should then be redirected to a
 162    file or piped to another process such as a log rotating program
 163    like <application>rotatelogs</>; otherwise <command>postgres</command>
 164    will write its output to the controlling terminal (from the
 165    background) and will not leave the shell's process group.  On
 166    Windows, by default the server's standard output and standard error
 167    are sent to the terminal.  These default behaviors can be changed
 168    by using <option>-l</option> to append the server's output to a log file.
 169    Use of either <option>-l</option> or output redirection is recommended.
 170   </para>
 171
 172   <para>
 173    In <option>stop</option> mode, the server that is running in
 174    the specified data directory is shut down.  Three different
 175    shutdown methods can be selected with the <option>-m</option>
 176    option.  <quote>Smart</quote> mode (the default) waits for all active
 177    clients to disconnect and any online backup to finish.
 178    If the server is in hot standby, recovery and streaming replication
 179    will be terminated once all clients have disconnected.
 180    <quote>Fast</quote> mode does not wait for clients to disconnect and
 181    will terminate an online backup in progress.  All active transactions are
 182    rolled back and clients are forcibly disconnected, then the
 183    server is shut down.  <quote>Immediate</quote> mode will abort
 184    all server processes immediately, without a clean shutdown.
 185    This will lead to a crash-recovery run on the next restart.
 186   </para>
 187
 188   <para>
 189    <option>restart</option> mode effectively executes a stop followed
 190    by a start.  This allows changing the <command>postgres</command>
 191    command-line options.
 192   </para>
 193
 194   <para>
 195    <option>reload</option> mode simply sends the
 196    <command>postgres</command> process a <systemitem>SIGHUP</>
 197    signal, causing it to reread its configuration files
 198    (<filename>postgresql.conf</filename>,
 199    <filename>pg_hba.conf</filename>, etc.).  This allows changing of
 200    configuration-file options that do not require a complete restart
 201    to take effect.
 202   </para>
 203
 204   <para>
 205    <option>status</option> mode checks whether a server is running in
 206    the specified data directory. If it is, the <acronym>PID</acronym>
 207    and the command line options that were used to invoke it are
 208    displayed.  If the server is not running, the process returns an
 209    exit status of 3.
 210   </para>
 211
 212   <para>
 213    In <option>promote</option> mode, the standby server that is
 214    running in the specified data directory is commanded to exit
 215    recovery and begin read-write operations.
 216   </para>
 217
 218   <para>
 219    <option>kill</option> mode allows you to send a signal to a specified
 220     process.  This is particularly valuable for <productname>Microsoft Windows</>
 221     which does not have a <application>kill</> command.  Use
 222     <literal>--help</> to see a list of supported signal names.
 223   </para>
 224
 225   <para>
 226    <option>register</option> mode allows you to register a system service
 227    on <productname>Microsoft Windows</>.  The <option>-S</option> option
 228    allows selection of service start type, either <quote>auto</quote> (start
 229    service automatically on system startup) or <quote>demand</quote> (start
 230    service on demand).
 231   </para>
 232
 233   <para>
 234    <option>unregister</option> mode allows you to unregister a system service
 235    on <productname>Microsoft Windows</>.  This undoes the effects of the
 236    <option>register</option> command.
 237   </para>
 238  </refsect1>
 239
 240  <refsect1 id="app-pg-ctl-options">
 241   <title>Options</title>
 242
 243     <variablelist>
 244
 245      <varlistentry>
 246       <term><option>-c</option></term>
 247       <listitem>
 248        <para>
 249         Attempt to allow server crashes to produce core files, on platforms
 250         where this is possible, by lifting any soft resource limit placed on
 251         core files.
 252         This is useful in debugging or diagnosing problems by allowing a
 253         stack trace to be obtained from a failed server process.
 254        </para>
 255       </listitem>
 256      </varlistentry>
 257
 258      <varlistentry>
 259       <term><option>-D <replaceable class="parameter">datadir</replaceable></option></term>
 260       <listitem>
 261        <para>
 262         Specifies the file system location of the database files.  If
 263         this is omitted, the environment variable
 264         <envar>PGDATA</envar> is used.
 265        </para>
 266       </listitem>
 267      </varlistentry>
 268
 269      <varlistentry>
 270       <term><option>-l <replaceable class="parameter">filename</replaceable></option></term>
 271       <listitem>
 272        <para>
 273         Append the server log output to
 274         <replaceable>filename</replaceable>.  If the file does not
 275         exist, it is created.  The <systemitem>umask</> is set to 077,
 276         so access to the log file is disallowed to other users by default.
 277        </para>
 278       </listitem>
 279      </varlistentry>
 280
 281      <varlistentry>
 282       <term><option>-m <replaceable class="parameter">mode</replaceable></option></term>
 283       <listitem>
 284        <para>
 285         Specifies the shutdown mode.  <replaceable>mode</replaceable>
 286         can be <literal>smart</literal>, <literal>fast</literal>, or
 287         <literal>immediate</literal>, or the first letter of one of
 288         these three.  If this is omitted, <literal>smart</literal> is used.
 289        </para>
 290       </listitem>
 291      </varlistentry>
 292
 293      <varlistentry>
 294       <term><option>-o <replaceable class="parameter">options</replaceable></option></term>
 295       <listitem>
 296        <para>
 297         Specifies options to be passed directly to the
 298         <command>postgres</command> command.
 299        </para>
 300        <para>
 301         The options should usually be surrounded by single or double
 302         quotes to ensure that they are passed through as a group.
 303        </para>
 304       </listitem>
 305      </varlistentry>
 306
 307      <varlistentry>
 308       <term><option>-o <replaceable class="parameter">initdb-options</replaceable></option></term>
 309       <listitem>
 310        <para>
 311         Specifies options to be passed directly to the
 312         <command>initdb</command> command.
 313        </para>
 314        <para>
 315         The options should usually be surrounded by single or double
 316         quotes to ensure that they are passed through as a group.
 317        </para>
 318       </listitem>
 319      </varlistentry>
 320
 321      <varlistentry>
 322       <term><option>-p <replaceable class="parameter">path</replaceable></option></term>
 323       <listitem>
 324        <para>
 325         Specifies the location of the <filename>postgres</filename>
 326         executable.  By default the <filename>postgres</filename> executable is taken from the same
 327         directory as <command>pg_ctl</command>, or failing that, the hard-wired
 328         installation directory.  It is not necessary to use this
 329         option unless you are doing something unusual and get errors
 330         that the <filename>postgres</filename> executable was not found.
 331        </para>
 332
 333        <para>
 334         In <literal>init</literal> mode, this option analogously
 335         specifies the location of the <filename>initdb</filename>
 336         executable.
 337        </para>
 338       </listitem>
 339      </varlistentry>
 340
 341      <varlistentry>
 342       <term><option>-s</option></term>
 343       <listitem>
 344        <para>
 345         Print only errors, no informational messages.
 346        </para>
 347       </listitem>
 348      </varlistentry>
 349
 350      <varlistentry>
 351       <term><option>-t</option></term>
 352       <listitem>
 353        <para>
 354         The maximum number of seconds to wait when waiting for startup or
 355         shutdown to complete.  The default is 60 seconds.
 356        </para>
 357       </listitem>
 358      </varlistentry>
 359
 360      <varlistentry>
 361       <term><option>-w</option></term>
 362       <listitem>
 363        <para>
 364         Wait for the startup or shutdown to complete.
 365         Waiting is the default option for shutdowns, but not startups.
 366         When waiting for startup, <command>pg_ctl</command> repeatedly
 367         attempts to connect to the server.
 368         When waiting for shutdown, <command>pg_ctl</command> waits for
 369         the server to remove its <acronym>PID</acronym> file.
 370         <command>pg_ctl</command> returns an exit code based on the
 371         success of the startup or shutdown.
 372        </para>
 373       </listitem>
 374      </varlistentry>
 375
 376      <varlistentry>
 377       <term><option>-W</option></term>
 378       <listitem>
 379        <para>
 380         Do not wait for startup or shutdown to complete.  This is the
 381         default for start and restart modes.
 382        </para>
 383       </listitem>
 384      </varlistentry>
 385    </variablelist>
 386
 387   <refsect2 id="app-pg-ctl-windows-options">
 388    <title>Options for Windows</title>
 389
 390    <variablelist>
 391     <varlistentry>
 392      <term><option>-N <replaceable class="parameter">servicename</replaceable></option></term>
 393      <listitem>
 394       <para>
 395        Name of the system service to register. The name will be used
 396        as both the service name and the display name.
 397       </para>
 398      </listitem>
 399     </varlistentry>
 400
 401     <varlistentry>
 402      <term><option>-P <replaceable class="parameter">password</replaceable></option></term>
 403      <listitem>
 404       <para>
 405        Password for the user to start the service.
 406       </para>
 407      </listitem>
 408     </varlistentry>
 409
 410     <varlistentry>
 411      <term><option>-S <replaceable class="parameter">start-type</replaceable></option></term>
 412      <listitem>
 413       <para>
 414        Start type of the system service to register.  start-type can
 415        be <literal>auto</literal>, or <literal>demand</literal>, or
 416        the first letter of one of these two. If this is omitted,
 417        <literal>auto</literal> is used.
 418       </para>
 419      </listitem>
 420     </varlistentry>
 421
 422     <varlistentry>
 423      <term><option>-U <replaceable class="parameter">username</replaceable></option></term>
 424      <listitem>
 425       <para>
 426        User name for the user to start the service. For domain users, use the
 427        format <literal>DOMAIN\username</literal>.
 428       </para>
 429      </listitem>
 430     </varlistentry>
 431    </variablelist>
 432   </refsect2>
 433
 434  </refsect1>
 435
 436
 437  <refsect1>
 438   <title>Environment</title>
 439
 440   <variablelist>
 441    <varlistentry>
 442     <term><envar>PGDATA</envar></term>
 443
 444     <listitem>
 445      <para>
 446       Default data directory location.
 447      </para>
 448     </listitem>
 449    </varlistentry>
 450
 451   </variablelist>
 452
 453   <para>
 454    <command>pg_ctl</command>, like most other <productname>PostgreSQL</>
 455    utilities,
 456    also uses the environment variables supported by <application>libpq</>
 457    (see <xref linkend="libpq-envars">).
 458    For additional server variables, see <xref linkend="app-postgres">.
 459   </para>
 460  </refsect1>
 461
 462
 463  <refsect1>
 464   <title>Files</title>
 465
 466   <variablelist>
 467    <varlistentry>
 468     <term><filename>postmaster.pid</filename></term>
 469
 470     <listitem>
 471      <para>
 472       The existence of this file in the data directory is used to help
 473       <application>pg_ctl</application> determine if the server is
 474       currently running.
 475      </para>
 476     </listitem>
 477    </varlistentry>
 478
 479    <varlistentry>
 480     <term><filename>postmaster.opts</filename></term>
 481
 482     <listitem>
 483      <para>If this file exists in the data directory,
 484       <application>pg_ctl</application> (in <option>restart</option> mode)
 485       will pass the contents of the file as options to
 486       <application>postgres</application>, unless overridden
 487       by the <option>-o</option> option. The contents of this file
 488       are also displayed in <option>status</option> mode.
 489      </para>
 490     </listitem>
 491    </varlistentry>
 492
 493   </variablelist>
 494  </refsect1>
 495
 496
 497  <refsect1 id="R1-APP-PGCTL-2">
 498   <title>Examples</title>
 499
 500   <refsect2 id="R2-APP-PGCTL-3">
 501    <title>Starting the Server</title>
 502
 503    <para>
 504     To start the server:
 505 <screen>
 506 <prompt>$</prompt> <userinput>pg_ctl start</userinput>
 507 </screen>
 508    </para>
 509
 510    <para>
 511     To start the server, waiting until the server is
 512     accepting connections:
 513 <screen>
 514 <prompt>$</prompt> <userinput>pg_ctl -w start</userinput>
 515 </screen>
 516    </para>
 517
 518    <para>
 519     To start the server using port 5433, and
 520     running without <function>fsync</function>, use:
 521 <screen>
 522 <prompt>$</prompt> <userinput>pg_ctl -o "-F -p 5433" start</userinput>
 523 </screen></para>
 524   </refsect2>
 525
 526   <refsect2 id="R2-APP-PGCTL-4">
 527    <title>Stopping the Server</title>
 528    <para>
 529     To stop the server, use:
 530 <screen>
 531 <prompt>$</prompt> <userinput>pg_ctl stop</userinput>
 532 </screen>
 533     The <option>-m</option> option allows control over
 534     <emphasis>how</emphasis> the server shuts down:
 535 <screen>
 536 <prompt>$</prompt> <userinput>pg_ctl stop -m fast</userinput>
 537 </screen></para>
 538   </refsect2>
 539
 540   <refsect2 id="R2-APP-PGCTL-5">
 541    <title>Restarting the Server</title>
 542
 543    <para>
 544     Restarting the server is almost equivalent to stopping the
 545     server and starting it again,
 546     except that <command>pg_ctl</command> saves and reuses the command line options that
 547     were passed to the previously running instance.  To restart
 548     the server in the simplest form, use:
 549 <screen>
 550 <prompt>$</prompt> <userinput>pg_ctl restart</userinput>
 551 </screen>
 552    </para>
 553
 554    <para>
 555     To restart the server,
 556     waiting for it to shut down and restart:
 557 <screen>
 558 <prompt>$</prompt> <userinput>pg_ctl -w restart</userinput>
 559 </screen>
 560    </para>
 561
 562    <para>
 563     To restart using port 5433, disabling <function>fsync</> upon restart:
 564 <screen>
 565 <prompt>$</prompt> <userinput>pg_ctl -o "-F -p 5433" restart</userinput>
 566 </screen></para>
 567   </refsect2>
 568
 569   <refsect2 id="R2-APP-PGCTL-6">
 570    <title>Showing the Server Status</title>
 571
 572    <para>
 573     Here is sample status output from
 574     <application>pg_ctl</application>:
 575 <screen>
 576 <prompt>$</prompt> <userinput>pg_ctl status</userinput>
 577 <computeroutput>
 578 pg_ctl: server is running (PID: 13718)
 579 /usr/local/pgsql/bin/postgres "-D" "/usr/local/pgsql/data" "-p" "5433" "-B" "128"
 580 </computeroutput>
 581 </screen>
 582     This is the command line that would be invoked in restart mode.
 583    </para>
 584   </refsect2>
 585  </refsect1>
 586
 587
 588  <refsect1>
 589   <title>See Also</title>
 590
 591   <simplelist type="inline">
 592    <member><xref linkend="app-initdb"></member>
 593    <member><xref linkend="app-postgres"></member>
 594   </simplelist>
 595  </refsect1>
 596
 597 </refentry>