kxi pm
Insights Package Manager Service commands.
Usage:
text
kxi pm [OPTIONS] COMMAND [ARGS]...
Options:
text
--version Display the version of the kdb+ Insights
Enterprise Package Manager service and
client.
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm backup
Download a backup of all entitled packages from kdb+ Insights Enterprise Package Manager service
Admin users can download all packages, while non-admin users can only download packages they have READ access to.
Usage:
text
kxi pm backup [OPTIONS] [TARGET]
Options:
text
-o, --output-format [json|table]
Output format for the list command
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm config
Server configuration options.
Usage:
text
kxi pm config [OPTIONS] COMMAND [ARGS]...
Options:
text
--help Show this message and exit.
kxi pm config get
Get the current configuration of the kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi pm config get [OPTIONS]
Options:
text
-o, --output-format [json|table]
Output format for the list command
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm config set
Set the current configuration of the kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi pm config set [OPTIONS] OPTION VALUE
Options:
text
-o, --output-format [json|table]
Output format for the list command
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm convert
Convert V1/V2 assemblies into Packages with the server. Optionally keep the package installed on the server.
Usage:
text
kxi pm convert [OPTIONS] ASSEMBLY_FILE
Options:
text
--install Additionally installs the resulting package
on the server.
-o, --output-format [json|table]
Output format for the list command
--spec-files This flag converts embedded pipeline specs
to files
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm deploy
Deploy a package to an insights instance.
PACKAGE: package-name VERSION: package-version
Usage:
text
kxi pm deploy [OPTIONS] PACKAGE [VERSION]
Options:
text
--env TEXT Inject environment variables to the deployed
package. `[component_name:]VAR=value`
-o, --output-format [json|table]
Output format for the list command
--db TEXT Deploy a database in the package
--pipeline TEXT Deploy a pipeline in the package
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm edit
Edit the runnable component of the kdb+ Insights Enterprise Package on the service.
Usage:
text
kxi pm edit [OPTIONS] PACKAGE_NAME {pipeline|database} COMPONENT_NAME
Options:
text
--field TEXT Only edit a specific field of the entity.
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm info
Get info about a package stored on the kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi pm info [OPTIONS] PACKAGE_NAME [VERSION]
Options:
text
-v, --version TEXT Select package version. Default to latest.
-i, --include [udfs|policies] Include additional information in the
output. Only applies when no component type
is given.
-o, --output-format [json|table]
Output format for the list command
-f, --filter TEXT Key-pattern pairs to filter the returned
components using case-sensitive wildcard
matching (e.g. name=*test). Multiple
patterns ANDed together. Only applies when
component type (e.g. table) is given.
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm list
List objects stored on kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi pm list [OPTIONS] [[package|deployment|pipeline|view|database|udf]]
Options:
text
-f, --filter 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]
-o, --output-format [json|table|csv|simple]
Output format for the list command
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm pull
Download a package from kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi pm pull [OPTIONS] NAME [VERSION]
Options:
text
-O, --output TEXT Specify the output directory/archive name
for the downloaded package. Defaults to
package-name or packagename-version.kxi
-A, --artifact Download the package into a compressed
archive.
-o, --output-format [json|table]
Output format for the list command
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm push
Publish a package to kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi pm push [OPTIONS] [PATH]
Options:
text
--deploy Deploy the package after pushing.
--force Force push: overwrite existing packages
-o, --output-format [json|table]
Output format for the list command
--lock-q-files Lock the contents of the q files in the
package. Files whose first line is /dnc or
//dnc will be ignored.
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm restore
Restore a previously downloaded backup to kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi pm restore [OPTIONS] PATH
Options:
text
--force Force restore: overwrite existing packages
-o, --output-format [json|table]
Output format for the list command
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm rm
Remove a package from kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi pm rm [OPTIONS] ID [VERSION]
Options:
text
--teardown Teardown the package before removing.
--rm-data Remove the data associated with the
deployment
-o, --output-format [json|table]
Output format for the list command
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm teardown
Teardown a deployed package running on an insights instance
Usage:
text
kxi pm teardown [OPTIONS] PACKAGE
Options:
text
--rm-data Remove the data associated with the
deployment
-o, --output-format [json|table]
Output format for the list command
--db TEXT Teardown a database in the package
--pipeline TEXT Teardown a pipeline in the package
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm validate
Validate a package in kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi pm validate [OPTIONS] [PATH]
Options:
text
-o, --output-format [json|table]
Output format for the validate command
--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
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.