Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refresh CAGG policy clarification #3776

Merged
merged 3 commits into from
Feb 7, 2025
Merged

Refresh CAGG policy clarification #3776

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c1b9fd
update
atovpeko Jan 29, 2025
6839e5d
Merge branch 'latest' into 3754-content-bug-site-bug-issue-with-the-p…
atovpeko Feb 5, 2025
248c0bb
Merge branch 'latest' into 3754-content-bug-site-bug-issue-with-the-p…
atovpeko Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions use-timescale/continuous-aggregates/refresh-policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ aggregate and the hypertable stay in sync, even when data is removed from the
hypertable, or you could keep source data in the continuous aggregate even after
it is removed from the hypertable.

You can change the way your continuous aggregate is refreshed by adjusting the
[add_continuous_aggregate_policy][api-add-continuous-aggregate-policy].
The policy takes three arguments:
You can change the way your continuous aggregate is refreshed by calling
`add_continuous_aggregate_policy`.

Among others, `add_continuous_aggregate_policy` takes the following arguments:

* `start_offset`: the start of the refresh window relative to when the policy
runs
Expand All @@ -40,6 +41,9 @@ writes.
In addition, materializing the most recent bucket might interfere with
[real-time aggregation][future-watermark].

See the [API reference][api-reference]
for the full list of required and optional arguments and use examples.

<Procedure>

### Changing a refresh policy to use a `NULL` `start_offset`
Expand Down Expand Up @@ -143,8 +147,8 @@ ingest rate of the hypertable due to write amplification. If you want to include
the latest bucket in your queries,
use [real-time aggregation][real-time-aggregates] instead.

[api-add-continuous-aggregate-policy]: /api/:currentVersion:/continuous-aggregates/add_continuous_aggregate_policy
[cagg-drop-data]: /use-timescale/:currentVersion:/continuous-aggregates/drop-data
[future-watermark]: /use-timescale/:currentVersion:/continuous-aggregates/troubleshooting/#continuous-aggregate-watermark-is-in-the-future
[real-time-aggregates]: /use-timescale/:currentVersion:/continuous-aggregates/real-time-aggregates
[sec-data-retention]: /use-timescale/:currentVersion:/data-retention
[api-reference]: /api/:currentVersion:/continuous-aggregates/add_continuous_aggregate_policy/