Skip to content

Docs for 1.16.1 release #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vcalescu merged 6 commits into from
Nov 26, 2025
Merged

Docs for 1.16.1 release #694

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9f9c198
remove bundled q images
vcalescu Nov 24, 2025
8a0e73f
add links to reference card and kx notebooks
vcalescu Nov 24, 2025
390cbed
update readme, changelog, and delete old images
vcalescu Nov 25, 2025
7882a1b
delete run q file shortcut
vcalescu Nov 25, 2025
f8a8065
apply Ecmel's suggestions
vcalescu Nov 25, 2025
85dd887
update wiki link
vcalescu Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed .README/edit-connected-connection-dialog.png
View file
Open in desktop
Binary file not shown.
Binary file removed .README/insightsconnection.png
View file
Open in desktop
Binary file not shown.
Binary file removed .README/kdbinsightsconnection.jpg
View file
Open in desktop
Binary file not shown.
Binary file added .README/kdbinsightsconnection.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .README/myq.png
View file
Open in desktop
Binary file not shown.
Binary file removed .README/output-results.png
View file
Open in desktop
Binary file not shown.
Binary file modified .README/select-edit-connection.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .README/welcome-to-kdbx.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ All notable changes to the **kdb VS Code extension** are documented in this file

### Fixes

- Fixed Keycloak url change in IE 1.17
- Fixed REPL system commands path issue
- Updated welcome page to be more clear
- Updated documentation
- Updated Keycloak URL configuration to support Insights Enterprise 1.17
- Resolved an issue with REPL system command path
- Improved clarity and layout of the welcome page
- Updated and refined documentation

# v1.16.0

Expand Down
88 changes: 41 additions & 47 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,11 +177,11 @@ Refer to the [PyKX within REPL](https://github.com/KxSystems/kx-vscode/wiki/Use-

### Supported file types

In addition to q and Python files, SQL files are also supported for execution within REPL. Refer to the [supported execution types](https://github.com/KxSystems/kx-vscode/wiki/Supported-Execution-Types) table for more details.
In addition to q and Python files, SQL files are also supported for execution within REPL. Refer to the [supported execution types](https://github.com/KxSystems/kx-vscode/wiki/Reference-Card#execution) table for more details.

## Connections

The **kdb VS Code extension** allows you to have multiple connections open at once, enabling development and testing across different KDB-X and kdb Insights Enterprise connections using both q and Python.
The **kdb VS Code extension** allows you to have multiple connections open at once, enabling development and testing across different KDB-X and kdb Insights Enterprise connections using q, Python, and SQL.

To add connections:

Expand Down Expand Up @@ -213,8 +213,6 @@ Set the following properties:
| Enable TLS Encryption | Check the box is TLS is enabled. Learn more [about TLS encryption](https://code.kx.com/q/kb/ssl/). |
| Label Name | Select the label you want to assign the connection to |

![setendpoint](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/myq.png)

1. Click **Create Connection** and the connection appears under **CONNECTIONS** in the primary sidebar.

1. Right-click the my q process listed under **CONNECTIONS**, and click **Connect server**. This connects to the child q process running inside the kdb VS Code extension.
Expand All @@ -233,8 +231,6 @@ Set the following properties:
| The connection address | This is the remote address of your **kdb Insights Enterprise** deployment: e.g. `https://mykdbinsights.cloudapp.azure.com` |
| Label Name | Select the label you want to assign the connection to |

![connecttoinsights](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/insightsconnection.png)

Set the following from the Advanced properties if necessary:

| Property | Description |
Expand All @@ -249,7 +245,7 @@ Set the following from the Advanced properties if necessary:

1. Right-click the connection, and click **Connect server**.

![connecttoinsights](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/kdbinsightsconnection.jpg)
![connecttoinsights](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/kdbinsightsconnection.png)

1. The kdb VS Code extension runs an authentication step with the remote **kdb Insights Enterprise** process to sign-in.

Expand Down Expand Up @@ -281,8 +277,6 @@ To edit an existing connection, right-click the connection you wish to edit and

> NOTE: Editing an **active connection** may require you to **restart** the connection. If so, you are prompted to reconnect after saving your changes.

![Edit connected connection dialog](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/edit-connected-connection-dialog.png)

### Edit My q connection

When editing a **My q** connection, you can edit the following properties:
Expand Down Expand Up @@ -470,8 +464,6 @@ For any file with a **.q** or **.py** extension there are additional options ava

- **Execute current block** - Selects the q expression under the cursor and executes it against the active connection. Results are displayed in the [Output window and/or the KDB Results window](#view-results).

- **Run q file in new q instance** - If q is installed and executable from the terminal you can execute an entire q script on a newly launched q instance. Executing a file on a new instance is done in the terminal, and allows interrogation of the active q process from the terminal window.

When executing Python code against kdb+ connections, **note** the following:

- A Python variable is defined in the remote process `_kx_execution_context`, which means you need to explicitly accept it to avoid implicit changes to the remote process. It doesn’t make any other change to the remote process.
Expand Down Expand Up @@ -797,7 +789,7 @@ KX Notebooks detect [GGPlot2](#grammar-of-graphics) outputs. If the execution ge

![See notebook plot](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/notebook-plot.png)

Sample notebooks are available on [Developer Wiki](https://github.com/KxSystems/kx-vscode/wiki/Sample-KX-Notebooks).
See the [Sample KX Notebooks](hhttps://github.com/KxSystems/kx-vscode/wiki/Sample-KX-Notebooks) for more detailed examples.

## Query History

Expand Down Expand Up @@ -829,8 +821,6 @@ All query executions happen remotely from the **kdb VS Code extension** either a

- **Output** - The **Output** window displays results as they are received by the **kdb VS Code extension**. It includes the query executed, a timestamp and the results.

![Output view](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/output-results.png)

**Note:** You can enable/disable auto-scrolling in the VS Code settings. This setting determines whether the output view scrolls to the latest results.

![Output autoscrolling](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/auto-scrolling.png)
Expand Down Expand Up @@ -891,21 +881,21 @@ To update kdb VS Code settings, search for **kdb** from _Preferences_ > _Setting

| Setting | Action |
| ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
| **Hide notification for installation path, after first install** | yes/no; default no |
| **Hide subscribe for registration notification** | yes/no; default no |
| **Hide the extension survey dialog box** | yes/no; default no |
| **Automatically [focus the output](#auto-focus-output-on-entry) console when running a query without an active results tab or receive log entry** | yes/no; default yes |
| **List of label names and colorset** | edit JSON settings |
| **Connection map for workspace files** | edit JSON settings |
| **Hide source expressions** | yes/no; default yes |
| **Hide subscribe for registration notification** | yes/no; default yes |
| **Hide survey** | yes/no; default no |
| **kdb Insights Enterprise connections for explorer** | [edit JSON settings](#kdb-insights-enterprise-connections-for-explorer) |
| **Labels connection map** | edit JSON settings |
| **Linting** | Enable linting for q and quke files |
| **Refactoring** | Choose refactoring scope |
| **QHOME directory for q runtime** | Display location path of q installation |
| **Never show q install walkthrough again** | yes/no; default no |
| **QHOME directory for q runtime** | Display location path of q installation |
| **QHOME directory for q runtime for the workspace** | Display location path of the q installation used to launch the REPL for the current workspace |
| **Refactoring** | Choose [refactoring](#refactoring) scope |
| **kdb servers for explorer** | [edit JSON settings](#servers) |
| **Automatically focus the output console when running a query without an active results tab or receive log entry** | yes/no; default yes |
| **Connection map for workspace files** | edit JSON settings |
| **Target map for workspace files** | edit JSON settings |
| **List of label names and colorset** | edit JSON settings |
| **Labels connection map** | edit JSON settings |

### Refactoring

Expand Down Expand Up @@ -1016,33 +1006,37 @@ If you choose to opt out permanently but wish to revert this, open VS Code setti

### For Windows

| Key | Action |
| --------------------- | --------------------------------- |
| F12 | Go to definition |
| Shift + F12 | Go to references |
| Ctrl + Shift + F12 | Find all references |
| Ctrl + D | Execute current selection |
| Ctrl + Shift + E | Execute current block |
| Ctrl + Shift + D | Execute entire file |
| Ctrl + Shift + R | Run q file in new q instance |
| Ctrl + Shift + Y | Toggle parameter cache for lambda |
| Ctrl + Shift + Delete | Reset scratchpad |
| Ctrl + Alt + T | Choose the execution target |
| Key | Action |
| ---------------------- | --------------------------------- |
| F12 | Go to definition |
| Shift + F12 | Go to references |
| Ctrl + Shift + F12 | Find all references |
| Ctrl + D | Execute current selection |
| Ctrl + Shift + E | Execute current block |
| Ctrl + Shift + D | Execute entire file |
| Ctrl + Shift + Y | Toggle parameter cache for lambda |
| Ctrl + Shift + Alt + P | Populate Scratchpad |
| Ctrl + Shift + Delete | Reset Scratchpad |
| Ctrl + Alt + T | Choose the execution target |

### For MacOS

| Key | Action |
| ------------------ | --------------------------------- |
| F12 | Go to definition |
| Shift + F12 | Go to references |
| ⌘ + Shift + F12 | Find all references |
| ⌘ + D | Execute current selection |
| ⌘ + Shift + E | Execute current block |
| ⌘ + Shift + D | Execute entire file |
| ⌘ + Shift + R | Run q file in new q instance |
| ⌘ + Shift + Y | Toggle parameter cache for lambda |
| ⌘ + Shift + Delete | Reset scratchpad |
| ⌘ + Alt + T | Choose the execution target |
| Key | Action |
| -------------------- | --------------------------------- |
| F12 | Go to definition |
| Shift + F12 | Go to references |
| ⌘ + Shift + F12 | Find all references |
| ⌘ + D | Execute current selection |
| ⌘ + Shift + E | Execute current block |
| ⌘ + Shift + D | Execute entire file |
| ⌘ + Shift + Y | Toggle parameter cache for lambda |
| ⌘ + Shift + Alt + P | Populate Scratchpad |
| ⌘ + Shift + Delete | Reset Scratchpad |
| ⌘ + Alt + T | Choose the execution target |

## Reference card

See the [Reference Card](https://github.com/KxSystems/kx-vscode/wiki/Reference-Card) for a list of all commands, shortcuts, and settings.

## Data and telemetry

Expand Down