https://github.com/stackql/stackqljs

StackQL client library for Deno and Node.js
https://github.com/stackql/stackqljs

Last synced: 2 months ago
JSON representation

StackQL client library for Deno and Node.js

• Host: GitHub
• URL: https://github.com/stackql/stackqljs
• Owner: stackql
• License: mit
• Created: 2023-10-30T03:00:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-07T13:20:33.000Z (about 2 years ago)
• Last Synced: 2025-02-24T01:52:14.067Z (about 1 year ago)
• Language: TypeScript
• Size: 154 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![StackQL](https://stackql.io/img/stackql-logo-bold.png)](https://stackql.io/)  




[![GitHub Actions](https://github.com/stackql/stackqljs/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/stackql/stackqljs/actions/workflows/main.yml)

![License](https://img.shields.io/github/license/stackql/stackql)

# stackqljs

[__StackQL__](https://github.com/stackql/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](https://github.com/kagis/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`](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