@pgsql/types

@pgsql/types

@pgsql/types is a TypeScript library providing type definitions for PostgreSQL AST nodes, primarily used in conjunction with pgsql-parser. It offers a comprehensive and type-safe way to interact with the AST nodes generated by PostgreSQL query parsing.

Installation

Install the package via npm:

npm install @pgsql/types

Usage

@pgsql/types provides TypeScript type definitions for PostgreSQL Abstract Syntax Tree (AST) nodes. These types are useful for constructing, analyzing, or manipulating ASTs in a type-safe manner.

Here are a few examples of how you can use these types in your TypeScript projects:

Validating AST Nodes

You can use the types to validate AST nodes, ensuring they conform to the expected structure:

import { CreateStmt } from '@pgsql/types';

function validateCreateStmt(stmt: CreateStmt) {
  if (!stmt.relation || !stmt.tableElts) {
    throw new Error('Invalid CreateStmt: missing required fields');
  }
  // Add more validation logic as needed
  console.log('CreateStmt is valid');
}

// Example usage
validateCreateStmt(createStmtObject);

Constructing AST Nodes

Types help ensure that you construct AST nodes correctly:

import { CreateStmt, ColumnDef, Constraint } from '@pgsql/types';

const newColumn: ColumnDef = {
  colname: 'id',
  typeName: { names: [{ String: { str: 'int4' } }] },
  constraints: [{ Constraint: { contype: 'CONSTR_PRIMARY' } }],
};

const createStmt: CreateStmt = {
  relation: { relname: 'new_table' },
  tableElts: [newColumn],
};

console.log(createStmt);

Versions

Our latest is built with PostgreSQL 17 AST types.

PG Major Version	libpg_query	npm dist-tag
17	17-6.1.0	pg17
16	16-5.2.0	pg16
15	15-4.2.4	pg15
14	14-3.0.0	pg14
13	13-2.2.0	pg13

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/types: Offers TypeScript type definitions for PostgreSQL AST nodes, facilitating type-safe construction, analysis, and manipulation of ASTs.
• @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: 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.