rawsql-ts

library0.23.0jsnpmunverified

A zero-dependency SQL parser, AST analyzer, and dynamic query builder written in TypeScript. Current stable version is 0.23.0 (beta). Provides fast parsing, programmatic AST manipulation, schema validation, and SSSQL (Sound SQL) optional condition pruning. Key differentiators vs node-sql-parser: higher performance, zero dependencies, browser-ready, and built-in dynamic filtering/sorting/pagination. Released under MIT.

database

npm install rawsql-ts

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · RAWSQL-TS

rawsql-ts

databasejavascriptv0.23.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

DynamicQueryBuilder

✓ import { DynamicQueryBuilder } from 'rawsql-ts'

✗ const DynamicQueryBuilder = require('rawsql-ts').DynamicQueryBuilder; // CJS works but ESM preferred

ESM and CJS both supported. Default export is not available; all exports are named.

SelectQueryParser

✓ import { SelectQueryParser } from 'rawsql-ts'

✗ import SelectQueryParser from 'rawsql-ts'; // Wrong: no default export

Must use named import. TypeScript type definitions are included.

SqlFormatter

✓ import { SqlFormatter } from 'rawsql-ts'

Demonstrates dynamic query building with filtering, sorting, pagination, and optional condition pruning using SSSQL.

import { DynamicQueryBuilder, SqlFormatter } from 'rawsql-ts'; const baseSql = ` SELECT id, name, email, status, created_at FROM users WHERE active = true AND (:status IS NULL OR status = :status) `; const builder = new DynamicQueryBuilder(); const query = builder.buildQuery(baseSql, { filter: { status: 'premium' }, sort: { created_at: { desc: true }, name: { asc: true } }, paging: { page: 2, pageSize: 10 }, optionalConditionParameters: { status: 'premium' }, }); const formatter = new SqlFormatter(); const { formattedSql, params } = formatter.format(query); console.log(formattedSql); console.log(params);

Debug

Known issues

deprecatedAPI may change until v1.0: The library is currently in beta. Breaking changes may occur between minor versions before v1.0.

fix

Pin to a specific version (e.g., rawsql-ts@0.23.0) and review changelog before upgrading.

affects: >=0.1.0 <1.0.0

Errors

Common errors & fixes

Cannot find module 'rawsql-ts' or its corresponding type declarations.

Missing @types/rawsql-ts or incorrect import path.

fix

Types are bundled. Use 'rawsql-ts' directly. Ensure tsconfig.json includes 'node_modules/@types' or set 'moduleResolution' to 'node'.

DynamicQueryBuilder is not a constructor

Using default import instead of named import.

fix

Use `import { DynamicQueryBuilder } from 'rawsql-ts'` instead of `import DynamicQueryBuilder from 'rawsql-ts'`.

Upgrade

Version history

0.23.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/mk3008/rawsql-ts ↗

packagerawsql-ts ↗

homepagehttps://github.com/mk3008/rawsql-ts/tree/main/packages/core ↗