begriffs open source - ai-pg/blob - full-docs/man7/CHECKPOINT.7

   1 '\" t
   2 .\"     Title: CHECKPOINT
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "CHECKPOINT" "7" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 CHECKPOINT \- force a write\-ahead log checkpoint
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 CHECKPOINT
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 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
  40 Section\ \&28.5
  41 for more details about what happens during a checkpoint\&.
  42 .PP
  43 The
  44 \fBCHECKPOINT\fR
  45 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
  46 Section\ \&19.5.2)\&.
  47 \fBCHECKPOINT\fR
  48 is not intended for use during normal operation\&.
  49 .PP
  50 If executed during recovery, the
  51 \fBCHECKPOINT\fR
  52 command will force a restartpoint (see
  53 Section\ \&28.5) rather than writing a new checkpoint\&.
  54 .PP
  55 Only superusers or users with the privileges of the
  56 pg_checkpoint
  57 role can call
  58 \fBCHECKPOINT\fR\&.
  59 .SH "COMPATIBILITY"
  60 .PP
  61 The
  62 \fBCHECKPOINT\fR
  63 command is a
  64 PostgreSQL
  65 language extension\&.