@gregnr/libpg-query
v15.2.0-rc.deparse.3TypeScript
The real PostgreSQL query parser
0/weekUpdated 1 years agoLICENSE IN LICENSEUnpacked: 35.9 MB
Published by Dan Lynch
npm install @gregnr/libpg-querylibpg-query
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
5. Documentation
3. Versions
4. Building a binary distribution
6. Related Projects
7. Credit
Installation
``sh`
npm install libpg-query
Example
`js`
const parser = require('libpg-query');
parser.parseQuery('select 1').then(console.log);
$3
$3
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).
$3
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.2.0
| 15 | 15-latest | 15-latest | libpg-query@15.1.0
| 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,
Or you can run the scripts
`
npm run binary:build
npm run binary:publish
Related Projects
* libpg_query
* pgsql-parser
* pg_query
* pg_query.go
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.