@pgsql/utils is a companion utility library for @pgsql/types, offering convenient functions to work with PostgreSQL Abstract Syntax Tree (AST) nodes and enums in a type-safe manner. This library facilitates the creation of AST nodes and simplifies the process of converting between enum names and their respective integer values, as defined in the PostgreSQL parser output.
- AST Node Creation: Simplifies the process of constructing PostgreSQL AST nodes, allowing for easy assembly of SQL queries or statements programmatically.
- Type-safe Enum Conversion: Convert between string and integer representations of PostgreSQL AST enum values.
- Comprehensive Coverage: Supports all enum types and node types defined in the PostgreSQL AST.
-
Seamless Integration: Designed to be used alongside the
@pgsql/typespackage for a complete AST handling solution.
To add @pgsql/utils to your project, use the following npm command:
npm install @pgsql/utils
With the AST helper methods, creating complex SQL ASTs becomes straightforward and intuitive.
Explore the PostgreSQL Abstract Syntax Tree (AST) as JSON objects with ease using @pgsql/utils. Below is an example of how you can generate a JSON AST using TypeScript:
import * as t from '@pgsql/utils';
import { SelectStmt } from '@pgsql/types';
import { deparse } from 'pgsql-deparser';
const selectStmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
targetList: [
t.nodes.resTarget({
val: t.nodes.columnRef({
fields: [t.nodes.aStar()]
})
})
],
fromClause: [
t.nodes.rangeVar({
relname: 'some_amazing_table',
inh: true,
relpersistence: 'p'
})
],
limitOption: 'LIMIT_OPTION_DEFAULT',
op: 'SETOP_NONE'
});
console.log(selectStmt);
// Output: { "SelectStmt": { "targetList": [ { "ResTarget": { "val": { "ColumnRef": { "fields": [ { "A_Star": {} } ] } } } } ], "fromClause": [ { "RangeVar": { "relname": "some_amazing_table", "inh": true, "relpersistence": "p" } } ], "limitOption": "LIMIT_OPTION_DEFAULT", "op": "SETOP_NONE" } }
console.log(await deparse(stmt))
// Output: SELECT * FROM some_amazing_table
import * as t from '@pgsql/utils';
import { SelectStmt } from '@pgsql/types';
import { deparse } from 'pgsql-deparser';
const query: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
targetList: [
t.nodes.resTarget({
val: t.nodes.columnRef({
fields: [t.nodes.string({ sval: 'name' })]
})
}),
t.nodes.resTarget({
val: t.nodes.columnRef({
fields: [t.nodes.string({ sval: 'email' })]
})
})
],
fromClause: [
t.nodes.rangeVar({
relname: 'users',
inh: true,
relpersistence: 'p'
})
],
whereClause: t.nodes.aExpr({
kind: 'AEXPR_OP',
name: [t.nodes.string({ sval: '>' })],
lexpr: t.nodes.columnRef({
fields: [t.nodes.string({ sval: 'age' })]
}),
rexpr: t.nodes.aConst({
ival: t.ast.integer({ ival: 18 })
})
}),
limitOption: 'LIMIT_OPTION_DEFAULT',
op: 'SETOP_NONE'
});
await deparse(createStmt);
// SELECT name, email FROM users WHERE age > 18
// Example JSON schema
const schema = {
"tableName": "users",
"columns": [
{ "name": "id", "type": "int", "constraints": ["PRIMARY KEY"] },
{ "name": "username", "type": "text" },
{ "name": "email", "type": "text", "constraints": ["UNIQUE"] },
{ "name": "created_at", "type": "timestamp", "constraints": ["NOT NULL"] }
]
};
// Construct the CREATE TABLE statement
const createStmt = t.nodes.createStmt({
relation: t.ast.rangeVar({
relname: schema.tableName,
inh: true,
relpersistence: 'p'
}),
tableElts: schema.columns.map(column => t.nodes.columnDef({
colname: column.name,
typeName: t.ast.typeName({
names: [t.nodes.string({ sval: column.type })]
}),
constraints: column.constraints?.map(constraint =>
t.nodes.constraint({
contype: constraint === "PRIMARY KEY" ? "CONSTR_PRIMARY" : constraint === "UNIQUE" ? "CONSTR_UNIQUE" : "CONSTR_NOTNULL"
})
)
}))
});
// `deparse` function converts AST to SQL string
const sql = await deparse(createStmt, { pretty: true });
console.log(sql);
// OUTPUT:
// CREATE TABLE users (
// id int PRIMARY KEY,
// username text,
// email text UNIQUE,
// created_at timestamp NOT NULL
// )
- 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.
- 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-parserfor parsing and deparsing SQL queries.
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.