Skip to content

Shard

A Shard contains the runtime and storage components of a database.

It groups together: - Data Access Process (DAP), which provides read access to real-time and historical data - Storage Manager (SM), which provides fast and resilient data write-down - Mounts, which define the volumes or physical storage for the data in the database - Sequencers, which define how data flows into the system

Key Value
type object
relationship Package -> Database -> Shard
object path $.databases[*].shards[*]
package file path {package-root}/databases/{db-name}/shards/{shard-name}.yaml
cli commands kxi package add --to $PKG shard --name $SHARD
kxi package rm --from $PKG shard --name $SHARD

Fields

Field Type Required Description Constraints Default
daps Dap | null no Data Access object - null
dbSettings DbSettings | null no Database settings - null
labels map<string, string > no Shard labels - {}
metadata ComponentMetadata | null no - - null
mounts map<string, Mounts > | null no PVs used in package - null
name string no Name identifier of shard - "shard"
sequencers map<string, Sequencer > | null no Message bus into system - null
sm Sm | null no Storage Manager Object - null
uuid string | null no - format: "uuid" -

Used In

Back to top