Skip to content

Commit 6b06b7f

Browse files
authored
Merge pull request #694 from vcalescu/docs-1.16.1-release
Docs for 1.16.1 release
2 parents 976e34a + 85dd887 commit 6b06b7f

10 files changed

+46
-52
lines changed
-12.2 KB
Binary file not shown.

.README/insightsconnection.png

-87.2 KB
Binary file not shown.

.README/kdbinsightsconnection.jpg

-9.53 KB
Binary file not shown.

.README/kdbinsightsconnection.png

22.4 KB
Loading

.README/myq.png

-112 KB
Binary file not shown.

.README/output-results.png

-149 KB
Binary file not shown.

.README/select-edit-connection.png

56.6 KB
Loading

.README/welcome-to-kdbx.png

-13.3 KB
Loading

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ All notable changes to the **kdb VS Code extension** are documented in this file
66

77
### Fixes
88

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

1414
# v1.16.0
1515

README.md

Lines changed: 42 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ To execute a q file in REPL:
149149

150150
The results are shown in the terminal and you can continue to work either in your q file or directly in the terminal.
151151

152-
Refer to the [REPL shortcuts table](https://github.com/KxSystems/kx-vscode/wiki/REPL) for information on the keyboard shortcuts you can use.
152+
Refer to the [REPL shortcuts table](https://github.com/KxSystems/kx-vscode/wiki/Reference-Card#repl) for information on the keyboard shortcuts you can use.
153153

154154
### Benefits of using REPL
155155

@@ -177,11 +177,11 @@ Refer to the [PyKX within REPL](https://github.com/KxSystems/kx-vscode/wiki/Use-
177177

178178
### Supported file types
179179

180-
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.
180+
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.
181181

182182
## Connections
183183

184-
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.
184+
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.
185185

186186
To add connections:
187187

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

216-
![setendpoint](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/myq.png)
217-
218216
1. Click **Create Connection** and the connection appears under **CONNECTIONS** in the primary sidebar.
219217

220218
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.
@@ -233,8 +231,6 @@ Set the following properties:
233231
| The connection address | This is the remote address of your **kdb Insights Enterprise** deployment: e.g. `https://mykdbinsights.cloudapp.azure.com` |
234232
| Label Name | Select the label you want to assign the connection to |
235233

236-
![connecttoinsights](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/insightsconnection.png)
237-
238234
Set the following from the Advanced properties if necessary:
239235

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

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

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

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

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

282278
> NOTE: Editing an **active connection** may require you to **restart** the connection. If so, you are prompted to reconnect after saving your changes.
283279
284-
![Edit connected connection dialog](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/edit-connected-connection-dialog.png)
285-
286280
### Edit My q connection
287281

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

471465
- **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).
472466

473-
- **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.
474-
475467
When executing Python code against kdb+ connections, **note** the following:
476468

477469
- 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.
@@ -797,7 +789,7 @@ KX Notebooks detect [GGPlot2](#grammar-of-graphics) outputs. If the execution ge
797789

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

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

802794
## Query History
803795

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

830822
- **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.
831823

832-
![Output view](https://raw.githubusercontent.com/KxSystems/kx-vscode/main/.README/output-results.png)
833-
834824
**Note:** You can enable/disable auto-scrolling in the VS Code settings. This setting determines whether the output view scrolls to the latest results.
835825

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

892882
| Setting | Action |
893883
| ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
894-
| **Hide notification for installation path, after first install** | yes/no; default no |
895-
| **Hide subscribe for registration notification** | yes/no; default no |
896-
| **Hide the extension survey dialog box** | yes/no; default no |
884+
| **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 |
885+
| **List of label names and color set** | edit JSON settings |
886+
| **Connection map for workspace files** | edit JSON settings |
897887
| **Hide source expressions** | yes/no; default yes |
888+
| **Hide subscribe for registration notification** | yes/no; default yes |
889+
| **Hide survey** | yes/no; default no |
898890
| **kdb Insights Enterprise connections for explorer** | [edit JSON settings](#kdb-insights-enterprise-connections-for-explorer) |
891+
| **Labels connection map** | edit JSON settings |
899892
| **Linting** | Enable linting for q and quke files |
900-
| **Refactoring** | Choose refactoring scope |
901-
| **QHOME directory for q runtime** | Display location path of q installation |
902893
| **Never show q install walkthrough again** | yes/no; default no |
894+
| **QHOME directory for q runtime** | Display location path of q installation |
895+
| **QHOME directory for q runtime for the workspace** | Display location path of the q installation used to launch the REPL for the current workspace |
896+
| **Refactoring** | Choose [refactoring](#refactoring) scope |
903897
| **kdb servers for explorer** | [edit JSON settings](#servers) |
904-
| **Automatically focus the output console when running a query without an active results tab or receive log entry** | yes/no; default yes |
905-
| **Connection map for workspace files** | edit JSON settings |
906898
| **Target map for workspace files** | edit JSON settings |
907-
| **List of label names and colorset** | edit JSON settings |
908-
| **Labels connection map** | edit JSON settings |
909899

910900
### Refactoring
911901

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

10171007
### For Windows
10181008

1019-
| Key | Action |
1020-
| --------------------- | --------------------------------- |
1021-
| F12 | Go to definition |
1022-
| Shift + F12 | Go to references |
1023-
| Ctrl + Shift + F12 | Find all references |
1024-
| Ctrl + D | Execute current selection |
1025-
| Ctrl + Shift + E | Execute current block |
1026-
| Ctrl + Shift + D | Execute entire file |
1027-
| Ctrl + Shift + R | Run q file in new q instance |
1028-
| Ctrl + Shift + Y | Toggle parameter cache for lambda |
1029-
| Ctrl + Shift + Delete | Reset scratchpad |
1030-
| Ctrl + Alt + T | Choose the execution target |
1009+
| Key | Action |
1010+
| ---------------------- | --------------------------------- |
1011+
| F12 | Go to definition |
1012+
| Shift + F12 | Go to references |
1013+
| Ctrl + Shift + F12 | Find all references |
1014+
| Ctrl + D | Execute current selection |
1015+
| Ctrl + Shift + E | Execute current block |
1016+
| Ctrl + Shift + D | Execute entire file |
1017+
| Ctrl + Shift + Y | Toggle parameter cache for lambda |
1018+
| Ctrl + Shift + Alt + P | Populate Scratchpad |
1019+
| Ctrl + Shift + Delete | Reset Scratchpad |
1020+
| Ctrl + Alt + T | Choose the execution target |
10311021

10321022
### For MacOS
10331023

1034-
| Key | Action |
1035-
| ------------------ | --------------------------------- |
1036-
| F12 | Go to definition |
1037-
| Shift + F12 | Go to references |
1038-
| ⌘ + Shift + F12 | Find all references |
1039-
| ⌘ + D | Execute current selection |
1040-
| ⌘ + Shift + E | Execute current block |
1041-
| ⌘ + Shift + D | Execute entire file |
1042-
| ⌘ + Shift + R | Run q file in new q instance |
1043-
| ⌘ + Shift + Y | Toggle parameter cache for lambda |
1044-
| ⌘ + Shift + Delete | Reset scratchpad |
1045-
| ⌘ + Alt + T | Choose the execution target |
1024+
| Key | Action |
1025+
| -------------------- | --------------------------------- |
1026+
| F12 | Go to definition |
1027+
| Shift + F12 | Go to references |
1028+
| ⌘ + Shift + F12 | Find all references |
1029+
| ⌘ + D | Execute current selection |
1030+
| ⌘ + Shift + E | Execute current block |
1031+
| ⌘ + Shift + D | Execute entire file |
1032+
| ⌘ + Shift + Y | Toggle parameter cache for lambda |
1033+
| ⌘ + Shift + Alt + P | Populate Scratchpad |
1034+
| ⌘ + Shift + Delete | Reset Scratchpad |
1035+
| ⌘ + Alt + T | Choose the execution target |
1036+
1037+
## Reference card
1038+
1039+
See the [Reference Card](https://github.com/KxSystems/kx-vscode/wiki/Reference-Card) for a list of all commands, shortcuts, and settings.
10461040

10471041
## Data and telemetry
10481042

0 commit comments

Comments
 (0)