Skip to content

Retain

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

Fields

Field Type Required Description Constraints Default
rows integer | null no Rollover occurs for data beyond this number of rows. min: 1 null
size string | null no A size in byte units consisting of a number followed by a unit {PB,EB,TB,GB,MB,KB}, e.g. 2 TB. Rollover occurs for data which would exceed this permitted capacity pattern: "^[1-9]+[0-9]* ?(PB\|EB\|TB\|GB\|MB\|KB)$" null
sizePct integer | null no A size as percentage of total storage of corresponding mount, specified as a number from 1 to 100. min: 1, max: 100 null
time string | null no Rollover occurs for data which has been stored for this length of time. 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

No linked schemas.

Used In

Back to top