@guanmingchiu/sqlparser-ts

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

用于 JavaScript 和 TypeScript 的 SQL 解析器, 由数据聚变- sqlparser- rs 通过 WASM 供电

中文使用文档
文档目录10 节
  1. 新闻
  2. 特征
  3. 安装
  4. 使用量
  5. 虚拟配置
  6. 与AST合作
  7. 处理错误
  8. 支持的对话框
  9. 版本
  10. 许可证

sqlparser -ts (英语)

npm version npm downloads License WebAssembly sqlparser

JavaScript 和 TypeScript 的 SQL 解析器,由 数据化-sqlparser-r 通过WebAssembly.

新闻

  • [2026/02] sqlparser-ts 已正式整合入 阿帕奇气流
  • [2026/01] 官方发布 sqlparser-ts QQ

特征

  • 将 SQL 分析成包含全部类型脚本的详细 AST
  • 支持16个SQL方言(PostgreSQL, MySQL, SQLite, BigQuery等)
  • 在节点和浏览器中运行
  • 保持小(~600KB gziped)并快(Rust + Web Assembly)
  • 零个本土附属船舶

安装

npm install @guanmingchiu/sqlparser-ts

使用量

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

虚拟配置

WASM 软件包必须从 Vite 的 Dev 服务器中排除 依赖性预捆绑。这只影响到dev服务器。 生产建设使用"滚出"而不是"倒出",并正确处理WASM文件.

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

与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]));

处理错误

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

支持的对话框

generic, (中文(简体) ), ansi, (中文(简体) ), mysql, (中文(简体) ), postgresql, (中文(简体) ), sqlite, (中文(简体) ), snowflake, (中文(简体) ), redshift, (中文(简体) ), mssql, (中文(简体) ), clickhouse, (中文(简体) ), bigquery, (中文(简体) ), duckdb, (中文(简体) ), databricks, (中文(简体) ), hive, (中文(简体) ), oracle, (中文(简体) ), spark, (中文(简体) ), teradata

版本

跟着 语义版本 上游跟踪:

示例 0.60.4 = 上游0.60+4 sqlparser-ts 释放

许可证

阿帕奇 - 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 是什么?

用于 JavaScript 和 TypeScript 的 SQL 解析器, 由数据聚变- sqlparser- rs 通过 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 和提交记录判断。