1
0
mirror of https://github.com/postgres/postgres.git synced 2025-12-21 05:21:08 +03:00
Files
postgres/doc/src/sgml/ref/checkpoint.sgml
Neil Conway 80ec228389 Refer to GUC variables using <xref> tags rather than <varname> tags,
where appropriate. Add "id" and "xreflabel" tags to the descriptions
of the GUC variables to facilitate this. Also make a few minor docs
cleanups.
2004-03-09 16:57:47 +00:00

76 lines
2.0 KiB
Plaintext

<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.12 2004/03/09 16:57:47 neilc Exp $ -->
<refentry id="sql-checkpoint">
<refmeta>
<refentrytitle id="sql-checkpoint-title">CHECKPOINT</refentrytitle>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
<refnamediv>
<refname>CHECKPOINT</refname>
<refpurpose>force a transaction log checkpoint</refpurpose>
</refnamediv>
<indexterm zone="sql-checkpoint">
<primary>CHECKPOINT</primary>
</indexterm>
<refsynopsisdiv>
<synopsis>
CHECKPOINT
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Write-Ahead Logging (WAL) puts a checkpoint in the transaction log
every so often. (To adjust the automatic checkpoint interval, see
the run-time configuration options <xref linkend="guc-checkpoint-segments">
and <xref linkend="guc-checkpoint-timeout">.) The
<command>CHECKPOINT</command> command forces an immediate
checkpoint when the command is issued, without waiting for a
scheduled checkpoint.
</para>
<para>
A checkpoint is a point in the transaction 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 the
<xref linkend="wal"> for more information about the WAL system.
</para>
<para>
Only superusers may call <command>CHECKPOINT</command>. The command is
not intended for use during normal operation.
</para>
</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
The <command>CHECKPOINT</command> command is a
<productname>PostgreSQL</productname> language extension.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->