Merge pull request #375 from KxSystems/v1.6.0-dev-to-main

V1.6.0 dev to main

.snyk

@@ -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"

README.md

@@ -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.
 
@@ -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:
@@ -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.