prql-js

JavaScript bindings for prql-compiler. Check out https://prql-lang.org for more context.

This uses wasm-pack to generate bindings[^1].

[^1]: though we would be very open to other approaches, and used trunk successfully in a rust-driven approach to this, RIP prql-web.

Installation

To install the currently published version:

npm install prql-js

This package is built to target a bundler (i.e. webpack). To use it with Node.js or import it directly in a browser as an ES module, build it using a suitable --target.

Usage

import compile from "prql-js";

const { sql, error } = compile(`from employees | select first_name`);
console.log(sql);

Prints:

SELECT
  first_name
FROM
  employees

For more information about the language, see reference book.

Development

Build:

wasm-pack build

This builds a node package in the pkg path. An example of including that as a dependency is in playground.

Test:

wasm-pack test --firefox