diff options
Diffstat (limited to 'doc/src/sgml/func.sgml')
-rw-r--r-- | doc/src/sgml/func.sgml | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 122f034f177..6257563eaad 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -19540,6 +19540,71 @@ postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup()); </sect2> + <sect2 id="functions-admin-checksum"> + <title>Data Checksum Functions</title> + + <para> + The functions shown in <xref linkend="functions-checksums-table" /> can + be used to enable or disable data checksums in a running cluster. + See <xref linkend="checksums" /> for details. + </para> + + <table id="functions-checksums-table"> + <title>Checksum <acronym>SQL</acronym> Functions</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Function</entry> + <entry>Return Type</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <indexterm> + <primary>pg_enable_data_checksums</primary> + </indexterm> + <literal><function>pg_enable_data_checksums(<optional><parameter>cost_delay</parameter> <type>int</type>, <parameter>cost_limit</parameter> <type>int</type></optional>)</function></literal> + </entry> + <entry> + void + </entry> + <entry> + <para> + Initiates data checksums for the cluster. This will switch the data checksums mode + to <literal>in progress</literal> and start a background worker that will process + all data in the database and enable checksums for it. When all data pages have had + checksums enabled, the cluster will automatically switch to checksums + <literal>on</literal>. + </para> + <para> + If <parameter>cost_delay</parameter> and <parameter>cost_limit</parameter> are + specified, the speed of the process is throttled using the same principles as + <link linkend="runtime-config-resource-vacuum-cost">Cost-based Vacuum Delay</link>. + </para> + </entry> + </row> + <row> + <entry> + <indexterm> + <primary>pg_disable_data_checksums</primary> + </indexterm> + <literal><function>pg_disable_data_checksums()</function></literal> + </entry> + <entry> + void + </entry> + <entry> + Disables data checksums for the cluster. + </entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + <sect2 id="functions-admin-dbobject"> <title>Database Object Management Functions</title> |