PostgreSQL

+
The output columns are described in link:pgstattuple.html#PGSTATTUPLE-COLUMNS[Table F.22].
+
[[PGSTATTUPLE-COLUMNS]]
*Table F.22. `+pgstattuple+` Output Columns*

[cols=",,",options="header",]
|===
|Column |Type |Description
|`+table_len+` |`+bigint+` |Physical relation length in bytes
|`+tuple_count+` |`+bigint+` |Number of live tuples
|`+tuple_len+` |`+bigint+` |Total length of live tuples in bytes
|`+tuple_percent+` |`+float8+` |Percentage of live tuples
|`+dead_tuple_count+` |`+bigint+` |Number of dead tuples
|`+dead_tuple_len+` |`+bigint+` |Total length of dead tuples in bytes
|`+dead_tuple_percent+` |`+float8+` |Percentage of dead tuples
|`+free_space+` |`+bigint+` |Total free space in bytes
|`+free_percent+` |`+float8+` |Percentage of free space
|===
+
 +
+
[NOTE]
====
==== Note

  The `+table_len+` will always be greater than the sum of the `+tuple_len+`, `+dead_tuple_len+` and `+free_space+`. 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.
  ====
  +
  `+pgstattuple+` acquires only a read lock on the relation. So the results do not reflect an instantaneous snapshot; concurrent updates will affect them.
  +
  `+pgstattuple+` judges a tuple is [.quote]#“[.quote]#dead#”# if `+HeapTupleSatisfiesDirty+` returns false.
[.term]#`+pgstattuple(text) returns record+`#::
  This is the same as `+pgstattuple(regclass)+`, except that the target relation is specified as TEXT. This function is kept because of backward-compatibility so far, and will be deprecated in some future release.
[.term]# `+pgstatindex(regclass) returns record+`#::
  `+pgstatindex+` returns a record showing information about a B-tree index. For example:
  +

  +
  The output columns are:
  +
  [cols=",,",options="header",]
  |===
  |Column |Type |Description
  |`+version+` |`+integer+` |B-tree version number
  |`+tree_level+` |`+integer+` |Tree level of the root page
  |`+index_size+` |`+bigint+` |Total index size in bytes
  |`+root_block_no+` |`+bigint+` |Location of root page (zero if none)
  |`+internal_pages+` |`+bigint+` |Number of [.quote]#“[.quote]#internal#”# (upper-level) pages
  |`+leaf_pages+` |`+bigint+` |Number of leaf pages
  |`+empty_pages+` |`+bigint+` |Number of empty pages
  |`+deleted_pages+` |`+bigint+` |Number of deleted pages
  |`+avg_leaf_density+` |`+float8+` |Average density of leaf pages
  |`+leaf_fragmentation+` |`+float8+` |Leaf page fragmentation
  |===
  +
  The reported `+index_size+` will normally correspond to one more page than is accounted for by `+internal_pages + leaf_pages + empty_pages + deleted_pages+`, because it also includes the index's metapage.
  +
  As with `+pgstattuple+`, the results are accumulated page-by-page, and should not be expected to represent an instantaneous snapshot of the whole index.
[.term]#`+pgstatindex(text) returns record+`#::
  This is the same as `+pgstatindex(regclass)+`, except that the target index is specified as TEXT. This function is kept because of backward-compatibility so far, and will be deprecated in some future release.
[.term]# `+pgstatginindex(regclass) returns record+`#::
  `+pgstatginindex+` returns a record showing information about a GIN index. For example:
  +

  +
  The output columns are:
  +
  [cols=",,",options="header",]
  |===
  |Column |Type |Description
  |`+version+` |`+integer+` |GIN version number
  |`+pending_pages+` |`+integer+` |Number of pages in the pending list
  |`+pending_tuples+` |`+bigint+` |Number of tuples in the pending list
  |===
[.term]# `+pgstathashindex(regclass) returns record+`#::
  `+pgstathashindex+` returns a record showing information about a HASH index. For example:
  +

  +
  The output columns are:
  +
  [cols=",,",options="header",]
  |===
  |Column |Type |Description
  |`+version+` |`+integer+` |HASH version number
  |`+bucket_pages+` |`+bigint+` |Number of bucket pages
  |`+overflow_pages+` |`+bigint+` |Number of overflow pages
  |`+bitmap_pages+` |`+bigint+` |Number of bitmap pages
  |`+unused_pages+` |`+bigint+` |Number of unused pages
  |`+live_items+` |`+bigint+` |Number of live tuples
  |`+dead_tuples+` |`+bigint+` |Number of dead tuples
  |`+free_percent+` |`+float+` |Percentage of free space
  |===
[.term]# `+pg_relpages(regclass) returns bigint+`#::
  `+pg_relpages+` returns the number of pages in the relation.
[.term]#`+pg_relpages(text) returns bigint+`#::
  This is the same as `+pg_relpages(regclass)+`, except that the target relation is specified as TEXT. This function is kept because of backward-compatibility so far, and will be deprecated in some future release.
[.term]# `+pgstattuple_approx(regclass) returns record+`#::
  `+pgstattuple_approx+` is a faster alternative to `+pgstattuple+` that returns approximate results. The argument is the target relation's name or OID. For example:
  +

+
The output columns are described in link:pgstattuple.html#PGSTATAPPROX-COLUMNS[Table F.23].
+
Whereas `+pgstattuple+` always performs a full-table scan and returns an exact count of live and dead tuples (and their sizes) and free space, `+pgstattuple_approx+` tries to avoid the full-table scan and returns exact dead tuple statistics along with an approximation of the number and size of live tuples and free space.
+
It does this by skipping pages that have only visible tuples according to the visibility map (if a page has the corresponding VM bit set, then it is assumed to contain no dead tuples). For such pages, it derives the free space value from the free space map, and assumes that the rest of the space on the page is taken up by live tuples.
+
For pages that cannot be skipped, it scans each tuple, recording its presence and size in the appropriate counters, and adding up the free space on the page. At the end, it estimates the total number of live tuples based on the number of pages and tuples scanned (in the same way that VACUUM estimates pg_class.reltuples).
+
[[PGSTATAPPROX-COLUMNS]]
*Table F.23. `+pgstattuple_approx+` Output Columns*

[cols=",,",options="header",]
|===
|Column |Type |Description
|`+table_len+` |`+bigint+` |Physical relation length in bytes (exact)
|`+scanned_percent+` |`+float8+` |Percentage of table scanned
|`+approx_tuple_count+` |`+bigint+` |Number of live tuples (estimated)
|`+approx_tuple_len+` |`+bigint+` |Total length of live tuples in bytes (estimated)
|`+approx_tuple_percent+` |`+float8+` |Percentage of live tuples
|`+dead_tuple_count+` |`+bigint+` |Number of dead tuples (exact)
|`+dead_tuple_len+` |`+bigint+` |Total length of dead tuples in bytes (exact)
|`+dead_tuple_percent+` |`+float8+` |Percentage of dead tuples
|`+approx_free_space+` |`+bigint+` |Total free space in bytes (estimated)
|`+approx_free_percent+` |`+float8+` |Percentage of free space
|===
+
 +
+
In the above output, the free space figures may not match the `+pgstattuple+` output exactly, because the free space map gives us an exact figure, but is not guaranteed to be accurate to the byte.