You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
# stackqljs
7
7
8
-
[__StackQL__](https://github.com/stackql/stackql) client library for Deno and Node.js that exposes all features StackQL.
8
+
[**StackQL**](https://github.com/stackql/stackql) client library for Deno and Node.js that exposes all features StackQL.
9
9
10
10
## Requirements
11
11
@@ -14,15 +14,18 @@
14
14
- No dependencies
15
15
- Works in server mode (as a pg wire protocol server client) as well as local mode where it is a wrapper for the `stackql` binary for the target platform
16
16
- Exposes methods analagous to [`pystackql`](https://pystackql.readthedocs.io/en/latest/), including:
17
-
-`connect` - connect to a StackQL server - if in server mode
18
-
-`upgrade` - if in local mode, upgrade the local stackql binary from the latest release
19
-
-`execute` - execute a query returns an array of rows (objects)
20
-
-`executeStmt` - executes a statement and returns a string (like `REGISTRY PULL` or `INSERT ...`)
21
-
-`executeQueriesAsync` - executes a list of queries and returns an array of rows (objects) - queries need to return the same columns/schema
17
+
-`connect` - connect to a StackQL server - if in server mode
18
+
-`upgrade` - if in local mode, upgrade the local stackql binary from the latest release
19
+
-`execute` - execute a query returns an array of rows (objects)
20
+
-`executeStmt` - executes a statement and returns a string (like `REGISTRY PULL` or `INSERT ...`)
21
+
-`executeQueriesAsync` - executes a list of queries and returns an array of rows (objects) - queries need to return the same columns/schema
22
22
23
23
## Test
24
+
24
25
### Requirement
26
+
25
27
- To run the tests locally, [install StackQL](https://stackql.io/docs/installing-stackql) first.
28
+
29
+
```
30
+
deno task test <optional: test file path>
26
31
```
27
-
deno test --allow-net --allow-read --allow-write --allow-env --allow-run <test file path>
0 commit comments