hypertable_detailed_size()

Get detailed information about disk space used by a hypertable

Since 0.2.0

Get detailed information about disk space used by a or , returning size information for the table itself, any indexes on the table, any toast tables, and the total size of all. All sizes are reported in bytes. If the function is executed on a distributed , it returns size information as a separate row per node, including the access node.

When a name is provided, the function transparently looks up the backing and returns its statistics instead.

For more information about using s, including size partitioning, see the hypertable section.

Samples

Get the size information for a .

-- disttable is a distributed {HYPERTABLE} --
SELECT * FROM hypertable_detailed_size('disttable') ORDER BY node_name;

 table_bytes | index_bytes | toast_bytes | total_bytes |  node_name
-------------+-------------+-------------+-------------+-------------
       16384 |       40960 |           0 |       57344 | data_node_1
        8192 |       24576 |           0 |       32768 | data_node_2
           0 |        8192 |           0 |        8192 |

The access node is listed without a user-given node name. Normally, the access node holds no data, but still maintains, for example, index information that occupies a small amount of disk space.

Arguments

The syntax is:

SELECT * from hypertable_detailed_size('<hypertable_name>');

Name	Type	Default	Required	Description
hypertable	REGCLASS	-	✔	Hypertable or continuous aggregate to show detailed size of.

Returns

Column	Type	Description
table_bytes	BIGINT	Disk space used by main_table (like pg_relation_size(main_table))
index_bytes	BIGINT	Disk space used by indexes
toast_bytes	BIGINT	Disk space of toast tables
total_bytes	BIGINT	Total disk space used by the specified table, including all indexes and TOAST data
node_name	TEXT	For distributed s, this is the user-given name of the node for which the size is reported. NULL is returned for the access node and non-distributed s.

If executed on a relation that is not a , the function returns NULL.