Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit b787d4c

Browse files
committed
Doc: clean up pg_relation_check_pages() documentation.
Commit f2b8839 did not get the memo about the new formatting style for tables documenting built-in functions. I noticed because of a PDF build warning about an overwidth table.
1 parent 4c49d8f commit b787d4c

File tree

1 file changed

+33
-27
lines changed

1 file changed

+33
-27
lines changed

doc/src/sgml/func.sgml

+33-27
Original file line numberDiff line numberDiff line change
@@ -26192,44 +26192,50 @@ SELECT convert_from(pg_read_binary_file('file_in_utf8.txt'), 'UTF8');
2619226192

2619326193
<table id="functions-data-sanity-table">
2619426194
<title>Data Sanity Functions</title>
26195-
<tgroup cols="3">
26195+
<tgroup cols="1">
2619626196
<thead>
26197-
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
26197+
<row>
26198+
<entry role="func_table_entry"><para role="func_signature">
26199+
Function
26200+
</para>
26201+
<para>
26202+
Description
26203+
</para></entry>
2619826204
</row>
2619926205
</thead>
2620026206

2620126207
<tbody>
2620226208
<row>
26203-
<entry>
26204-
<literal><function>pg_relation_check_pages(<parameter>relation</parameter> <type>regclass</type> [, <parameter>fork</parameter> <type>text</type> <literal>DEFAULT</literal> <literal>NULL</literal> ])</function></literal>
26205-
</entry>
26206-
<entry><type>setof record</type></entry>
26207-
<entry>Check the pages of a relation.
26208-
</entry>
26209+
<entry role="func_table_entry"><para role="func_signature">
26210+
<indexterm>
26211+
<primary>pg_relation_check_pages</primary>
26212+
</indexterm>
26213+
<function>pg_relation_check_pages</function> ( <parameter>relation</parameter> <type>regclass</type> [, <parameter>fork</parameter> <type>text</type> ] )
26214+
<returnvalue>setof record</returnvalue>
26215+
( <parameter>path</parameter> <type>text</type>,
26216+
<parameter>failed_block_num</parameter> <type>bigint</type> )
26217+
</para>
26218+
<para>
26219+
Checks the pages of the specified relation to see if they are valid
26220+
enough to safely be loaded into the server's shared buffers. If
26221+
given, <parameter>fork</parameter> specifies that only the pages of
26222+
the given fork are to be verified. <parameter>fork</parameter> can
26223+
be <literal>main</literal> for the main data
26224+
fork, <literal>fsm</literal> for the free space
26225+
map, <literal>vm</literal> for the visibility map,
26226+
or <literal>init</literal> for the initialization fork. The
26227+
default of <literal>NULL</literal> means that all forks of the
26228+
relation should be checked. The function returns a list of block
26229+
numbers that appear corrupted along with the path names of their
26230+
files. Use of this function is restricted to superusers by
26231+
default, but access may be granted to others
26232+
using <command>GRANT</command>.
26233+
</para></entry>
2620926234
</row>
2621026235
</tbody>
2621126236
</tgroup>
2621226237
</table>
2621326238

26214-
<indexterm>
26215-
<primary>pg_relation_check_pages</primary>
26216-
</indexterm>
26217-
<para id="functions-check-relation-note" xreflabel="pg_relation_check_pages">
26218-
<function>pg_relation_check_pages</function> iterates over all blocks of a
26219-
given relation and verifies if they are in a state where they can safely
26220-
be loaded into the shared buffers. If defined,
26221-
<replaceable>fork</replaceable> specifies that only the pages of the given
26222-
fork are to be verified. Fork can be <literal>'main'</literal> for the
26223-
main data fork, <literal>'fsm'</literal> for the free space map,
26224-
<literal>'vm'</literal> for the visibility map, or
26225-
<literal>'init'</literal> for the initialization fork. The default of
26226-
<literal>NULL</literal> means that all the forks of the relation are
26227-
checked. The function returns a list of blocks that are considered as
26228-
corrupted with the path of the related file. Use of this function is
26229-
restricted to superusers by default but access may be granted to others
26230-
using <command>GRANT</command>.
26231-
</para>
26232-
2623326239
</sect2>
2623426240

2623526241
</sect1>

0 commit comments

Comments
 (0)