diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/pgstattuple.sgml | 27 |
1 files changed, 17 insertions, 10 deletions
diff --git a/doc/src/sgml/pgstattuple.sgml b/doc/src/sgml/pgstattuple.sgml index 9cabd71166e..153330edee1 100644 --- a/doc/src/sgml/pgstattuple.sgml +++ b/doc/src/sgml/pgstattuple.sgml @@ -130,9 +130,9 @@ free_percent | 1.95 <listitem> <para> This is the same as <function>pgstattuple(regclass)</function>, except - that the target relation is specified by TEXT. This function is kept + that the target relation is specified as TEXT. This function is kept because of backward-compatibility so far, and will be deprecated in - the future release. + some future release. </para> </listitem> </varlistentry> @@ -154,13 +154,13 @@ test=> SELECT * FROM pgstatindex('pg_cast_oid_index'); -[ RECORD 1 ]------+------ version | 2 tree_level | 0 -index_size | 8192 +index_size | 16384 root_block_no | 1 internal_pages | 0 leaf_pages | 1 empty_pages | 0 deleted_pages | 0 -avg_leaf_density | 50.27 +avg_leaf_density | 54.27 leaf_fragmentation | 0 </programlisting> </para> @@ -194,13 +194,13 @@ leaf_fragmentation | 0 <row> <entry><structfield>index_size</structfield></entry> <entry><type>bigint</type></entry> - <entry>Total number of pages in index</entry> + <entry>Total index size in bytes</entry> </row> <row> <entry><structfield>root_block_no</structfield></entry> <entry><type>bigint</type></entry> - <entry>Location of root block</entry> + <entry>Location of root page (zero if none)</entry> </row> <row> @@ -245,6 +245,13 @@ leaf_fragmentation | 0 </para> <para> + The reported <literal>index_size</> will normally correspond to one more + page than is accounted for by <literal>internal_pages + leaf_pages + + empty_pages + deleted_pages</literal>, because it also includes the + index's metapage. + </para> + + <para> As with <function>pgstattuple</>, the results are accumulated page-by-page, and should not be expected to represent an instantaneous snapshot of the whole index. @@ -260,9 +267,9 @@ leaf_fragmentation | 0 <listitem> <para> This is the same as <function>pgstatindex(regclass)</function>, except - that the target index is specified by TEXT. This function is kept + that the target index is specified as TEXT. This function is kept because of backward-compatibility so far, and will be deprecated in - the future release. + some future release. </para> </listitem> </varlistentry> @@ -351,9 +358,9 @@ pending_tuples | 0 <listitem> <para> This is the same as <function>pg_relpages(regclass)</function>, except - that the target relation is specified by TEXT. This function is kept + that the target relation is specified as TEXT. This function is kept because of backward-compatibility so far, and will be deprecated in - the future release. + some future release. </para> </listitem> </varlistentry> |