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.7.0 dev to main #417

Merged
merged 3 commits into from
Aug 22, 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
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ All notable changes to the **kdb VS Code extension** are documented in this file

### Enhancements

- Now it's possible to edit existing connections
- Dialog offering to reconnect to connection that was edited (if the connection was connected)
- Added labels for connections
- Ability to connect Insights servers with self signed SSL certificate
- Now you can edit existing connections
- You can now reconnect to an edited connection (if the connection was already connected)
- Labels are now available for connections
- Now you can connect Insights servers with a self-signed SSL certificate
- Updated KDB+ process icons

### Fixes
Expand Down
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ You can refresh the meta data view at any time by choosing **Refresh meta data**

## Edit Connections

To edit an existing connection, simply right-click the connection you wish to edit and select the **Edit connection** option.
To edit an existing connection, right-click the connection you wish to edit and select the **Edit connection** option.

![Edit connection option](https://github.com/KxSystems/kx-vscode/blob/main/img/select-edit-connection.png?raw=true)

Expand All @@ -241,37 +241,37 @@ To edit an existing connection, simply right-click the connection you wish to ed

### Edit Bundle q connection

When you select to edit an **Bundled q** connection, you can edit the following properties:
When editing a **Bundled q** connection, you can edit the following properties:

| Property | Description |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Server Name | The name is already set as **local** and **cannot be edited**. |
| The connection address | This is already be set as `127.0.0.1` which corresponds to your **localhost** and **cannot be edited**. |
| Port | Set the port for the kdb server. Ensure the port used doesn't conflict with any other running q process; e.g. 5002. [Read here for more about setting a q port](https://code.kx.com/q/basics/ipc/) |
| Label Name | Select the label you want to assign the connection to |
| Property | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Server Name | The name is already set as **local** and **cannot be edited**. |
| The connection address | This is already be set as `127.0.0.1` which corresponds to your **localhost** and **cannot be edited**. |
| Port | Set the port for the kdb server. Ensure the port used doesn't conflict with any other running q process; e.g. 5002. [Read here for more about setting a q port](https://code.kx.com/q/basics/ipc/). |
| Label Name | Select the label you want to assign the connection to. |

![Edit Bundle q connection](https://github.com/KxSystems/kx-vscode/blob/main/img/edit-bundle-q-conn-form.png?raw=true)

### Edit My q connection

When you select to edit an **My q** connection, you can edit the following properties:
When editing a **My q** connection, you can edit the following properties:

| Property | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Server Name | The server name / alias. The server name selected cannot be **local** or **insights**, as these are reserved for use by [Bundled q connections](#bundled-q) and [Insights connections](#insights-connection), respectively; e.g. dev |
| The connection address | Set to the IP address of the kdb server; e.g. **localhost**. |
| Port | Enter the port used by the kdb server; e.g. 5001. Learn more about [setting a q port](https://code.kx.com/q/basics/ipc/) . |
| Edit Auth options | Check the box if you wish to change **Auth options**. If you want to **remove the Auth** for this connection, select this checkbox and leave the **Username** and **Password** fields in **blank** |
| Username | If authentication is needed, fill in the username otherwise, leave **blank** |
| Password | If authentication is needed, fill in the password otherwise, leave **blank** |
| Edit Auth options | Check the box if you wish to change **Auth options**. If you want to **remove the Auth** for this connection, select this checkbox and leave the **Username** and **Password** fields in **blank**. |
| Username | If authentication is needed, fill in the username otherwise, leave **blank**. |
| Password | If authentication is needed, fill in the password otherwise, leave **blank**. |
| Enable TLS Encryption | Check the box is TLS is enabled. Learn more [about TLS encryption](https://code.kx.com/q/kb/ssl/). |
| Label Name | Select the label you want to assign the connection to |
| Label Name | Select the label to assign the connection to. |

![Edit My q connection](https://github.com/KxSystems/kx-vscode/blob/main/img/edit-my-q-conn-form.png?raw=true)

### Edit Insights connection

When you select to edit an **Insights** connection, you can edit the following properties:
When editing a **Insights** connection, you can edit the following properties:

| Property | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
Expand All @@ -294,7 +294,7 @@ To create a Label, start by **editing** or **creating** a connection. At the **b

![Create New Label Button](https://github.com/KxSystems/kx-vscode/blob/main/img/create-new-label-btn.png?raw=true)

Clicking this button will open a **dialog** where you can enter a **Label name** and choose a **Label color** for it. You can then create the Label by clicking 'Create' or cancel the process by clicking 'Cancel.'
A dialog opens where you can enter a **Label name** and choose a **Label color**. Create the Label by clicking **Create** or cancel the process by clicking **Cancel**.

| Property | Description |
| ----------- | --------------------------------------------------------- |
Expand All @@ -319,7 +319,7 @@ Right-click the label at Connection Tree and select **Rename label**.

![Rename Label Opt](https://github.com/KxSystems/kx-vscode/blob/main/img/labels-rename-opt.png?raw=true)

A prompt will be displayed at the top of the screen with the field to edit the name of the Label.
A prompt is displayed at the top of the screen where you can edit the name of the Label.

![Rename Label](https://github.com/KxSystems/kx-vscode/blob/main/img/labels-rename.png?raw=true)

Expand All @@ -329,7 +329,7 @@ Right-click the label at Connection Tree and select **Edit label color**.

![Edit Label Color Opt](https://github.com/KxSystems/kx-vscode/blob/main/img/labels-edit-color-opt.png?raw=true)

A prompt will be displayed at the top of the screen with the field to edit the color of the Label.
A prompt is displayed at the top of the screen where you can edit the color of the Label.

![Edit Label Color](https://github.com/KxSystems/kx-vscode/blob/main/img/labels-edit-color.png?raw=true)

Expand All @@ -339,7 +339,7 @@ Right-click the label at Connection Tree and select **Delete label**.

![Delete Label Opt](https://github.com/KxSystems/kx-vscode/blob/main/img/labels-delete-opt.png?raw=true)

> The connections assign to the Label will **not be deleted**.
> Connections assigned to the Label are **not deleted**.

## kdb language server

Expand Down
Binary file modified img/bundleqform.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 modified img/edit-bundle-q-conn-form.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 modified img/edit-insights-conn-form.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 modified img/edit-my-q-conn-form.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 modified img/insightsconnection.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 modified img/myq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.