Skip to content

Package

The Package object is constructed using the kxi package CLI from a directory structure containing a manifest.yaml and component object files (shard.yaml,pipeline.yaml, etc).

Example package layout:

.
├── databases
│   └── my-db
│       └── shards
│           └── my-db.yaml
├── deployment_config
│   └── deployment_config.yaml
├── init.q
├── manifest.yaml
├── pipelines
│   └── pipeline.yaml
├── src
│   └── pipeline.q
├── tables
│   └── mytable.yaml
├── udfs.yaml
└── views
    └── view.yaml

If you are working with the directory structure, it is much more likely you will be working with a package's component objects and their corresponding files as well as the Manifest file, which contains the package metadata.

The Package object is constructed from these files by the CLI and sent to the kdb+ Insights Enterprise server via a POST call to the package manager service.

Key Value
type object
relationship Package
object path $
package file path {package-root}/

Fields

Field Type Required Description Constraints Default
name string yes Package name pattern: "^[a-z]([-a-z0-9]*[a-z0-9])?$", min length: 1, max length: 24 -
version string yes Package version pattern: "^([0-9]+!)?[0-9]+(\\.[0-9]+)*([-_.](a\|b\|c\|rc\|alpha\|beta\|pre\|preview)[-_.]?[0-9]*)?((-[0-9]+)\|([-_.](post\|rev\|r)[-_.]?[0-9]*))?([-_.]dev[-_.]?[0-9]*)?(\\+[a-z0-9]+([-_.][a-z0-9]+)*)?$" -
data_files map<string, DataFile | null > no Binary or source files stored in the package - {}
databases array<Database> | null no Databases to deploy on insights max length: 1 []
dependencies array<PackageDependency> | null no Package dependencies - []
deployment_config DeploymentConfig | null no DeploymentConfig to deploy on insights - null
manifest Manifest | null no Manifest object for package - null
metadata Metadata | null no Package metadata - null
patches array<PatchRef> | null no Patches for this package - []
pipelines array<Pipeline> | null no Pipelines to deploy on insights - []
requirements array<string> | null no List of pip requirements for the package - null
router Router | null no Router to deploy on insights - null
tables TableList | null no Tables linked to databases to deploy on insights - -
udfs UDFCollection | null no UDF objects found in the package - null
uuid string | null no - format: "uuid" -
views array<View> | null no Views to deploy on insights - []

Used In

No incoming references.

Back to top