Skip to content

kdb Insights Enterprise Interfaces

This page provides an overview of the interfaces you can use to run and manage kdb Insights Enterprise:

KXI Command Line Interface (CLI)

The KXI Command Line Interface (CLI) is a development interface for administrators and data developers to manage the kdb Insights Enterprise application.

KXI Command Line Interface

Use the CLI to:

  • Manage installation, upgrade, and uninstall of kdb Insights Enterprise deployments.

  • Programmatically create, manage, and tear down assemblies and packages that allow you to manage the life cycle of deployments and custom logic. Use the kxi assembly subcommand or packaging commands for this functionality.

  • Configure the system to meet your requirements using the CLI wizard to simplify the process and set up the required parameters. Apply more advanced configurations using the values file it generates.

  • Manage access to the system with user and service level authentication and authorization, role management, single sign-on (SSO), and identify brokering.

Deprecation of Assembly Files

The deployment of assembly yaml files using the kxi assembly command in the kdb Insights CLI has been deprecated and may be removed from future releases. Use packages instead, which you can deploy and manage using the kdb Insights CLI. For more information about packages, refer to packages.

Web Interface

The web interface is an interactive visual browser-based tool for data developers and analysts to create and build databases for the purpose of querying and visualizing data into dashboards.

Web Interface

  • Build and configure your database with query, write down, schema, stream, and other advanced settings. Assign resources based on your data requirements.

  • Use the pipeline builder or import wizard to guide you through importing data from several different sources, including cloud and relational data services.

  • Explore and query your data using q, SQL or Python.

  • Use Views, the embedded version of KX Dashboards, a drag and drop interface that helps to analyze and visualize your data by building Views. Views include feature rich components such as charts, maps, and data grids for deeper insights.

Visual Code Studio Extension

The kdb Visual Studio Code extension is a development tool that provides features for developers working with the kdb+ database and the q programming language. This extension is particularly useful for those who need to manage and interact with various kdb environments efficiently. It integrates seamlessly with kdb Insights Enterprise when using a shared kdb process.

VSCode Extension

Use the kdb VS Code extension to:

  • Install q. The extension integrates seamlessly with q.

  • Write q code with support for syntax highlighting, code prediction, and autocomplete.

  • Write and execute q from a single line of code, code block, or q file.

  • Write and execute both q and Python code against kdb Insights Enterprise.

  • Connect to multiple q processes or kdb Insights Enterprise deployments. Open multiple connections simultaneously, making it easy to develop and test with both q and Python across different kdb and kdb Insights Enterprise setups.

  • Use a KX data source to choose a connection, specify the parameters and run API requests using SQL or qSQL. KX data source files allow you to build queries within VS Code, associate them with a connection, and run them against the kdb Insights Enterprise API endpoints.

  • Use a KX workbook to choose a connection and run q or Python code against any connection. Workbooks simplify prototyping and executing q and Python code on a q process, utilizing the variables from a kdb Insights Enterprise deployment.

  • View results from your queries in two different windows. The Output window displays results as they are received by the kdb VS Code extension. The kdb Results window displays the kdb returned data in a table.

To access this extension and detailed documentation, refer to the Visual Studio Marketplace.

Developer Libraries

Libraries are available in various languages, designed for developers to integrate with:

  • kdb Insights Enterprise - allows access from outside your cluster using load balancers, or from inside your cluster without the need for load balancers.

  • kdb Insights Reliable Transport - a microarchitecture that ensures reliable streaming of messages. It is designed to meet both high availability and high-performance requirements, and it is built upon the Raft consensus algorithm.

Refer to the following resources to learn more about publishing, subscribing, and querying data.