@guanmingchiu/sqlparser-ts

中文文档
0.63.0发布于 2026/10/16Apache-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 57.5万

A SQL parser for JavaScript and TypeScript, powered by datafusion-sqlparser-rs via WASM

原始使用文档
文档目录10 节
  1. News
  2. Features
  3. Installation
  4. Usage
  5. Vite Configuration
  6. Working with AST
  7. Error Handling
  8. Supported Dialects
  9. Versioning
  10. License

sqlparser-ts

npm version npm downloads License WebAssembly sqlparser

SQL parser for JavaScript and TypeScript, powered by datafusion-sqlparser-rs via WebAssembly.

News

  • [2026/02] sqlparser-ts has been officially integrated into Apache Airflow
  • [2026/01] Officially released sqlparser-ts 🎉

Features

  • Parse SQL into a detailed AST with full TypeScript types
  • Support 16 SQL dialects (PostgreSQL, MySQL, SQLite, BigQuery, and more)
  • Run in Node.js and browsers
  • Stay small (~600KB gzipped) and fast (Rust + WebAssembly)
  • Ship zero native dependencies

Installation

npm install @guanmingchiu/sqlparser-ts

Usage

import { init, parse, format, validate } from '@guanmingchiu/sqlparser-ts';

// Initialize WASM module (must be called once before using any parser functions)
await init();

// Parse SQL into AST
const ast = parse('SELECT * FROM users');

// With specific dialect
const ast = parse('SELECT * FROM users WHERE id = $1', 'postgresql');

// Format SQL
const sql = format('select   *   from   users');
// "SELECT * FROM users"

// Validate SQL (throws on invalid)
validate('SELECT * FROM users'); // ok

Vite Configuration

WASM packages must be excluded from Vite's dev server dependency pre-bundling. This only affects the dev server. Production builds use Rollup instead of esbuild and handle WASM files correctly.

// vite.config.ts
export default defineConfig({
  optimizeDeps: {
    exclude: ['@guanmingchiu/sqlparser-ts'],
  },
});

Working with AST

// Parse and inspect
const ast = parse('SELECT id, name FROM users WHERE active = true');
console.log(JSON.stringify(ast, null, 2));

// Multiple statements
const statements = parse(`
  SELECT * FROM users;
  SELECT * FROM orders;
`);
console.log(statements.length); // 2

// Modify AST and convert back to SQL
const ast = parse('SELECT * FROM users')[0];
// ... modify ast ...
const sql = format(JSON.stringify([ast]));

Error Handling

try {
  parse('SELEC * FORM users');
} catch (e) {
  console.error(e.message); // Parse error details
}

Supported Dialects

generic, ansi, mysql, postgresql, sqlite, snowflake, redshift, mssql, clickhouse, bigquery, duckdb, databricks, hive, oracle, spark, teradata

Versioning

Follows Semantic Versioning with upstream tracking:

Example: 0.60.4 = upstream 0.60 + 4 sqlparser-ts releases

License

Apache-2.0

版本与发布记录

@guanmingchiu/sqlparser-ts 共发布 9 个版本,首次发布于 2026/01/27;过去 12 个月发布了 9 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.63.0latest2026/10/161 个月前
0.62.02026/06/174 个月前
0.61.12026/02/119 个月前
0.61.02026/02/119 个月前
0.61.0-rc1rc2026/02/119 个月前
0.60.02026/01/279 个月前

关于 @guanmingchiu/sqlparser-ts 的常见问题

@guanmingchiu/sqlparser-ts 是什么?

A SQL parser for JavaScript and TypeScript, powered by datafusion-sqlparser-rs via WASM

如何安装 @guanmingchiu/sqlparser-ts?

在项目目录运行 npm install @guanmingchiu/sqlparser-ts,或使用 pnpm add / yarn add / bun add。

@guanmingchiu/sqlparser-ts 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@guanmingchiu/sqlparser-ts 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@guanmingchiu/sqlparser-ts 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=16.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@guanmingchiu/sqlparser-ts 可以商用吗?

@guanmingchiu/sqlparser-ts 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@guanmingchiu/sqlparser-ts 的下载量有多少?

根据 npm 官方下载统计,@guanmingchiu/sqlparser-ts 在 2026/10/17 – 2026/11/15 这 30 天内被下载 575,174 次,日均约 19,172 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@guanmingchiu/sqlparser-ts 还在维护吗?

最新版本 0.63.0 发布于 2026/10/16(1 个月前);至今共发布 9 个版本,其中过去 12 个月发布了 9 个;首次发布于 2026/01/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。