@gregnr/libpg-query
TypeScript icon, indicating that this package has built-in type declarations

15.0.3-wasm • Public • Published

libpg-query

webincubator

The real PostgreSQL parser, exposed for nodejs.

Primarily used for the node.js parser and deparser pgsql-parser

Table of Contents

  1. Installation
  2. Example
  3. Documentation
  4. Versions
  5. Building a binary distribution
  6. Related Projects
  7. Credit

Installation

npm install libpg-query

Example

const parser = require('libpg-query');
parser.parseQuery('select 1').then(console.log);

Documentation

query.parseQuery(sql)/parseQuerySync

Parses the sql and returns a Promise for the parse tree (or returns the parse tree directly in the sync version). May reject with/throw a parse error.

The return value is an array, as multiple queries may be provided in a single string (semicolon-delimited, as Postgres expects).

query.parsePlPgSQL(funcsSql)/query.parsePlPgSQLSync(funcsSql)

Parses the contents of a PL/PGSql function, from a CREATE FUNCTION declaration, and returns a Promise for the parse tree (or returns the parse tree directly in the sync version). May reject with/throw a parse error.

Versions

Our latest is built with 16-latest branch from libpg_query

PG Major Version libpg_query Branch npm
16 16-latest 16-latest libpg-query@16.0.0
15 15-latest 15-latest libpg-query@15.0.3
14 14-latest 14-latest libpg-query@14.0.0
13 13-latest 13-latest libpg-query@13.3.1
12 (n/a)
11 (n/a)
10 10-latest @1.3.1 (tree)

Building a binary distribution

  • Install requirements (npm i)
  • npx node-pre-gyp rebuild package
  • With appropriate AWS credentials configured, npx node-pre-gyp publish

Or you can run the scripts

npm run binary:build
npm run binary:publish

Related Projects

Credit

This is based on the output of libpg_query. This wraps the static library output and links it into a node module for use in js.

All credit for the hard problems goes to Lukas Fittl.

Additional thanks for node binding Ethan Resnick.

Original Code and License

Package Sidebar

Install

npm i @gregnr/libpg-query

Weekly Downloads

467

Version

15.0.3-wasm

License

LICENSE IN LICENSE

Unpacked Size

31.3 MB

Total Files

566

Last publish

Collaborators

  • gregnr