Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@pgsql/types
Advanced tools
@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.
Install the package via npm:
npm install @pgsql/types
@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:
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);
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);
pgsql-parser
.pgsql-parser
pgsql-parser
for 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.
FAQs
PostgreSQL AST types for pgsql-parser
The npm package @pgsql/types receives a total of 11,361 weekly downloads. As such, @pgsql/types popularity was classified as popular.
We found that @pgsql/types demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new license scanner with an improved suite of features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.