⚠️

@pgsql/enums
TypeScript icon, indicating that this package has built-in type declarations

17.9.2 • Public • Published

@pgsql/enums

Image

Image Image Image Image Image

@pgsql/enums is a TypeScript library providing enum definitions for PostgreSQL AST nodes, primarily used in conjunction with pgsql-parser. It offers a comprehensive and type-safe way to work with PostgreSQL enum values in query parsing and AST manipulation.

Installation

Install the package via npm:

npm install @pgsql/enums

Usage

Here's a simple example showing how to work with enums, converting between enum names and their numeric values:

import { ObjectType } from '@pgsql/enums';

// Get the numeric value of an enum
const tableValue = ObjectType.OBJECT_TABLE;
console.log(tableValue); // 41

// Convert from value back to enum name
const enumName = ObjectType[41];
console.log(enumName); // "OBJECT_TABLE"

// Use in comparisons
if (someNode.objectType === ObjectType.OBJECT_TABLE) {
  console.log("This is a table object");
}

Versions

Our latest is built with PostgreSQL 17 enum definitions.

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/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-parser for parsing and deparsing SQL queries.

Credits

🛠 Built by the Constructive team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on GitHub.

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.

Readme

Keywords

none