快速开始
安装
通过 npm 安装:
bash
npm install lite-ibatis三步上手
lite-ibatis 的使用流程和 Pug 渲染 HTML 非常相似:parse 把模板解析成 Token 树,compile 把 Token 树编译成可复用的函数,调用函数即得到 SQL 与参数。
typescript
import { LiteIbatis } from 'lite-ibatis';
const lite = new LiteIbatis();
// 1. 解析模板
const tokens = lite.parse(`$getUser:
select * from users
#if name
where name = #{name}
#if age
and age = #{age}`);
// 2. 编译为可执行函数
const run = lite.compile(tokens);
// 3. 执行并获取 SQL 和参数
const [sql, params] = run('getUser', { name: '张三', age: 25 });
// sql: select * from users\nwhere name = ?\nand age = ?
// params: ['张三', 25]不传条件参数时,对应的 SQL 片段会自动省略:
typescript
const [sql] = run('getUser', {});
// sql: select * from users配合数据库
编译结果是标准的 [sql, params],可以直接交给支持预编译参数的数据库驱动:
typescript
// MySQL (mysql2)
const [rows] = await connection.execute(sql, params);
// PostgreSQL (pg)
const { rows } = await client.query(sql, params);