diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 12:19:15 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 12:19:15 +0000 |
| commit | 6eb9c5a5657d1fe77b55cc261450f3538d35a94d (patch) | |
| tree | 657d8194422a5daccecfd42d654b8a245ef7b4c8 /doc/src/sgml/ref/checkpoint.sgml | |
| parent | Initial commit. (diff) | |
| download | postgresql-13-upstream.tar.xz postgresql-13-upstream.zip | |
Adding upstream version 13.4.upstream/13.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/src/sgml/ref/checkpoint.sgml')
| -rw-r--r-- | doc/src/sgml/ref/checkpoint.sgml | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/checkpoint.sgml b/doc/src/sgml/ref/checkpoint.sgml new file mode 100644 index 0000000..2afee6d --- /dev/null +++ b/doc/src/sgml/ref/checkpoint.sgml @@ -0,0 +1,67 @@ +<!-- +doc/src/sgml/ref/checkpoint.sgml +PostgreSQL documentation +--> + +<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> |