Skip to content

Manifest

This Manifest object is loaded from manifest.yaml at the package root.

It contains the package metadata and the references to the component files that make up the package, such as tables, pipelines, views, deployment configuration, and other package-level assets.

Key Value
type object
relationship Package -> Manifest
object path $.manifest
package file path {package-root}/manifest.yaml

Fields

Field Type Required Description Constraints Default
name string yes Package name - -
version string yes Package version - -
build Build | null no Build and clean commands for a package. Example: build: {cmd: [q build.q], clean: [rm -rf build], extra: []} - null
databases object | null no Databases to deploy on insights. Example: databases: {something: {dir: databases/something, shards: [something], tables: []}} - {}
dependencies array<PackageDependency> | null no Package dependencies. Example: dependencies: [] - []
deployment_config string | null no Deployment Config to deploy on insights. Example: deployment_config: deployment_config/deployment_config.yaml - null
entrypoints map<string, string | array<string> > | Entrypoint | null no Package entrypoints for insights. Example: entrypoints: {default: init.q} or entrypoints: {default: [init.q, src/bootstrap.q]} - {}
license string | string | null no Path to valid kx lic format: "path" ""
metadata Metadata | null no Package metadata - null
patches array<PatchRef> | null no Patches to apply to this package. Example: patches: [] - []
pipelines object | null no Pipelines to deploy on insights. Example: pipelines: {pipeline: {file: pipelines/pipeline.yaml}} or pipelines: {pipeline: {ref: {...}}} - {}
router string | null no Path to router to deploy on insights. Example: router: router/router.yaml - null
tables object | null no Tables to deploy on insights. Example: tables: {mytable: {file: tables/mytable.yaml}} - {}
udfs array<any> | null no Namespaces where UDF functions are stored. Example: udf_namespaces: [udf, policy, uda] - ["udf", "policy", "uda"]
uuid string | null no - format: "uuid" -
version_info string no Description of changes in this version - ""
views object | null no Views to deploy on insights. Example: views: {view: {file: views/view.yaml}} - {}

Used In

Back to top