Skip to content

Commit

Permalink
Make CAggs materialized only by default
Browse files Browse the repository at this point in the history
Historically creating a Continuous Aggregate make it realtime by default
but it confuse users specially when using `WITH NO DATA` option. Also is
well known that realtime Continuous Aggregates can potentially lead to
issues with Hierarchical and Data Tiering.

Updated the docs according to this new behavior merged by PR
timescale/timescaledb#6077
  • Loading branch information
fabriziomello committed Sep 27, 2023
1 parent 4a03309 commit 35f3501
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion api/create_materialized_view.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Optional `WITH` clause options:

|Name|Type|Description|Default value|
|-|-|-|-|
|`timescaledb.materialized_only`|BOOLEAN|Return only materialized data when querying the continuous aggregate view|`FALSE`|
|`timescaledb.materialized_only`|BOOLEAN|Return only materialized data when querying the continuous aggregate view|`TRUE`|
|`timescaledb.create_group_indexes`|BOOLEAN|Create indexes on the continuous aggregate for columns in its `GROUP BY` clause. Indexes are in the form `(<GROUP_BY_COLUMN>, time_bucket)`|`TRUE`|
|`timescaledb.finalized`|BOOLEAN|In TimescaleDB 2.7 and above, use the new version of continuous aggregates, which stores finalized results for aggregate functions. Supports all aggregate functions, including ones that use `FILTER`, `ORDER BY`, and `DISTINCT` clauses.|`TRUE`|

Expand Down
6 changes: 3 additions & 3 deletions use-timescale/continuous-aggregates/real-time-aggregates.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ import CaggsRealTimeHistoricalDataRefreshes from 'versionContent/_partials/_cagg
Continuous aggregates do not include the most recent data chunk from the
underlying hypertable. Real time aggregates use the aggregated data and add the
most recent raw data to it to provide accurate and up to date results, without
needing to aggregate data as it is being written. In Timescale&nbsp;1.7 and later,
real time aggregates are enabled by default. When you create a continuous
needing to aggregate data as it is being written. Starting on Timescale&nbsp;1.7 to 2.12,
real time aggregates are enabled by default, it means when you create a continuous
aggregate view, queries to that view include the most recent data, even if
it has not yet been aggregated.
it has not yet been aggregated. But on Timescale&nbsp;2.13 and later real time aggregates are *NOT* enabled by default.

Check warning on line 18 in use-timescale/continuous-aggregates/real-time-aggregates.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Acronyms] Spell out 'NOT', if it's unfamiliar to the audience. Raw Output: {"message": "[Google.Acronyms] Spell out 'NOT', if it's unfamiliar to the audience.", "location": {"path": "use-timescale/continuous-aggregates/real-time-aggregates.md", "range": {"start": {"line": 18, "column": 96}}}, "severity": "INFO"}

For more detail on the comparison between continuous and real time aggregates,
see our [real time aggregate blog post][blog-rtaggs].
Expand Down

0 comments on commit 35f3501

Please sign in to comment.