stackqljs
StackQL client library for Deno and Node.js that exposes all features StackQL.
Requirements
- Written in TypeScript
- Usable in Deno and Node.js (see pgwire for an example of a dual purpose package)
- 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
, 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 (likeREGISTRY PULL
orINSERT ...
) -
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 first.
deno task test <optional: test file path>
NPM Support
- run
deno run -A scripts/npm-build.ts