diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index bf131403b0..19c2d6cab6 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -16928,20 +16928,40 @@ 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. - Specifying 'init' returns the size of the - initialization fork, if any, 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. + + + + + 'init' returns the size of the initialization + fork, if any, associated with the relation. + + +