Skip to content

Router

A Router contains the per-package query routing services used by the package.

It groups together the package's agg, rc, and qe configuration, which are commonly deployed as part of the query routing layer of the system.

In this routing layer, the Resource Coordinator (rc) distributes queries across the relevant Data Access Processes, and the Aggregator (agg) combines the partial results into the final response. Query environments (qe) provide isolated query capacity for package data, which is commonly used to separate interactive or SQL-style query workloads from the primary query path.

If these components are not included in the package, the deployed database uses instance-common rc and agg services to manage query routing.

Key Value
type object
relationship Package -> Router
object path $.router
package file path {package-root}/router/{router-name}.yaml
cli commands kxi package add --to $PKG router --name $ROUTER
kxi package rm --from $PKG router --name $ROUTER

Fields

Field Type Required Description Constraints Default
agg Agg | null no Aggregator object - null
metadata ComponentMetadata | null no - - null
name string | null no Name of the router - "router"
qe QueryEnvironment | null no Configure Query Environments for Assembly - {"enabled": true, "size": 1}
rc Rc | null no Resource Coordinator object - null
uuid string | null no - format: "uuid" -

Used In

Back to top