1
0
mirror of https://github.com/postgres/postgres.git synced 2025-05-29 16:21:20 +03:00
postgres/doc/src/sgml/ref/checkpoint.sgml
Peter Eisentraut 3c49c6facb Convert documentation to DocBook XML
Since some preparation work had already been done, the only source
changes left were changing empty-element tags like <xref linkend="foo">
to <xref linkend="foo"/>, and changing the DOCTYPE.

The source files are still named *.sgml, but they are actually XML files
now.  Renaming could be considered later.

In the build system, the intermediate step to convert from SGML to XML
is removed.  Everything is build straight from the source files again.
The OpenSP (or the old SP) package is no longer needed.

The documentation toolchain instructions are updated and are much
simpler now.

Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
2017-11-23 09:44:28 -05:00

65 lines
1.7 KiB
Plaintext

<!-- doc/src/sgml/ref/checkpoint.sgml -->
<refentry id="sql-checkpoint">
<indexterm zone="sql-checkpoint">
<primary>CHECKPOINT</primary>
</indexterm>
<refmeta>
<refentrytitle>CHECKPOINT</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
<refnamediv>
<refname>CHECKPOINT</refname>
<refpurpose>force a write-ahead log checkpoint</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
CHECKPOINT
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
A checkpoint is a point in the write-ahead log sequence at which
all data files have been updated to reflect the information in the
log. All data files will be flushed to disk. Refer to
<xref linkend="wal-configuration"/> for more details about what happens
during a checkpoint.
</para>
<para>
The <command>CHECKPOINT</command> command forces an immediate
checkpoint when the command is issued, without waiting for a
regular checkpoint scheduled by the system (controlled by the settings in
<xref linkend="runtime-config-wal-checkpoints"/>).
<command>CHECKPOINT</command> is not intended for use during normal
operation.
</para>
<para>
If executed during recovery, the <command>CHECKPOINT</command> command
will force a restartpoint (see <xref linkend="wal-configuration"/>)
rather than writing a new checkpoint.
</para>
<para>
Only superusers can call <command>CHECKPOINT</command>.
</para>
</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
The <command>CHECKPOINT</command> command is a
<productname>PostgreSQL</productname> language extension.
</para>
</refsect1>
</refentry>