# @guanmingchiu/sqlparser-ts 中文文档

规范地址：https://npmcn.com/package/%40guanmingchiu/sqlparser-ts/

版本：0\.63\.0
npm 元数据更新时间：2026-10-16T12:47:15.142Z
中文译文更新时间：2026-11-17T02:38:52.547Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40guanmingchiu/sqlparser-ts
原文对照：https://npmcn.com/package/%40guanmingchiu/sqlparser-ts/?lang=original
项目主页：https://github.com/guan404ming/sqlparser-ts#readme
源码仓库：https://github.com/guan404ming/sqlparser-ts

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：3.7 MB，13 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.0\.0
- 运行依赖：0 个
- 首次发布：2026-01-27T07:17:49.704Z
- 最新版本发布：2026-10-16T12:47:14.779Z
- 近 30 天下载量：575174（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

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

## 安装

```sh
npm install @guanmingchiu/sqlparser-ts
```

也可以使用：`pnpm add @guanmingchiu/sqlparser-ts`、`yarn add @guanmingchiu/sqlparser-ts`、`bun add @guanmingchiu/sqlparser-ts`

## README

# sqlparser -ts (英语)

[![npm version](https://img.shields.io/npm/v/@guanmingchiu/sqlparser-ts.svg)](https://www.npmjs.com/package/@guanmingchiu/sqlparser-ts) [![npm downloads](https://badgen.net/npm/dm/@guanmingchiu/sqlparser-ts)](https://www.npmjs.com/package/@guanmingchiu/sqlparser-ts) [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://npmcn.com/package/%40guanmingchiu/sqlparser-ts/LICENSE) [![WebAssembly](https://img.shields.io/badge/WebAssembly-powered-blueviolet.svg)](https://webassembly.org/) [![sqlparser](https://img.shields.io/badge/sqlparser--rs-v0.63.0-orange.svg)](https://github.com/apache/datafusion-sqlparser-rs)

JavaScript 和 TypeScript 的 SQL 解析器,由 [数据化-sqlparser-r](https://github.com/apache/datafusion-sqlparser-rs) 通过WebAssembly.

## 新闻

-   \[2026/02\] sqlparser-ts 已正式整合入 [阿帕奇气流](https://github.com/apache/airflow)
-   \[2026/01\] 官方发布 sqlparser-ts QQ

## 特征

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

## 安装

```bash
npm install @guanmingchiu/sqlparser-ts
```

## 使用量

```typescript
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 服务器中排除 [依赖性预捆绑](https://github.com/vitejs/vite/discussions/9256)。这只影响到dev服务器。 生产建设使用"滚出"而不是"倒出",并正确处理WASM文件.

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

### 与AST合作

```typescript
// 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]));
```

### 处理错误

```typescript
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`

## 版本

跟着 [语义版本](https://semver.org/) 上游跟踪:

-   上游轨道 [数据化-sqlparser-r](https://github.com/apache/datafusion-sqlparser-rs)
-   特定释放物

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

## 许可证

阿帕奇 - 2.0

## 常见问题

### @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 和提交记录判断。

