Entrypoint¶
An Entrypoint defines package code to load at runtime in kdb Insights
Enterprise. The default entrypoint is typically init.q and is loaded
when no specific entrypoint is requested.
Additional named entrypoints can be used to load component-specific code
independently. Well-known entrypoint names include data-access,
aggregator, resource-coordinator, and storage-manager.
| Key | Value |
|---|---|
type |
object |
relationship |
Package -> Manifest -> Entrypoint |
object path |
$.manifest.entrypoints.* |
package file path |
{package-root}/manifest.yaml |
cli commands |
kxi package add --to $PKG entrypoint --name $ENTRYPOINTkxi package rm --from $PKG entrypoint --name $ENTRYPOINT |
Fields¶
| Field | Type | Required | Description | Constraints | Default |
|---|---|---|---|---|---|
name |
string |
yes | Name of the entrypoint to add from the package. There are special entrypoints, that when specified, are loaded into the data-services processes; | entrypoint key | service | | -------------------- | ------------ | | data-access | dap | | resource-coordinator | rc | | storage-manager | sm | | aggregator | agg | | - | - |
filepath |
string |
no | Path to the entrypoint. | format: "path" |
"." |
metadata |
ComponentMetadata | null |
no | - | - | null |
uuid |
string | null |
no | - | format: "uuid" |
- |
Links To¶
metadata:ComponentMetadata
Used In¶
Manifestviaentrypoints