@pgql/parse
v13.0.0
Published
The real PostgreSQL query parser
Downloads
42
Maintainers
Readme
@pgql/parse
The real PostgreSQL parser, exposed for nodejs.
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.
Requirements
Install node-gyp globally
npm install node-gyp -g
Installation
npm install @pgql/parse
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.
Example
const parser = require('@pgql/parse');
parser.parseQuery('select 1').then(console.log);