|
1 | 1 | # SQLTools intersystems-iris-driver Driver
|
2 | 2 |
|
3 |
| -## Creating icon |
| 3 | +## Installation |
| 4 | +- [Install SQLTools in VS Code from the Marketplace](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) |
| 5 | +- Install the InterSystems extension to SQLTools (pre-release version) |
| 6 | + - [Go to the GitHub releases page](https://github.com/intersystems-community/sqltools-intersystems-driver/releases) |
| 7 | + - Expand Assets triangle for the latest version |
| 8 | + - Download the file ending in `.vsix` |
| 9 | + - Drag the downloaded file onto VS Code |
4 | 10 |
|
5 |
| -PNG Images |
6 |
| -Size: 64x64px |
7 |
| -Default Icon: Opacity 100%, no margins and paddings |
8 |
| -Active icon: Opacity 100%, no margins and paddings, green (#00FF00) circle 24x24 bottom right |
9 |
| -Inactive icon: Opacity 50%, no margins and paddings |
| 11 | +## Configuration |
10 | 12 |
|
11 |
| -## Creating connectino schema for the assistant |
| 13 | +- Click the SQLTools icon in the Activity pane (left side of VS Code) |
| 14 | +  |
| 15 | +- Click "Add new connection" |
| 16 | +  |
| 17 | +- Click InterSystems IRIS |
| 18 | +- Fill out connection information |
| 19 | +- Test the connection |
12 | 20 |
|
13 |
| -We are using `@rjsf/core` to render the forms, so in order to add you driver to the connection assistant, |
14 |
| -edit `connection.schema.json` and `ui.schema.json`. |
| 21 | +## Use |
15 | 22 |
|
16 |
| -See https://react-jsonschema-form.readthedocs.io/en/latest/ for more instructions. |
| 23 | +With a connection defined, you can now write SQL, browse tables, etc. |
17 | 24 |
|
18 |
| -## Publish the driver |
| 25 | +### To write raw SQL |
| 26 | +- Click the "New SQL file" icon |
| 27 | +- Write your SQL statement |
| 28 | +- Click "Run on active connection" |
| 29 | +- Or, select the SQL statement text, and execute it |
| 30 | + - either right-click and select "Run selected query" from the contentual menu |
| 31 | + - or type Command-E, Command-E (Mac) |
| 32 | + - or type Ctrl-E, Ctrl-E (Windows) |
19 | 33 |
|
20 |
| -See https://code.visualstudio.com/api/working-with-extensions/publishing-extension |
| 34 | +### To browse tables |
| 35 | + |
| 36 | +- Click on your connection |
| 37 | +- Click on "Tables" |
| 38 | +- Right-click on the table of interest |
| 39 | +- From the contextual menu, select "Show table records" |
0 commit comments