From 3fa0c78632210592d566daaeece25f3743c58233 Mon Sep 17 00:00:00 2001 From: Tom Lane Date: Wed, 23 Jul 2014 15:20:45 -0400 Subject: [PATCH] Rearrange documentation paragraph describing pg_relation_size(). Break the list of available options into an 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. --- doc/src/sgml/func.sgml | 40 ++++++++++++++++++++++++++++------------ 1 file changed, 28 insertions(+), 12 deletions(-) diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 68117a7114..f1ae736ef3 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -14494,18 +14494,34 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); - pg_relation_size accepts the OID or name of a table, index or - toast table, and returns the on-disk size in bytes. Specifying - 'main' or leaving out the second argument returns the - size of the main data fork of the relation. Specifying - 'fsm' returns the size of the - Free Space Map (see ) associated with the - relation. Specifying 'vm' returns the size of the - Visibility Map (see ) associated with the - relation. Note that this function shows the size of only one fork; - for most purposes it is more convenient to use the higher-level - functions pg_total_relation_size or - pg_table_size. + pg_relation_size accepts the OID or name of a table, index + or toast table, and returns the on-disk size in bytes of one fork of + that relation. (Note that for most purposes it is more convenient to + use the higher-level functions pg_total_relation_size + or pg_table_size, which sum the sizes of all forks.) + With one argument, it returns the size of the main data fork of the + relation. The second argument can be provided to specify which fork + to examine: + + + + 'main' returns the size of the main + data fork of the relation. + + + + + 'fsm' returns the size of the Free Space Map + (see ) associated with the relation. + + + + + 'vm' returns the size of the Visibility Map + (see ) associated with the relation. + + + -- 2.40.0