Skip to content

Commit

Permalink
Merge pull request #355 from KxSystems/KXI-35500
Browse files Browse the repository at this point in the history
Docs change for Meta and Logs
  • Loading branch information
Philip-Carneiro-KX authored Jun 12, 2024
2 parents d73c231 + db07019 commit bdcc402
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ All notable changes to the **kdb VS Code extension** are documented in this file
### Enhancements

- Display meta data for Insights connections
- Added option to click at meta data and open in json format the meta data
- Improve the console log quality to "kdb"output pane
- Insights free trial instances are supported
- Added execute block command for q code
- Added hotkey to cache function parameters for q code
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,16 @@ To do this:

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

## Meta

The Get Meta data is exposed for **connected Insights** connections.

![Insights Meta Tree](https://github.com/KxSystems/kx-vscode/blob/main/img/insights-meta-tree.png?raw=true)

To open the meta object, just click on it, and a json with the **"[Connection Name] - [META OBJECT]"** as title

![Insights Meta JSON](https://github.com/KxSystems/kx-vscode/blob/main/img/insights-meta-json.png?raw=true)

## Workbooks

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.
Expand Down Expand Up @@ -429,6 +439,16 @@ q REPL can be started from the command prompt by searching **q REPL**.

![REPL](https://github.com/KxSystems/kx-vscode/blob/main/img/repl.png?raw=true)

## Logs

Any error or info will be posted at **OUTPUT** in **kdb** tab

![LOG](https://github.com/KxSystems/kx-vscode/blob/main/img/log-sample.png?raw=true)

The format will be:

`[DATE TIME] [INFO or ERROR] Message`

## Settings

To update kdb VS Code settings, search for **kdb** from _Preferences_ > _Settings_, or right-click the settings icon in kdb VS Code marketplace panel and choose **Extension Settings**.
Expand Down
Binary file added img/insights-meta-json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/insights-meta-tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/log-sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bdcc402

Please sign in to comment.