transform

@pgsql/transform

@pgsql/transform is a TypeScript library for transforming PostgreSQL ASTs between different PostgreSQL versions. It serves as a crucial component for building a single source of truth deparser that can handle SQL from multiple PostgreSQL versions while maintaining backward compatibility.

Transforming ASTs Between PG Versions

The transform package enables you to:

• Transform legacy ASTs: Convert ASTs from PostgreSQL versions 13-16 to version 17
• Build unified deparsers: Create a single deparser pipeline that works with multiple PostgreSQL versions
• Maintain backward compatibility: Support legacy codebases while leveraging the latest PostgreSQL features

Key Limitation

This package only supports ASTs derived from SQL that is parseable by PostgreSQL 17. This means:

• ✅ Supported: SQL from PG13-16 that remains valid in PG17
• ❌ Not supported: Deprecated syntax from older versions that was removed
• ❌ Not supported: SQL that cannot be parsed by the PG17 parser

This design ensures all transformed ASTs can be reliably deparsed using the latest PostgreSQL grammar.

Installation

npm install @pgsql/transform

🚀 Quick Start

Multi-Version Transformer

import{ASTTransformer}from'@pgsql/transform';consttransformer=newASTTransformer();// Transform any version to PG17constpg17Ast=transformer.transformToLatest(pg13Ast,13);// Transform between specific versionsconstpg15Ast=transformer.transform(pg13Ast,13,15);// Convenience methodsconstresult=transformer.transform13To17(pg13Ast);

Direct Transformers

For better performance when you know source and target versions:

import{PG13ToPG17Transformer}from'@pgsql/transform';consttransformer=newPG13ToPG17Transformer();constpg17Ast=transformer.transform(pg13Ast);

Integration Example

import{parse}from'@pgsql/parser';import{deparse}from'pgsql-deparser';import{PG13ToPG17Transformer}from'@pgsql/transform';// Parse with older versionconstpg13Ast=awaitparse('SELECT * FROM users',{version: 13});// Transform to latestconsttransformer=newPG13ToPG17Transformer();constpg17Ast=transformer.transform(pg13Ast);// Deparse with latest grammarconstsql=awaitdeparse(pg17Ast);

🔄 Transformation Chain

Incremental: PG13 → PG14 → PG15 → PG16 → PG17

• Step-by-step version upgrades
• Useful for debugging transformation issues

Direct: PG13 → PG17, PG14 → PG17, etc.

• Single-step transformations
• Optimized for performance

📋 Supported Transformations

From	To	Transformer
PG13	PG14, PG15, PG16, PG17	V13ToV14Transformer, PG13ToPG17Transformer
PG14	PG15, PG16, PG17	V14ToV15Transformer, PG14ToPG17Transformer
PG15	PG16, PG17	V15ToV16Transformer, PG15ToPG17Transformer
PG16	PG17	V16ToV17Transformer, PG16ToPG17Transformer

🏗️ Architecture

The transform package fits into the broader pgsql-parser ecosystem:

1. Parse legacy SQL with version-specific parsers
2. Transform ASTs to the latest version
3. Deparse using the unified, latest-version deparser

This enables a single source of truth for SQL generation while supporting legacy codebases.

Related

• pgsql-parser: The real PostgreSQL parser for Node.js, providing symmetric parsing and deparsing of SQL statements with actual PostgreSQL parser integration.
• 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: Multi-version PostgreSQL parser with dynamic version selection at runtime, supporting PostgreSQL 15, 16, and 17 in a single package.
• @pgsql/types: Offers TypeScript type definitions for PostgreSQL AST nodes, facilitating type-safe construction, analysis, and manipulation of ASTs.
• @pgsql/enums: Provides TypeScript enum definitions for PostgreSQL constants, enabling type-safe usage of PostgreSQL enums and constants in your applications.
• @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.
• @pgsql/traverse: PostgreSQL AST traversal utilities for pgsql-parser, providing a visitor pattern for traversing PostgreSQL Abstract Syntax Tree nodes, similar to Babel's traverse functionality but specifically designed for PostgreSQL AST structures.
• 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: 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.