Quickstart

Before using the API, ensure you have created and deployed a package following the kdb Insights Enterprise packaging guide.

List available packages

qPython

.kxi.packages.list.all[]

import kxi.packages
kxi.packages.packages.list()
#        name  versions
# 0  qpackage     1.0.0

Install a package

qPython

q).kxi.install["my-package"]
status   | "ok"
installed| ,"my-package==1.0.0"
output   | "Installed 1 package in 8ms\n + my-package==1.0.0"

import kxi.packages
kxi.packages.packages.install("my-package")
# {'status': 'ok', 'installed': ['my-package==1.0.0'], 'output': '...'}

Load a package

Loading a package makes its objects and functions available in the current session.

qPython

.kxi.packages.load["qpackage";"1.0.0"]

import kxi.packages
kxi.packages.packages.load("qpackage", "1.0.0")

Search for UDFs

qPython

.kxi.udfs.list.search[::;"q*";"*"]

import kxi.packages
kxi.packages.udfs.search(package_name="qpackage")

Load a UDF

Loading a UDF returns it as a callable function.

qPython

my_udf:.kxi.udfs.load["sp_map";"qpackage";"1.0.0"]

import kxi.packages
my_udf = kxi.packages.udfs.load("sp_map", "qpackage", "1.0.0")