sqlparser -ts (英语)
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
版本
跟着 语义版本 上游跟踪:
- 上游轨道 数据化-sqlparser-r
- 特定释放物
示例 0.60.4 = 上游0.60+4 sqlparser-ts 释放
许可证
阿帕奇 - 2.0