List Packages
This page provides an overview of listing packages in kdb Insights Enterprise using the CLI.
Once a package has been uploaded to kdb Insights Enterprise, you should validate it has been successfully uploaded to the server.
List a package
To list all the uploaded packages, use the kxi pm list command, as defined below:
kxi pm list --help
Usage: kxi pm list [OPTIONS] [[package|deployment|pipeline|view|database|udf]]
List objects stored on kdb+ Insights Enterprise Package Manager service.
╭─ Authentication option overrides ────────────────────────────────────────────╮
│ --hostname,--url TEXT Insights URL │
│ --realm TEXT Realm │
│ --client-id TEXT Client id │
│ --client-secret TEXT Client secret │
│ --auth-enabled/--auth-disabled Retrieve Bearer Token │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --filter -f TEXT Key-pattern pair to filter │
│ the returned packages on. │
│ Applies case-sensitive │
│ filtering using wildcard │
│ patterns. Multiple patterns │
│ ANDed together. Key names │
│ may include dot notation │
│ for nested values (e.g., │
│ owner.name=John*). │
│ --fields TEXT [default: name, package, │
│ version, function, status, │
│ data, access, owner, id, │
│ info] │
│ --output-format -o [json|table|csv|simple] Output format for the list │
│ command │
│ --server-timeout INTEGER Timeout for Insights server │
│ calls │
│ --yes,--assume-yes -y Automatic yes to prompts; │
│ assume "yes" as answer to │
│ all prompts andrun │
│ non-interactively. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Using the web interface or the CLI
kdb Insights Enterprise has both a web interface and command line interface (CLI). You can use either one to list a package. For information on how to view a list of all your packages using the web interface, refer to the documentation on viewing an index of packages.
The following examples demonstrate how to list packages on a kdb Insights Enterprise instance using two packages, which are test-deploy and test-package:
Default list functionality:
kxi pm list
List with type=package
╭──────────────┬─────────┬────────┬────────────────────────────────┬──────────────────────────────────────╮
│ name │ version │ access │ owner.name │ id │
├──────────────┼─────────┼────────┼────────────────────────────────┼──────────────────────────────────────┤
│ test-deploy │ 1.0.0 │ ARWX │ test-user-rw │ 529ab8df-3f1a-4b5b-8d69-29ecee6ca2f5 │
│ test-package │ 0.0.1 │ ARWX │ service-account-test-publisher │ add333ad-bdd2-41a9-bcc7-a24fdbee598f │
╰──────────────┴─────────┴────────┴────────────────────────────────┴──────────────────────────────────────╯
kxi pm list -fname="test-*" --fields=name,deploy_user.name
List with type=package
╭──────────────┬──────────────────╮
│ name │ deploy_user.name │
├──────────────┼──────────────────┤
│ test-deploy │ test-user-rw │
│ test-package │ - │
╰──────────────┴──────────────────╯
kxi pm list -fname="test-*" --ojson
{
"meta": [
{
"logs": {
"info": [],
"warning": [],
"error": []
}
}
],
"data": [
{
"access": "ARWX",
"id": "529ab8df-3f1a-4b5b-8d69-29ecee6ca2f5",
"version": "1.0.0",
"name": "test-deploy",
"owner": {
"uuid": "1268e9cc-f24f-4a1b-9aa9-f8d779e83609",
"name": "test-user-rw",
"email": ""
},
"deploy_user": {
"uuid": "1268e9cc-f24f-4a1b-9aa9-f8d779e83609",
"name": "test-user-rw",
"email": ""
},
"push_user": {
"uuid": "1268e9cc-f24f-4a1b-9aa9-f8d779e83609",
"name": "test-user-rw",
"email": ""
}
},
{
"access": "ARWX",
"id": "add333ad-bdd2-41a9-bcc7-a24fdbee598f",
"version": "0.0.1",
"name": "test-package",
"owner": {
"uuid": "2df6e07d-b005-42bd-a570-5f90c13c6b2c",
"name": "service-account-test-publisher",
"email": ""
},
"push_user": {
"uuid": "2df6e07d-b005-42bd-a570-5f90c13c6b2c",
"name": "service-account-test-publisher",
"email": ""
}
}
]
}
View package info
To view detailed information about a package, run the kxi pm info command. This displays the information as shown in the following example:
kxi pm info mypkg
╭──────────────┬────────────────────────────────────────────────────────────────────────────────╮
│ Name │ Value │
├──────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ Package UUID │ fe3ddb51-9279-4669-9cbd-4fb6b42603df │
│ Package Name │ mypkg (0.0.2.dev1) │
│ Author(s) │ user-account │
│ Components │ ╭───────────────────┬─────────────┬──────────────────────────────────────────╮ │
│ │ │ Type │ Name │ Path │ │
│ │ ├───────────────────┼─────────────┼──────────────────────────────────────────┤ │
│ │ │ Entrypoint │ default │ init.q │ │
│ │ │ Entrypoint │ data-access │ init.q │ │
│ │ │ Table │ tab1 │ tables/tab1.yaml │ │
│ │ │ Table │ tab2 │ tables/tab2.yaml │ │
│ │ │ Pipeline │ pype │ pipelines/pype.yaml │ │
│ │ │ Database │ db │ databases/db │ │
│ │ │ Deployment Config │ - │ deployment_config/deployment_config.yaml │ │
│ │ ╰───────────────────┴─────────────┴──────────────────────────────────────────╯ │
│ Dependencies │ - │
│ Pakx Client │ 1.13.0 │
╰──────────────┴─────────────────────────────────────────────────────────────────────────────