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

Commit 7d835ff

Browse files
committed
Fix documentation oversights about pageinspect and initialization fork.
The initialization fork was added in 9.1, but has not been taken into consideration in documents of get_raw_page function in pageinspect and storage layout. This commit fixes those oversights. get_raw_page can read not only a table but also an index, etc. So it should be documented that the function can read any relation. This commit also fixes the document of pageinspect that way. Back-patch to 9.1 where those oversights existed. Vik Fearing, review by MauMau
1 parent 680513a commit 7d835ff

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

doc/src/sgml/pageinspect.sgml

+4-3
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,12 @@
2828
<listitem>
2929
<para>
3030
<function>get_raw_page</function> reads the specified block of the named
31-
table and returns a copy as a <type>bytea</> value. This allows a
31+
relation and returns a copy as a <type>bytea</> value. This allows a
3232
single time-consistent copy of the block to be obtained.
3333
<replaceable>fork</replaceable> should be <literal>'main'</literal> for
34-
the main data fork, or <literal>'fsm'</literal> for the free space map,
35-
or <literal>'vm'</literal> for the visibility map.
34+
the main data fork, <literal>'fsm'</literal> for the free space map,
35+
<literal>'vm'</literal> for the visibility map, or <literal>'init'</literal>
36+
for the initialization fork.
3637
</para>
3738
</listitem>
3839
</varlistentry>

doc/src/sgml/storage.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -265,8 +265,8 @@ The <function>pg_relation_filepath()</> function shows the entire path
265265
as a substitute for remembering many of the above rules. But keep in
266266
mind that this function just gives the name of the first segment of the
267267
main fork of the relation &mdash; you may need to append a segment number
268-
and/or <literal>_fsm</> or <literal>_vm</> to find all the files associated
269-
with the relation.
268+
and/or <literal>_fsm</>, <literal>_vm</>, or <literal>_init</> to find all
269+
the files associated with the relation.
270270
</para>
271271

272272
<para>

0 commit comments

Comments
 (0)