Database

Most of the Database configuration is defined through its associated Shard object.

Each package supports one database, and that database supports one shard.

The tables contained in a Database are defined at the package level by the package Table objects rather than as standalone files under the database directory.

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

Fields

Field	Type	Required	Description	Constraints	Default
description	string | null	no	DB Description	-	null
metadata	ComponentMetadata | null	no	-	-	null
name	string	no	DB Name	pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", min length: 1	"db"
qe	QueryEnvironment | null	no	Query Environment	-	null
shards	array<Shard>	no	Shards in DB	-	[]
tables	TableList | null	no	Schemas in DB	-	-
uuid	string | null	no	-	format: "uuid"	-

Links To

• metadata: ComponentMetadata
• qe: QueryEnvironment
• shards: Shard
• tables: TableList

Used In

• Package via databases