← Back to branch summary

~ubuntu-branches/debian/sid/postgresql-9.3/sid

« back to all changes in this revision

Viewing changes to doc/src/sgml/ref/checkpoint.sgml

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2013-05-08 05:39:52 UTC
  • Revision ID: package-import@ubuntu.com-20130508053952-1j7uilp7mjtrvq8q
Tags: upstream-9.3~beta1
Import upstream version 9.3~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/ref/checkpoint.sgml
 
1
<!-- doc/src/sgml/ref/checkpoint.sgml -->
 
2
 
 
3
<refentry id="sql-checkpoint">
 
4
 <refmeta>
 
5
  <refentrytitle>CHECKPOINT</refentrytitle>
 
6
  <manvolnum>7</manvolnum>
 
7
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 
8
 </refmeta>
 
9
 
 
10
 <refnamediv>
 
11
  <refname>CHECKPOINT</refname>
 
12
  <refpurpose>force a transaction log checkpoint</refpurpose>
 
13
 </refnamediv>
 
14
 
 
15
 <indexterm zone="sql-checkpoint">
 
16
  <primary>CHECKPOINT</primary>
 
17
 </indexterm>
 
18
 
 
19
 <refsynopsisdiv>
 
20
<synopsis>
 
21
CHECKPOINT
 
22
</synopsis>
 
23
 </refsynopsisdiv>
 
24
 
 
25
 <refsect1>
 
26
  <title>Description</title>
 
27
 
 
28
  <para>
 
29
   A checkpoint is a point in the transaction log sequence at which
 
30
   all data files have been updated to reflect the information in the
 
31
   log.  All data files will be flushed to disk.  Refer to
 
32
   <xref linkend="wal-configuration"> for more details about what happens
 
33
   during a checkpoint.
 
34
  </para>
 
35
 
 
36
  <para>
 
37
   The <command>CHECKPOINT</command> command forces an immediate
 
38
   checkpoint when the command is issued, without waiting for a
 
39
   regular checkpoint scheduled by the system (controlled by the settings in
 
40
   <xref linkend="runtime-config-wal-checkpoints">).
 
41
   <command>CHECKPOINT</command> is not intended for use during normal
 
42
   operation.
 
43
  </para>
 
44
 
 
45
  <para>
 
46
   If executed during recovery, the <command>CHECKPOINT</command> command
 
47
   will force a restartpoint (see <xref linkend="wal-configuration">)
 
48
   rather than writing a new checkpoint.
 
49
  </para>
 
50
 
 
51
  <para>
 
52
   Only superusers can call <command>CHECKPOINT</command>.
 
53
  </para>
 
54
 </refsect1>
 
55
 
 
56
 <refsect1>
 
57
  <title>Compatibility</title>
 
58
 
 
59
  <para>
 
60
   The <command>CHECKPOINT</command> command is a
 
61
   <productname>PostgreSQL</productname> language extension.
 
62
  </para>
 
63
 </refsect1>
 
64
</refentry>