Create a policy to drop chunks older than a given interval of a particular hypertable or continuous aggregate on a schedule in the background. For more information, see the drop_chunks section. This implements a data retention policy and removes data on a schedule. Only one retention policy may exist per hypertable.
|REGCLASS||Name of the hypertable or continuous aggregate to create the policy for|
|INTERVAL or INTEGER||Chunks fully older than this interval when the policy is run are dropped|
|INTERVAL||The interval between the finish time of the last execution and the next start. Defaults to NULL.|
|TIMESTAMPTZ||Time the policy is first run. Defaults to NULL. If omitted, then the schedule interval is the interval between the finish time of the last execution and the next start. If provided, it serves as the origin with respect to which the next_start is calculated.|
|TEXT||A valid time zone. If |
drop_after parameter should be specified differently depending on the
type of the time column of the hypertable:
- For hypertables with TIMESTAMP, TIMESTAMPTZ, and DATE time columns: the time interval should be an INTERVAL type.
- For hypertables with integer-based timestamps: the time interval should be an integer type (this requires the integer_now_func to be set).
|BOOLEAN||Set to |
|INTEGER||TimescaleDB background job ID created to implement this policy|
Create a data retention policy to discard chunks greater than 6 months old:
SELECT add_retention_policy('conditions', INTERVAL '6 months');
Create a data retention policy with an integer-based time column:
SELECT add_retention_policy('conditions', BIGINT '600000');
Found an issue on this page?Report an issue!