Skip to content

Schedule

Key Value
type object
relationship Package -> Database -> Shard -> Sm -> Tier -> Schedule
object path $.databases[*].shards[*].sm.tiers[*].schedule
package file path {package-root}/databases/{db-name}/shards/{shard-name}.yaml

Fields

Field Type Required Description Constraints Default
freq string | null no How often should this tier roll data over into the next tier. A timespan in Q notation or text time frame. 0D01:00:00 or a number followed by a unit: {Years,Months,Weeks,Days,Hours,Minutes,Seconds}, e.g. 2 Years pattern: "^(([0-9]*D)?([0-1]?[0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]\|[1-9]+[0-9]* +(YEAR\|YEARS\|Year\|Years\|year\|years\|MONTH\|MONTHS\|Month\|Months\|month\|months\|WEEK\|WEEKS\|Week\|Weeks\|week\|weeks\|DAY\|DAYS\|Day\|Days\|day\|days\|HOUR\|HOURS\|Hour\|Hours\|hour\|hours\|MINUTE\|MINUTES\|Minute\|Minutes\|minute\|minutes\|MIN\|MINS\|Min\|Mins\|min\|mins\|SECOND\|SECONDS\|Second\|Seconds\|second\|seconds\|SEC\|SECS\|Sec\|Secs\|sec\|secs))$" null
offset string | null no By default, EOIs are triggered at multiples of freq counted from 2000-01-01 00:00:00. This schedule can be delayed using the optional offset parameter (must be less than freq) A timespan in Q notation or text time frame. 0D01:00:00 or a number followed by a unit: {Years,Months,Weeks,Days,Hours,Minutes,Seconds}, e.g. 2 Years pattern: "^(([0-9]*D)?([0-1]?[0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]\|[1-9]+[0-9]* +(YEAR\|YEARS\|Year\|Years\|year\|years\|MONTH\|MONTHS\|Month\|Months\|month\|months\|WEEK\|WEEKS\|Week\|Weeks\|week\|weeks\|DAY\|DAYS\|Day\|Days\|day\|days\|HOUR\|HOURS\|Hour\|Hours\|hour\|hours\|MINUTE\|MINUTES\|Minute\|Minutes\|minute\|minutes\|MIN\|MINS\|Min\|Mins\|min\|mins\|SECOND\|SECONDS\|Second\|Seconds\|second\|seconds\|SEC\|SECS\|Sec\|Secs\|sec\|secs))$" null
snap string | null no A time, in Q notation. At what whole multiples of time should rollovers be scheduled. pattern: "^([0-1]?[0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?$" null

No linked schemas.

Used In

Back to top