Commit 4fd9e6ff authored by Tom Lane's avatar Tom Lane

Rearrange documentation paragraph describing pg_relation_size().

Break the list of available options into an <itemizedlist> instead of
inline sentences.  This is mostly motivated by wanting to ensure that the
cross-references to the FSM and VM docs don't cross page boundaries in PDF
format; but it seems to me to read more easily this way anyway.  I took the
liberty of editorializing a bit further while at it.

Per complaint from Magnus about 9.0.18 docs not building in A4 format.
Patch all active branches so we don't get blind-sided by this particular
issue again in future.
parent 0ea1f2a3
...@@ -16928,20 +16928,40 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); ...@@ -16928,20 +16928,40 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
</para> </para>
<para> <para>
<function>pg_relation_size</> accepts the OID or name of a table, index or <function>pg_relation_size</> accepts the OID or name of a table, index
toast table, and returns the on-disk size in bytes. or toast table, and returns the on-disk size in bytes of one fork of
Specifying <literal>'main'</literal> or leaving out the second argument that relation. (Note that for most purposes it is more convenient to
returns the size of the main data fork of the relation. use the higher-level functions <function>pg_total_relation_size</>
Specifying <literal>'fsm'</literal> returns the size of the Free Space or <function>pg_table_size</>, which sum the sizes of all forks.)
Map (see <xref linkend="storage-fsm">) associated with the relation. With one argument, it returns the size of the main data fork of the
Specifying <literal>'vm'</literal> returns the size of the Visibility relation. The second argument can be provided to specify which fork
Map (see <xref linkend="storage-vm">) associated with the relation. to examine:
Specifying <literal>'init'</literal> returns the size of the <itemizedlist spacing="compact">
initialization fork, if any, associated with the relation. <listitem>
Note that this function shows the size of only one fork; <para>
for most purposes it is more convenient to use the higher-level <literal>'main'</literal> returns the size of the main
functions <function>pg_total_relation_size</> or data fork of the relation.
<function>pg_table_size</>. </para>
</listitem>
<listitem>
<para>
<literal>'fsm'</literal> returns the size of the Free Space Map
(see <xref linkend="storage-fsm">) associated with the relation.
</para>
</listitem>
<listitem>
<para>
<literal>'vm'</literal> returns the size of the Visibility Map
(see <xref linkend="storage-vm">) associated with the relation.
</para>
</listitem>
<listitem>
<para>
<literal>'init'</literal> returns the size of the initialization
fork, if any, associated with the relation.
</para>
</listitem>
</itemizedlist>
</para> </para>
<para> <para>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment