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

Document alter materialized view compression options #2779

Merged
merged 2 commits into from
Nov 22, 2023
Merged

Document alter materialized view compression options #2779

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04556c9
Document alter materialized view compression options
jonatas Nov 1, 2023
c0dc6d3
Merge branch 'latest' into mention-compression-on-cagg-alter
jonatas Nov 22, 2023
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
7 changes: 5 additions & 2 deletions api/alter_materialized_view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,11 @@

|Name|Description|
|-|-|
|timescaledb.materialized_only|Enable and disable real time aggregation|
|timescaledb.compress|Enable and disable compression|
|`timescaledb.materialized_only`|Enable and disable real time aggregation|

Check warning on line 41 in api/alter_materialized_view.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.

Raw Output:
{"message": "[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.", "location": {"path": "api/alter_materialized_view.md", "range": {"start": {"line": 41, "column": 45}}}, "severity": "WARNING"}
|`timescaledb.compress`|Enable and disable compression|

Check warning on line 42 in api/alter_materialized_view.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.

Raw Output:
{"message": "[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.", "location": {"path": "api/alter_materialized_view.md", "range": {"start": {"line": 42, "column": 36}}}, "severity": "WARNING"}
|`timescaledb.compress_orderby`|TEXT|Order used by compression, specified in the same way as the ORDER BY clause in a SELECT query. The default is the descending order of the hypertable's time column.|

Check warning on line 43 in api/alter_materialized_view.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'TEXT', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'TEXT', if it's unfamiliar to the audience.", "location": {"path": "api/alter_materialized_view.md", "range": {"start": {"line": 43, "column": 33}}}, "severity": "INFO"}
|`timescaledb.compress_segmentby`|TEXT|Column list on which to key the compressed segments. An identifier representing the source of the data such as `device_id` or `tags_id` is usually a good candidate. The default is no `segment by` columns.|

Check warning on line 44 in api/alter_materialized_view.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'TEXT', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'TEXT', if it's unfamiliar to the audience.", "location": {"path": "api/alter_materialized_view.md", "range": {"start": {"line": 44, "column": 35}}}, "severity": "INFO"}
|`timescaledb.compress_chunk_time_interval`|TEXT|EXPERIMENTAL: Set compressed chunk time interval used to roll compressed chunks into. This parameter compresses every chunk, and then merges it into a previous adjacent chunk if possible, to reduce the total number of chunks in the hypertable. It should be set to a multiple of the current chunk interval. This option can be changed independently of other compression settings and does not require the `timescaledb.compress` argument.|

Check warning on line 45 in api/alter_materialized_view.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'TEXT', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'TEXT', if it's unfamiliar to the audience.", "location": {"path": "api/alter_materialized_view.md", "range": {"start": {"line": 45, "column": 45}}}, "severity": "INFO"}

### Sample usage

Expand Down
Loading