Skip to content
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
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# stackqljs

[__StackQL__](https://github.com/stackql/stackql) client library for Deno and Node.js that exposes all features StackQL.
[**StackQL**](https://github.com/stackql/stackql) client library for Deno and Node.js that exposes all features StackQL.

## Requirements

Expand All @@ -14,15 +14,18 @@
- No dependencies
- 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
- Exposes methods analagous to [`pystackql`](https://pystackql.readthedocs.io/en/latest/), including:
- `connect` - connect to a StackQL server - if in server mode
- `upgrade` - if in local mode, upgrade the local stackql binary from the latest release
- `execute` - execute a query returns an array of rows (objects)
- `executeStmt` - executes a statement and returns a string (like `REGISTRY PULL` or `INSERT ...`)
- `executeQueriesAsync` - executes a list of queries and returns an array of rows (objects) - queries need to return the same columns/schema
- `connect` - connect to a StackQL server - if in server mode
- `upgrade` - if in local mode, upgrade the local stackql binary from the latest release
- `execute` - execute a query returns an array of rows (objects)
- `executeStmt` - executes a statement and returns a string (like `REGISTRY PULL` or `INSERT ...`)
- `executeQueriesAsync` - executes a list of queries and returns an array of rows (objects) - queries need to return the same columns/schema

## Test

### Requirement

- To run the tests locally, [install StackQL](https://stackql.io/docs/installing-stackql) first.

```
deno task test <optional: test file path>
```
deno test --allow-net --allow-read --allow-write --allow-env --allow-run <test file path>
```
5 changes: 5 additions & 0 deletions deno.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"tasks": {
"test": "deno test --allow-net --allow-read --allow-write --allow-env --allow-run"
}
}
Loading