libpg-query

# libpg-query <img src="https://github.com/launchql/libpg-query-node/assets/545047/5fd420cc-cdc6-4211-9b0f-0eca8321ba72" alt="hyperweb.io" 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?filename=versions%2F17%2Fpackage.json"/></a> <a href="https://github.com/launchql/libpg-query-node/actions/workflows/ci.yml"><img height="20" src="https://github.com/launchql/libpg-query-node/actions/workflows/ci.yml/badge.svg" /></a> <a href="https://github.com/launchql/libpg-query-node/actions/workflows/ci.yml"><img height="20" src="https://img.shields.io/badge/macOS-available-333333?logo=apple&logoColor=white" /></a> <a href="https://github.com/launchql/libpg-query-node/actions/workflows/ci.yml"><img height="20" src="https://img.shields.io/badge/Windows-available-333333?logo=windows&logoColor=white" /></a> <a href="https://github.com/launchql/libpg-query-node/actions/workflows/ci.yml"><img height="20" src="https://img.shields.io/badge/Linux-available-333333?logo=linux&logoColor=white" /></a> # The Real PostgreSQL Parser for JavaScript ### Bring the power of PostgreSQL’s native parser to your JavaScript projects — no native builds, no platform headaches. This is the official PostgreSQL parser, compiled to WebAssembly (WASM) for seamless, cross-platform compatibility. Use it in Node.js or the browser, on Linux, Windows, or anywhere JavaScript runs. Built to power [pgsql-parser](https://github.com/pyramation/pgsql-parser), this library delivers full fidelity with the Postgres C codebase — no rewrites, no shortcuts. ### Features * 🔧 **Powered by PostgreSQL** – Uses the official Postgres C parser compiled to WebAssembly * 🖥️ **Cross-Platform** – Runs smoothly on macOS, Linux, and Windows * 🌐 **Node.js & Browser Support** – Consistent behavior in any JS environment * 📦 **No Native Builds Required** – No compilation, no system-specific dependencies * 🧠 **Spec-Accurate Parsing** – Produces faithful, standards-compliant ASTs * 🚀 **Production-Grade** – Millions of downloads and trusted by countless projects and top teams ## 🚀 For Round-trip Codegen > 🎯 **Want to parse + deparse (full round trip)?** > We highly recommend using [`pgsql-parser`](https://github.com/launchql/pgsql-parser) which leverages a pure TypeScript deparser that has been battle-tested against 23,000+ SQL statements and is built on top of libpg-query. ## Installation ```sh npm install libpg-query ``` ## Example ```typescript import { parse } from 'libpg-query'; const result = await parse('SELECT * FROM users WHERE active = true'); // {"version":170004,"stmts":[{"stmt":{"SelectStmt":{"targetList":[{"ResTarget" ... "op":"SETOP_NONE"}}}]} ``` ## Versions Our latest is built with `17-latest` branch from libpg_query | PG Major Version | libpg_query | npm dist-tag |--------------------------|-------------|---------| | 17 | 17-6.1.0 | [`pg17`](https://www.npmjs.com/package/libpg-query/v/latest) | 16 | 16-5.2.0 | [`pg16`](https://www.npmjs.com/package/libpg-query/v/pg16) | 15 | 15-4.2.4 | [`pg15`](https://www.npmjs.com/package/libpg-query/v/pg15) | 14 | 14-3.0.0 | [`pg14`](https://www.npmjs.com/package/libpg-query/v/pg14) | 13 | 13-2.2.0 | [`pg13`](https://www.npmjs.com/package/libpg-query/v/pg13) ## Usage ### `parse(query: string): Promise<ParseResult>` Parses the SQL and returns a Promise for the parse tree. May reject with a parse error. ```typescript import { parse } from 'libpg-query'; const result = await parse('SELECT * FROM users WHERE active = true'); // Returns: ParseResult - parsed query object ``` ### `parseSync(query: string): ParseResult` Synchronous version that returns the parse tree directly. May throw a parse error. ```typescript import { parseSync } from 'libpg-query'; const result = parseSync('SELECT * FROM users WHERE active = true'); // Returns: ParseResult - parsed query object ``` ⚠ **Note:** If you need additional functionality like `fingerprint`, `scan`, `deparse`, or `normalize`, check out the full package (`@libpg-query/parser`) in the [./full](https://github.com/launchql/libpg-query-node/tree/main/full) folder of the repo. ### Initialization The library provides both async and sync methods. Async methods handle initialization automatically, while sync methods require explicit initialization. #### Async Methods (Recommended) Async methods handle initialization automatically and are always safe to use: ```typescript import { parse } from 'libpg-query'; // These handle initialization automatically const result = await parse('SELECT * FROM users'); ``` #### Sync Methods Sync methods require explicit initialization using `loadModule()`: ```typescript import { loadModule, parseSync } from 'libpg-query'; // Initialize first await loadModule(); // Now safe to use sync methods const result = parseSync('SELECT * FROM users'); ``` ### `loadModule(): Promise<void>` Explicitly initializes the WASM module. Required before using any sync methods. ```typescript import { loadModule, parseSync } from 'libpg-query'; // Initialize before using sync methods await loadModule(); const result = parseSync('SELECT * FROM users'); ``` Note: We recommend using async methods as they handle initialization automatically. Use sync methods only when necessary, and always call `loadModule()` first. ### Type Definitions ```typescript interface ParseResult { version: number; stmts: Statement[]; } interface Statement { stmt_type: string; stmt_len: number; stmt_location: number; query: string; } ``` **Note:** The return value is an array, as multiple queries may be provided in a single string (semicolon-delimited, as PostgreSQL expects). ## Build Instructions This package uses a **WASM-only build system** for true cross-platform compatibility without native compilation dependencies. ### Prerequisites - Node.js (version 16 or higher recommended) - [pnpm](https://pnpm.io/) (v8+ recommended) ### Building WASM Artifacts 1. **Install dependencies:** ```bash pnpm install ``` 2. **Build WASM artifacts:** ```bash pnpm run build ``` 3. **Clean WASM build (if needed):** ```bash pnpm run clean ``` 4. **Rebuild WASM artifacts from scratch:** ```bash pnpm run clean && pnpm run build ``` ### Build Process Details The WASM build process: - Uses Emscripten SDK for compilation - Compiles C wrapper code to WebAssembly - Generates `wasm/libpg-query.js` and `wasm/libpg-query.wasm` files - No native compilation or node-gyp dependencies required ## Testing ### Running Tests ```bash pnpm run test ``` ### Test Requirements - WASM artifacts must be built before running tests - If tests fail with "fetch failed" errors, rebuild WASM artifacts: ```bash pnpm run clean && pnpm run build && pnpm run test ``` ## Troubleshooting ### Common Issues **"fetch failed" errors during tests:** - This indicates stale or missing WASM artifacts - Solution: `pnpm run clean && pnpm run build` **"WASM module not initialized" errors:** - Ensure you call an async method first to initialize the WASM module - Or use the async versions of methods which handle initialization automatically **Build environment issues:** - Ensure Emscripten SDK is properly installed and configured - Check that all required build dependencies are available ### Build Artifacts The build process generates these files: - `wasm/libpg-query.js` - Emscripten-generated JavaScript loader - `wasm/libpg-query.wasm` - WebAssembly binary - `wasm/index.js` - ES module exports - `wasm/index.cjs` - CommonJS exports with sync wrappers ## Credits Built on the excellent work of several contributors: * **[Dan Lynch](https://github.com/pyramation)** — official maintainer since 2018 and architect of the current implementation * **[Lukas Fittl](https://github.com/lfittl)** for [libpg_query](https://github.com/pganalyze/libpg_query) — the core PostgreSQL parser that powers this project * **[Greg Richardson](https://github.com/gregnr)** for AST guidance and pushing the transition to WASM and multiple PG runtimes for better interoperability * **[Ethan Resnick](https://github.com/ethanresnick)** for the original Node.js N-API bindings * **[Zac McCormick](https://github.com/zhm)** for the foundational [node-pg-query-native](https://github.com/zhm/node-pg-query-native) parser ## Related * [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): The real PostgreSQL parser for Node.js, providing symmetric parsing and deparsing of SQL statements with actual PostgreSQL parser integration. * [pgsql-deparser](https://www.npmjs.com/package/pgsql-deparser): A streamlined tool designed for converting PostgreSQL ASTs back into SQL queries, focusing solely on deparser functionality to complement `pgsql-parser`. * [@pgsql/parser](https://www.npmjs.com/package/@pgsql/parser): Multi-version PostgreSQL parser with dynamic version selection at runtime, supporting PostgreSQL 15, 16, and 17 in a single package. * [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): Offers TypeScript type definitions for PostgreSQL AST nodes, facilitating type-safe construction, analysis, and manipulation of ASTs. * [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): Provides TypeScript enum definitions for PostgreSQL constants, enabling type-safe usage of PostgreSQL enums and constants in your applications. * [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): A comprehensive utility library for PostgreSQL, offering type-safe AST node creation and enum value conversions, simplifying the construction and manipulation of PostgreSQL ASTs. * [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): A TypeScript tool that parses PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums. * [libpg-query](https://github.com/launchql/libpg-query-node): The real PostgreSQL parser exposed for Node.js, used primarily in `pgsql-parser` for parsing and deparsing SQL queries. ## Disclaimer AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND. No developer or entity involved in creating Software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the Software code or Software CLI, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.