Timescaledb: Incorrect documentation for `timescaledb_information.hypertable`

Created on 15 Nov 2019  ·  5Comments  ·  Source: timescale/timescaledb

The documentation for timescaledb_information.hypertable says that it returns …bytes columns, but it actually returns pretty-printed sizes such as “99 MB” on TimescaleDB 1.4. (This is also what the sample under the list of columns shows.)

I would actually like to get the values in bytes, but this doesn't seem to be available…

bug documentation

All 5 comments

This seems to be fixed in the 1.5 version of the docs: https://docs.timescale.com/latest/api#utilities

W.r.t. getting values in bytes, you can use the hypertable_relation_size() function to get the raw bytes.

@erimatnor I might be misunderstanding something here, but it doesn't seem to be fixed. These columns are still in the docs, but they aren't returned from timescaledb_information.hypertable in 1.5 – including in the example below the table:

TimescaleDB Docs  API reference utilities

hypertable_relation_size() does work for this, but it requires first listing the tables, and then querying per table. Not saying this is a problem, but there would be a (small) benefit in having this information in the information one gets from timescaledb_information.hypertable from the perspective of a service monitoring TimescaleDB tables in a database.

@ehamberg Yes, my bad. Thought I looked closely, but must have missed anyway.

Looks like this was fixed in https://github.com/timescale/docs.timescale.com-content/pull/270/files. Will be in the next release of the docs.

Closing this issue since docs for 1.6 was released with the fix.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

sezaru picture sezaru  ·  5Comments

ziXet picture ziXet  ·  5Comments

tkurki picture tkurki  ·  3Comments

vanwalj picture vanwalj  ·  5Comments

ya-jeks picture ya-jeks  ·  3Comments