timescale / docs

Timescale product documentation 📖
https://docs.timescale.com/
52 stars 99 forks source link

[Docs RFC] Add doc on chunk skipping indexes for CAGGS #3424

Closed billy-the-fish closed 1 month ago

billy-the-fish commented 2 months ago

We got the work on chunk skipping indexes out with 2.16. As a quick reminder:

Improved query performance through chunk exclusion on compressed hypertables. You can now define chunk skipping indexes on compressed chunks for any column with one of the following integer data types: smallint, int, bigint, serial, bigserial, date, timestamp, timestamptz. After you call enable_chunk_skipping on a column, TimescaleDB tracks the min and max values for that column. TimescaleDB uses that information to exclude chunks for queries that filter on that column, and would not find any data in those chunks.

All is great; we have docs (for enabling / disabling) and an extended blog post coming out next week.

But I was thinking that we lack any further info on our docs for this pretty useful feature that users have to manually enable. We only have the API pages, with not much information on the why and how this helps, not to mention that someone would have to know about this to look up those commands on our API section.

So I was wondering where we could add more info about it - maybe condense the blog post somehow (remove intro/outro and all the marketing material) and add it somewhere as a page - not sure if it should be a separate page under "Use Timescale" for example.