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

V1.6.0 dev to main #375

Merged
merged 16 commits into from
Jul 3, 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
6 changes: 6 additions & 0 deletions .snyk
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: v1.5.0
ignore:
"SNYK-JS-AGGRIDCOMMUNITY-7414157":
- "*":
reason: "Fix not published yet. When the fix is published, we'll update the package.json to use the fixed version."
expires: "2050-01-01T00:00:00.000Z"
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,7 @@ Set the following from the Advanced properties if necessary:

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

!!!note "For kdb Insights Enterprise Free Trial instances"
The realm is configured as `insights-{URL}` where {URL} is the 10 digit code in the trial URL. For example: if your trial url is https://fstc83yi5b.ft1.cld.kx.com/ the realm should be `insights-fstc83yi5b`.
**Note** For kdb Insights Enterprise Free Trial instances the realm is configured as `insights-{URL}` where {URL} is the 10 digit code in the trial URL. For example: if your trial url is https://fstc83yi5b.ft1.cld.kx.com/ the realm should be `insights-fstc83yi5b`.

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

Expand All @@ -211,10 +210,22 @@ The realm is configured as `insights-{URL}` where {URL} is the 10 digit code in

If you close the extension, the connection also closes.

Once connected, go to [execute code](#execute-code).

[//]: # "In what context is the reserved alias name `insights` used? - BMA - the context is used on build the connection tree; different icon; different connection process. - DF - Is this connection process currently supported in kdb VS Code extension; if so, do we need to document it here?"

#### Meta

When connected **Insights** connections can be expanded to show the details returned by the [getMeta API](https://code.kx.com/draft/insights/api/database/query/get-meta.html) call, which provides information on the database schemas and all the analytics available.

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

To see the results of the getMeta call click on the 'meta' node under the connection. A json representation of the details returned by the call are displayed with **"[Connection Name] - meta"** as title of the tab.

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

The 'meta' node contains a child node for each of the child sections in the json. To see a json representation of a specific section click on the child node. The json representation of this section returned by the call is displayed with **"[Connection Name] - [CHILD SECTION]"** as title of the tab.

You can refresh the meta data view at any time by choosing **Refresh meta data** from the right-click menu of an Insights connection.

## kdb language server

A kdb language server is bundled with the kdb VS Code extension. It offers various common features to aid in the development of kdb code, including:
Expand Down Expand Up @@ -343,16 +354,6 @@ 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
Binary file modified img/managedqprocess.jpg
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 img/repl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading