Document incremental refresh_continuous_aggregate() options (2.28.0) - #315
Conversation
TimescaleDB 2.28.0 (timescale/timescaledb#9903) adds incremental, batched manual refreshes via the options JSONB argument (buckets_per_batch, max_batches_per_execution, refresh_newest_first) and makes batching the default (buckets_per_batch=10). - Document the option keys, defaults, and the new default behavior. - Replace the manual DO-loop incremental sample, now superseded by native batching, with a native incremental example. - Drop the stale process_hypertable_invalidations option, removed from the engine in 2.27.0 (#9596) and now silently ignored.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
| @@ -46,26 +46,18 @@ Refresh the {C.CAGG} `conditions` between `2020-01-01` and | |||
| CALL refresh_continuous_aggregate('conditions', '2020-01-01', '2020-02-01'); | |||
There was a problem hiding this comment.
This is also an incremental refresh as buckets_per_batch is 10 by default. It may be better to state that to prevent confusion.
There was a problem hiding this comment.
We can also show how to disable the incremental refresh instead
CALL refresh_continuous_aggregate('conditions', '2020-01-01', '2020-02-01', options => '{"buckets_per_batch": 0}'::jsonb);
There was a problem hiding this comment.
I suggest keeping both versions. I think we should keep this version so that it is clear that no changes are needed to existing calls.
i.e. keep
call refresh_continuous_aggregate('conditions', '2020-01-01', '2020-02-01');
Perhaps state that this uses default settings (as shown in the table).
and add a blurb that if num_buckets=0, then the refresh is not split into batches.
- Note the bare call uses defaults (incremental batches of 10 since 2.28.0) - Add a sample showing buckets_per_batch=0 to disable batching - Drop the inaccurate 'single-transaction' wording
f97d237
into
atovpeko1/edu-136-timescale-db-228-release
Describe your changes
Documents the incremental, batched manual refresh added in TimescaleDB 2.28.0 (timescale/timescaledb#9903), on the
refresh_continuous_aggregate()reference page.optionsJSONB keysbuckets_per_batch,max_batches_per_execution, andrefresh_newest_first, with defaults, in a new Options section.buckets_per_batchis10), matching refresh policies, and explains how to restore single-transaction behavior (buckets_per_batchset to0).DO-loop incremental sample, now superseded by native batching, with a native incremental example.process_hypertable_invalidationsoption, which was removed from the engine in 2.27.0 (Remove dead process_hypertable_invalidations policy code timescaledb#9596) and is now silently ignored.Affected pages
Related Issues
Issue: https://linear.app/tigerdata/issue/EDU-136
Checklist before requesting a review