Skip to content

Commit

Permalink
Add note to call out schedule_interval default (#2844)
Browse files Browse the repository at this point in the history
* Add note to call out schedule_interval default

* Appease Vale
  • Loading branch information
jamessewell authored Nov 27, 2023
1 parent 470288a commit 9ff44ce
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions api/add_policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ timescaledb_experimental.add_policies(

<Experimental />

<Highlight type="note">
`add_policies()` does not allow the `schedule_interval` for the continuous aggregate to be set, instead using a default value of 1 hour.

If you would like to set this add your policies manually (see [`add_continuous_aggregate_policy`][add_continuous_aggregate_policy]).
</Highlight>

## Required arguments

|Name|Type|Description|
Expand Down Expand Up @@ -74,3 +80,6 @@ SELECT timescaledb_experimental.add_policies(
drop_after => '1 year'::interval
);
```
<!-- vale Vale.Terms = NO -->
[add_continuous_aggregate_policy]: /api/:currentVersion/continuous-aggregates/add_continuous_aggregate_policy/
<!-- vale Vale.Terms = YES -->

0 comments on commit 9ff44ce

Please sign in to comment.