ExeQute.Explorer (exe_qute v0.1.1)

Interactive KDB+ explorer widget for Livebook.

Work in progress

This module is functional but not yet fully polished. The API and behaviour may change in future releases.

Aims to provide a QStudio-style interface directly inside Livebook: connect to a server, browse namespaces, inspect tables and functions, run ad-hoc queries, and visualise results — all from a single ExeQute.Explorer.new/1 call.

Requirements

Add to your Livebook notebook's Mix section:

{:kino, "~> 0.14"},
{:vega_lite, "~> 0.1"},
{:kino_vega_lite, "~> 0.1"}

Usage

ExeQute.Explorer.new()

For a Livebook secret password, pass it directly:

ExeQute.Explorer.new(password: System.fetch_env!("LB_KDB_PASSWORD"))

Summary

Functions

get(name)

Retrieves a query result previously stored by the Explorer widget.

new(opts \\ [])

Renders the KDB+ explorer widget. Call this in a Livebook cell.

Functions

get(name)

@spec get(String.t()) :: term()

Retrieves a query result previously stored by the Explorer widget.

Call this in a subsequent Livebook cell using the variable name you entered in the "Assign to" field:

my_data = ExeQute.Explorer.get("my_data")

Returns nil if no result has been stored under that name.

new(opts \\ [])

@spec new(keyword()) :: Kino.Layout.t()

Renders the KDB+ explorer widget. Call this in a Livebook cell.

Options

:host — pre-fill host field
:port — pre-fill port field
:username — pre-fill username field
:password — pre-fill password from a secret (not shown in UI)