Scale Intelligence■ Docs
Docs / The model / RetentionClass

RetentionClass.

How long a unit is kept, and whether it may be pruned behind the gold layer

Figure 1RetentionClassspecified
RETENTIONCLASSrow at platform scopenametextkeep_fordurationprunable_behind_lakeboolthe rights, the plan, or the platform's ownbasistextpoints at no other object
RetentionClass is a row at platform scope. The drawing shows its fields and the objects that they point at.
kind
row
scope
platform
key
its name
store
postgres
family
registers

Fields#

fieldtyperequirednote
nametextyes
keep_fordurationyes
prunable_behind_lakeboolyes
basistextyesthe rights, the plan, or the platform’s own

Routes that use it#

No route takes or returns RetentionClass directly. The record holds it, and the objects that point at it reach it.