Skip to content
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.

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

Version 1.6 Doc #352

Merged
merged 7 commits into from
Jun 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,32 @@

All notable changes to the **kdb VS Code extension** are documented in this file.

# v1.6.0

### Enhancements

- Display meta data for Insights connections
- Insights free trial instances are supported
- Added execute block command for q code
- Added hotkey to cache function parameters for q code

### Fixes

- Disconnect when q process is stopped
- Fix query execution on KDB+ connections not refreshing completion items

### Internal Improvements

- Added logging framework

# v1.5.2

### Fixes

- Local connection listener behaviour fixed (if the connection is closed, the connection will disconnect)
- Return to show console output if results tab isn't visible in case of query execution
- Linter fixes

# v1.5.1

### Fixes
Expand Down
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,8 @@ For any file with a **.q** or **.py** extension there are additional options ava

- **Execute current selection** - Takes the current selection (or current line if nothing is selected) and executes it against the active connection. Results are displayed in the [Output window and/or the KDB Results window](#view-results).

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

### Insights query execution
Expand Down Expand Up @@ -359,16 +361,14 @@ To create a Workbook and run code against a specific connection:
1. Click **Run** from above the first line of code in the workbook file.
![workbook links](https://github.com/KxSystems/kx-vscode/blob/main/img/workbookrunlink.png?raw=true)

1. Select **Run** from the upper right of the editor. Using the dropdown next to the button you can choose to **KX: Execute Entire File** or **KX Execute Current Selection**.
1. Select **Run** from the upper right of the editor. Using the dropdown next to the button you can choose any of the [**KX:** menu items](#kdb-process-executing-q-and-python-code) to run some, or all of the code in the workbook.
![play dropdown](https://github.com/KxSystems/kx-vscode/blob/main/img/wortkbookplaydropdown.png?raw=true)

1. Click **Run** on the right-hand side of the status bar.
![status bar run ](https://github.com/KxSystems/kx-vscode/blob/main/img/workbookstatusbarrun.png?raw=true)

1. Right-click and choose **KX: Execute Entire File** from the menu.

1. If you wish to only run the current selection (or current line if nothing is selected), right-click and choose **KX: Execute Current Selection** from the menu.

1. If you have not yet chosen a connection to associate with the workbook you are asked to choose a connection before the code is executed.
![choose connection](https://github.com/KxSystems/kx-vscode/blob/main/img/workbookconnectionlink.png?raw=true)

Expand Down Expand Up @@ -506,22 +506,26 @@ To update kdb VS Code settings, search for **kdb** from _Preferences_ > _Setting

### 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 + D | Execute entire file |
| Ctrl + Shift + R | Run q file in new q instance |
| 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 paramater cache for lambda |

### For MacOS

| Key | Action |
| --------------- | ---------------------------- |
| F12 | Go to definition |
| Shift + F12 | Go to references |
| ⌘ + Shift + F12 | Find all references |
| ⌘ + D | Execute current selection |
| ⌘ + Shift + D | Execute entire file |
| ⌘ + Shift + R | Run q file in new q instance |
| 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 paramater cache for lambda |
Binary file modified img/workbookplaydropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading