Skip to content

Commit 0ab16a5

Browse files
authored
Merge pull request #536 from vcalescu/docs-reset-scratchpad
Add reset scratchpad section
2 parents fc93a06 + 8741834 commit 0ab16a5

File tree

4 files changed

+22
-0
lines changed

4 files changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,26 @@ To do this:
508508

509509
1. Use a [Workbook](#workbooks) to execute q or Python code against the data in your scratchpad using the variable you provided.
510510

511+
### Reset scratchpad
512+
513+
The **Reset Scratchpad** option in kdb VS Code allows you to delete all the data from a connected instance and restart your development from scratch.
514+
515+
There are several ways to reset the scratchpad:
516+
517+
1. Right click on the appropriate connection on the left-hand side and select **Reset Scratchpad**. The connection can be either active or idle but it must be connected.
518+
519+
![Reset Scratchpad with right click on connected instance](https://github.com/KxSystems/kx-vscode/blob/main/img/reset-scratchpad-right-click.png?raw=true)
520+
521+
This displays a dialog box at the bottom right corner asking you to confirm your action.
522+
523+
![Dialog to confirm reset scratchpad](https://github.com/KxSystems/kx-vscode/blob/main/img/reset-scratchpad-dialog.png?raw=true)
524+
525+
2. Using the **Command Palette** in VSCode, start typing **Reset Scratchpad** and click on the option as it shows. This action resets the scratchpad for the active connection.
526+
527+
![Reset scratchpad using the Command Palette](https://github.com/KxSystems/kx-vscode/blob/main/img/reset-scratchpad-command-palette.png?raw=true)
528+
529+
3. Use the [MacOS or Windows shortcuts](#shortcuts) in the q file or in the workbook. Note that running the shortcuts in the q file resets the scratchpad for the active connection, while running them in the workbook resets the scratchpad for the connection chosen in the workbook.
530+
511531
## Workbooks
512532

513533
Workbooks provide a convenient way to prototype and execute q and python code against a q process and using the variables [populated into the scratchpad](#populate-scratchpad) of a **kdb Insights Enterprise** deployment by data sources.
@@ -755,6 +775,7 @@ The following setting will change double click behaviour to select the whole ide
755775
| Ctrl + Shift + D | Execute entire file |
756776
| Ctrl + Shift + R | Run q file in new q instance |
757777
| Ctrl + Shift + Y | Toggle paramater cache for lambda |
778+
| Ctrl + Shift + Delete | Reset scratchpad |
758779

759780
### For MacOS
760781

@@ -768,3 +789,4 @@ The following setting will change double click behaviour to select the whole ide
768789
| ⌘ + Shift + D | Execute entire file |
769790
| ⌘ + Shift + R | Run q file in new q instance |
770791
| ⌘ + Shift + Y | Toggle paramater cache for lambda |
792+
| ⌘ + Shift + Delete | Reset scratchpad |
14.1 KB
Loading

img/reset-scratchpad-dialog.png

10.3 KB
Loading
15.4 KB
Loading

0 commit comments

Comments
 (0)