Home

Awesome

libpg-query

<p align="center" width="100%"> <img src="https://github.com/launchql/libpg-query-node/assets/545047/5fd420cc-cdc6-4211-9b0f-0eca8321ba72" alt="webincubator" width="100"> </p> <p align="center" width="100%"> <a href="https://www.npmjs.com/package/libpg-query"><img height="20" src="https://img.shields.io/npm/dt/libpg-query"></a> <a href="https://www.npmjs.com/package/libpg-query"><img height="20" src="https://img.shields.io/npm/dw/libpg-query"/></a> <a href="https://github.com/launchql/libpg-query/blob/main/LICENSE-MIT"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a> <a href="https://www.npmjs.com/package/libpg-query"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/libpg-query-node"/></a><br /> <a href="https://github.com/launchql/libpg-query-node/actions/workflows/run-tests-linux.yml"> <img height="20" src="https://github.com/launchql/libpg-query-node/actions/workflows/run-tests-linux.yml/badge.svg" /> </a> <a href="https://github.com/launchql/libpg-query-node/actions/workflows/run-tests-mac.yml"> <img height="20" src="https://github.com/launchql/libpg-query-node/actions/workflows/run-tests-mac.yml/badge.svg" /> </a> <a href="https://github.com/launchql/libpg-query-node/actions/workflows/run-tests-win.yml"> <img height="20" src="https://github.com/launchql/libpg-query-node/actions/workflows/run-tests-win.yml/badge.svg" /> </a> </p>

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 Versionlibpg_queryBranchnpm
1616-latest16-latestlibpg-query@16.2.0
1515-latest15-latestlibpg-query@15.1.0
1414-latest14-latestlibpg-query@14.0.0
1313-latest13-latestlibpg-query@13.3.1
12(n/a)
11(n/a)
1010-latest@1.3.1 (tree)

Building a binary distribution

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