Merge pull request #434 from KxSystems/KXI-54187

Version-1.8-README

README.md

@@ -282,6 +282,34 @@ When editing a **Insights** connection, you can edit the following properties:
 
 ![Edit Insights connection](https://github.com/KxSystems/kx-vscode/blob/main/img/edit-insights-conn-form.png?raw=true)
 
+### Import/Export Connection Configuration
+
+The **Import/Export Connection** config allows you to import and export connections in JSON format from the VSCode IDE without having to create them manually.
+
+![Import Export](https://github.com/KxSystems/kx-vscode/blob/main/img/impex.png?raw=true)
+
+To import a connection:
+
+1. Open the Command Palette (Ctrl+Shift+P) and type the command to open the connection configuration for the installed database extension **OR** click the three dots (…) next to the Refresh button in the Connections window.
+2. Select **Import Connections**.
+3. Navigate to the location of the configuration file, such as a JSON file that contains the connection details, and select it.
+4. Review the imported connection for accuracy.
+5. Confirm the import.
+
+To connect to the database, select the newly imported connection from the list of available connections and initiate the connection to the database. You can run a simple query or command to verify the connection is successful.
+
+Note: If the imported connection has the same name as an existing connection, you will see a notification in the bottom right corner prompting you to either duplicate, overwrite, or cancel the import.
+
+To export a connection:
+
+1. Open the Command Palette (Ctrl+Shift+P) and type the command to manage connection configurations for the installed database extension **OR** click the three dots (…) next to the Refresh button in the Connections window.
+2. Select **Export Connections**.
+3. Choose the connection(s) you want to export.
+4. Specify the format and location for the exported configuration file. For example, JSON, YAML.
+5. Confirm the export action.
+
+To verify the export is successful navigate to the saved location and open the configuration file to check its contents.
+
 ## Connection Labels
 
 Connection Labels allow you to categorize and organize your connections by assigning them distinct names and colors, making it easier to manage and locate specific connections within the application.
@@ -427,13 +455,14 @@ To create a data source and run it against a specific connection:
 1. Ensure you have at least one folder open in VS Code.
 1. In the **DATASOURCES** view, click **+** and specify the parameters defined in the following table:
 
-   | Property                | Description                                                      |
-   | ----------------------- | ---------------------------------------------------------------- |
-   | **Connection**          | Select a Connection from the **Connection** dropdown.            |
-   | **Select API**          | Choose **getData** from the **Select API** dropdown.             |
-   | **Table**               | Choose the table you wish to query from the **Tables** dropdown. |
-   | **Start Time/End Time** | Select the **Start Time** and **End Time** for the query.        |
-   | Additional Parameters   | You can choose from the additional parameters as required.       |
+   | Property                | Description                                                                                                         |
+   | ----------------------- | ------------------------------------------------------------------------------------------------------------------- |
+   | **Connection**          | Select a Connection from the **Connection** dropdown.                                                               |
+   | **Select API**          | Choose **getData** from the **Select API** dropdown.                                                                |
+   | **Table**               | Choose the table you wish to query from the **Tables** dropdown.                                                    |
+   | **Start Time/End Time** | Select the **Start Time** and **End Time** for the query.                                                           |
+   | **Row Limit**           | Add a limit to the number of queries executed to reduce the number of Out of Memory (OOM) issues or failed queries. |
+   | Additional Parameters   | You can choose from the additional parameters as required.                                                          |
 
 1. Click **Save** to store the settings you have chosen, for reuse later. When you save a data source; query parameters and the connection details are stored. The data source icon is green if it is associated with a connection and grey if there is no association.
 
@@ -586,9 +615,20 @@ To update kdb VS Code settings, search for **kdb** from _Preferences_ > _Setting
 | **Hide subscription to newsletter after first install**        | yes/no; default no                                                  |
 | **Insights Enterprise Connections for Explorer**               | [edit JSON settings](#insights-enterprise-connections-for-explorer) |
 | **Linting**                                                    | Enable linting for q and quke files                                 |
+| **Refactoring**                                                | Choose refactoring scope                                            |
 | **QHOME directory for q runtime**                              | Display location path of q installation                             |
 | **Servers**                                                    | [edit JSON settings](#servers)                                      |
 
+### Refactoring
+
+By default, refactorings like renaming are applied to all files in the workspace. You can preview the changes before applying them and select specific files to apply the refactoring by pressing the **ctrl** or **command** key before executing the action.
+
+![Preview](https://github.com/KxSystems/kx-vscode/blob/main/img/preview.png?raw=true)
+
+If you only need to apply the refactorings to the currently opened files, you can select **Window** instead of **Workspace** for the refactoring option:
+
+![Refactoring](https://github.com/KxSystems/kx-vscode/blob/main/img/refactoring.png?raw=true)
+
 ### kdb Insights Enterprise Connections for Explorer
 
 ```JSON