nodebatis-lite

简化和重构自 nodebatis

做了再三的考虑，为了以后支持多数据库，nodebatis-lite 不包含 mysql 驱动，需要用户自己安装。

API 与 nodebatis 不完全兼容！（重要的话说三遍）

API 与 nodebatis 不完全兼容！（重要的话说三遍）

API 与 nodebatis 不完全兼容！（重要的话说三遍）

Install

``bash
npm install @wolfx/nodebatis-lite mysql
`

或

`bash
yarn add @wolfx/nodebatis-lite mysql
`

API(以 TypeScript 描述)

`plain
execute(sql: string, params?: Array): Promise; // 执行原始 sql
query(key: string, data: Object): Promise;
find(tableName: string, dataArray: Array, id: string | number, paramKey: string = "id"): Promise;
insert(tableName: string, data: Object): Promise;
update(tableName: string, data: Object, idKey: string = "id"): Promise;
del(tableName: string, id: string | number | Array, idKey: string = "id"): Promise;
getPool(): Pool; // 暴露原始 pool 给外部
`

示例代码

连接 mysql

`javascript
const NodebatisLite = require("@wolfx/nodebatis-lite");
const nodebatis = new NodebatisLite(path.resolve(__dirname, "./yaml"), {
debug: true,
debugCallback: (key, sql, params) => {
// 这里可以接入log4js等
// 使用debugCallback后debug不会输出log，需要在回调中自己处理
},
dialect: "mysql",
host: "127.0.0.1",
port: 3306,
database: "test",
user: "root",
password: "haosql",
camelCase: true, // 是否使用驼峰参数和返回结果
pool: {
minSize: 5,
maxSize: 20,
connectionLimit: 5,
},
});
`

利用 find 快速查询数据

`javascript
let findTest = async () => {
let ret = await nodebatis.find("test", ["*"], 1);
};
`

默认是通过 id 查询，当然，你可以指定字段名

`javascript
let findTest = async () => {
let ret = await nodebatis.find("test", ["*"], 1, "yourName");
};
`

利用 insert 方法快速插入数据

`javascript
let insertTest = async () => {
let ret = await nodebatis.insert("test", { age: 29, name: "peter" });
};
`

利用 update 方法快速更新数据

`javascript
let updateTest = async () => {
let ret = await nodebatis.update("test", { id: 1, age: 21, name: "bezos" });
};
`

如果你的主键不叫 id，比如叫 yourKey

`javascript
let updateTest = async () => {
let ret = await nodebatis.update("test", { id: 1, age: 21, name: "bezos" }, "yourKey");
};
`

利用 delete 方法快速删除数据

`javascript
let deleteTest = async id => {
let ret = await nodebatis.del("test", id);
};
`

如果你的主键不叫 id，比如叫 your_key

`javascript
let deleteTest = async id => {
let ret = await nodebatis.del("test", id, "your_key");
};
`

1.2.0 开始可以传数组进行批量删除

`javascript
let deleteTest = async idArray => {
let ret = await nodebatis.del("test", idArray);
};
`

如何编写 SQL 语句定义文件

定义 SQL 语句采用 yaml 语法。一个 SQL 语句定义文件就是一个 yaml 文档。

如果你还不熟悉 yaml，可以参考这篇教程：YAML 语言教程

SQL yaml 文档的约定的规则很简单。

1. 开头需要写 namespace: xxx, xxx 为自己定义的命名空间。
2. 定义 SQL 语句 key: sql , namespace.key 就是定义的 SQL 语句的唯一索引。
3. SQL 语句中的参数。
- :paramName, paramName 为执行 SQL 语句时传递的参数名。
- ::ddl, ddl 为 DDL 语句，不会对参数进行过滤。
- {{namespace.key}}, SQL 语句继承，会获取到 namespace.key 的 SQL 语句填充到此处。
4. 条件判断。

`
if:
test: expression
sql: statements
`

当 expression 为 true 是，对应的 sql 会添加到 sql 语句中。 expression 就是一个 JS 语句, 可以通过 :paramName 传递参数。

5. for 循环

`
for:
array: array,
sql: statements
seperator: ','
`

- array, 要遍历的数组，数组内的数据必须是对象。
- sql, 每次遍历要填充的 sql，使用 :key 的形式引用 array 中的对象的数据。
- seperator, 每次遍历填充的 sql 之间的分隔符。

$3

`yaml
namespace: "test"

attrs: id, name, age

query:
- select {{ test.attrs }} from test where
- age > :age

expressionDemo:
- select * from demo where
- if:
test: :paramName == 'nodebatis' && :age > 18
sql: and sex = 'man'

forTest:
- select * from test where
- id in (
- for:
array: ids
sql: :id
seperator: ","
- )
`

1.3.0 开始，支持用 $ 符号定义变量，多了一种选择

`yaml
namespace: "test"

attrs: id, name, age

query:
- select {{ test.attrs }} from test where
- age > $age

expressionDemo:
- select * from demo where
- if:
test: $paramName == 'nodebatis' && $age > 18
sql: and sex = 'man'

forTest:
- select * from test where
- id in (
- for:
array: ids
sql: $id
seperator: ","
- )
`

$3

`javascript
// 查询处所有大于指定age的数据
let queryTest = async age => {
try {
let ret = await nodebatis.query("test.query", { age });
} catch (e) {
console.log(e);
}
};
`

for 关键字使用示例

`javascript
// 查询出id是1或2或3的数据
let forTest = async () => {
try {
let ids = [
{
id: 1,
},
{
id: 2,
},
{
id: 3,
},
];
let ret = await nodebatis.query("test.forTest", { ids });
} catch (e) {
console.log(e);
}
};
`

批量插入

`yaml
namespace: "test"

batchInsert:
- insert into test(name, age) values
- for:
array: data
sql: (:name, :age)
seperator: ","
`

`javascript
let batchInsertTest = async () => {
let ret = await nodebatis.query("test.batchInsert", {
data: [
{
name: "batch-" + parseInt(Math.random() * 10),
age: 18,
},
{
name: "batch-" + parseInt(Math.random() * 10),
age: 19,
},
{
name: "batch-" + parseInt(Math.random() * 10),
age: 17,
},
],
});
};
`

执行原始 sql

`javascript
nodebatis.execute("ALTER TABLE test.test ADD column1 varchar(100) NULL;", []);
`

事务

`javascript
let transactionTest = async () => {
let transaction = await nodebatis.getTransaction();
try {
let result3 = await transaction.update("test", { id: 2, name: "peter", age: 18 });
let result1 = await transaction.insert("test", { name: "peter", age: 28 });
let result2 = await transaction.query("test.query", { name: "peter" });
await transaction.commit();
return result1;
} catch (e) {
console.log(e);
await transaction.rollback();
}
};
`

更新日记

1.4.0-alpha

add：加入了事务的能力。
change：执行过程中的异常会向外抛出。便于使用者处理（比如代码定位和记录错误日志等）。

1.3.0

add：支持用 $ 符号定义变量，多了一种选择。
fix：异常处理优化。

1.2.3

fix：修复变量值为 0，进入 if 比较时不正确的问题。

1.2.2

fix：修复 execute() 异常。

1.2.0

add：增加 batch delete

1.0.6

fix：修复 getPool()` 获取的池不正确的问题