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

   1 <!-- $PostgreSQL: pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.13 2005/01/04 00:39:53 tgl Exp $ -->
   2
   3 <refentry id="sql-checkpoint">
   4  <refmeta>
   5   <refentrytitle id="sql-checkpoint-title">CHECKPOINT</refentrytitle>
   6   <refmiscinfo>SQL - Language Statements</refmiscinfo>
   7  </refmeta>
   8
   9  <refnamediv>
  10   <refname>CHECKPOINT</refname>
  11   <refpurpose>force a transaction log checkpoint</refpurpose>
  12  </refnamediv>
  13
  14  <indexterm zone="sql-checkpoint">
  15   <primary>CHECKPOINT</primary>
  16  </indexterm>
  17
  18  <refsynopsisdiv>
  19 <synopsis>
  20 CHECKPOINT
  21 </synopsis>
  22  </refsynopsisdiv>
  23
  24  <refsect1>
  25   <title>Description</title>
  26
  27   <para>
  28    Write-Ahead Logging (WAL) puts a checkpoint in the transaction log
  29    every so often. (To adjust the automatic checkpoint interval, see
  30    the run-time configuration options <xref linkend="guc-checkpoint-segments">
  31    and <xref linkend="guc-checkpoint-timeout">.)  The
  32    <command>CHECKPOINT</command> command forces an immediate
  33    checkpoint when the command is issued, without waiting for a
  34    scheduled checkpoint.
  35   </para>
  36
  37   <para>
  38    A checkpoint is a point in the transaction log sequence at which
  39    all data files have been updated to reflect the information in the
  40    log.  All data files will be flushed to disk.  Refer to
  41    <xref linkend="wal"> for more information about the WAL system.
  42   </para>
  43
  44   <para>
  45    Only superusers may call <command>CHECKPOINT</command>.  The command is
  46    not intended for use during normal operation.
  47   </para>
  48  </refsect1>
  49
  50  <refsect1>
  51   <title>Compatibility</title>
  52
  53   <para>
  54    The <command>CHECKPOINT</command> command is a
  55    <productname>PostgreSQL</productname> language extension.
  56   </para>
  57  </refsect1>
  58 </refentry>
  59
  60 <!-- Keep this comment at the end of the file
  61 Local variables:
  62 mode: sgml
  63 sgml-omittag:nil
  64 sgml-shorttag:t
  65 sgml-minimize-attributes:nil
  66 sgml-always-quote-attributes:t
  67 sgml-indent-step:1
  68 sgml-indent-data:t
  69 sgml-parent-document:nil
  70 sgml-default-dtd-file:"../reference.ced"
  71 sgml-exposed-tags:nil
  72 sgml-local-catalogs:"/usr/lib/sgml/catalog"
  73 sgml-local-ecat-files:nil
  74 End:
  75 -->