From: Andrew Dunstan <andrew@dunslane.net>
Date: Tue, 27 Dec 2016 16:23:46 +0000 (-0500)
Subject: Explain unaccounted for space in pgstattuple.
X-Git-Tag: REL9_2_20~33
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=3ba8beda0004742ead13eeeb7d9d17c226746326;p=thirdparty%2Fpostgresql.git

Explain unaccounted for space in pgstattuple.

In addition to space accounted for by tuple_len, dead_tuple_len and
free_space, the table_len includes page overhead, the item pointers
table and padding bytes.

Backpatch to live branches.
---

diff --git a/doc/src/sgml/pgstattuple.sgml b/doc/src/sgml/pgstattuple.sgml
index 7f1ae8d3048..acd21853967 100644
--- a/doc/src/sgml/pgstattuple.sgml
+++ b/doc/src/sgml/pgstattuple.sgml
@@ -106,6 +106,16 @@ free_percent       | 1.95
      </tgroup>
     </table>
 
+    <note>
+      <para>
+        The <literal>table_len</literal> will always be greater than the sum
+        of the <literal>tuple_len</literal>, <literal>dead_tuple_len</literal>
+        and <literal>free_space</literal>. The difference is accounted for by
+        fixed page overhead, the per-page table of pointers to tuples, and
+        padding to ensure that tuples are correctly aligned. 
+      </para>
+    </note>
+
     <para>
      <function>pgstattuple</function> acquires only a read lock on the
      relation. So the results do not reflect an instantaneous snapshot;