Skip to content

Commit 75caa82

Browse files
committed
README is now useful
1 parent 33aff1f commit 75caa82

File tree

3 files changed

+31
-12
lines changed

3 files changed

+31
-12
lines changed

README.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,39 @@
11
# SQLTools intersystems-iris-driver Driver
22

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
410

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
1012

11-
## Creating connectino schema for the assistant
13+
- Click the SQLTools icon in the Activity pane (left side of VS Code)
14+
![SQLTools icon in Activity pane](docs/assets/img/activitybar.png)
15+
- Click "Add new connection"
16+
![Add connection button](docs/assets/img/addconnection.png)
17+
- Click InterSystems IRIS
18+
- Fill out connection information
19+
- Test the connection
1220

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
1522

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.
1724

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)
1933

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"

docs/assets/img/activitybar.png

4.78 KB
Loading

docs/assets/img/addconnection.png

14.6 KB
Loading

0 commit comments

Comments
 (0)