Skip to content

Tier

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

Fields

Field Type Required Description Constraints Default
mount string yes The name of a corresponding mounts entry at which data in this tier may be accessed. pattern: "^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$" -
name string yes A string used to refer to a particular tier pattern: "^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$" -
compression Compression | null no Policy for compression of data, if any. - null
description string | null no A string describing the purpose of this tier. - null
index integer | null no Optional integer that controls the order of HDB tiers, sorted ascending. Tiers without an index value default to 0 and preserve their relative order. - null
inventory Inventory | null no Inventory configuration for a gzipped JSON that allows caching a subset of a buckets file names and sizes - null
retain Retain | null no Policy for how much data should be stored in this tier before it is rolled over into the next tier. - null
schedule Schedule | null no Policy for when rollovers should be considered. - null
store string | null no A URI describing where this tier will physically store data. pattern: "^((file:\\/\\/\\/\|s3:\\/\\/\|gs:\\/\\/\|ms:\\/\\/)+[a-zA-Z0-9\\/-]*)\|realtime$" null

Used In

  • Sm via tiers
Back to top