对象 MySQL

MySQL 对象是用于操作 MySQL 数据库的类,

下面是一个使用 MySQL 对象的示例。

1
2
3
4
5
6
7
8
9
10
11
12
13
var db = require('db');

var conn = db.openMySQL('mysql://root:password@localhost/test');

// call execute method to insert data
var res = conn.execute("insert into user(username, password) values ('testuser', '123456')");
console.log(res);

// call execute method to query data
res = conn.execute("select * from user where username = 'testuser'");
console.log(res);

conn.close();

以上示例中，首先我们利用 db.openMySQL 方法创建一个 MySQL 的连接对象并指定连接信息。然后我们使用 execute 方法向我们提前准备好的 user 数据表中添加一个新的用户，之后我们再调用 execute 方法查询刚刚创建的用户记录。最终我们调用 close 方法关闭链接对象，并完成了我们的 MySQL 操作。

继承关系

成员属性

rxBufferSize

Integer, 数据库连接接收缓存尺寸

1Integer MySQL.rxBufferSize;

txBufferSize

Integer, 数据库连接发送缓存尺寸

1Integer MySQL.txBufferSize;

type

String, 查询当前连接数据库类型

1
readonly String MySQL.type;

成员函数

close

关闭当前数据库连接

1
MySQL.close() async;

use

选择当前数据库连接的缺省数据库

1
MySQL.use(String dbName) async;

调用参数:

dbName: String, 指定数据库名

begin

在当前数据库连接上启动一个事务

1
MySQL.begin(String point = "") async;

调用参数:

point: String, 指定事务的名称，缺省不指定

commit

提交当前数据库连接上的事务

1
MySQL.commit(String point = "") async;

调用参数:

point: String, 指定事务的名称，缺省不指定

rollback

回滚当前数据库连接上的事务

1
MySQL.rollback(String point = "") async;

调用参数:

point: String, 指定事务的名称，缺省不指定

trans

进入事务执行一个函数，并根据函数执行情况提交或者回滚

1
Boolean MySQL.trans(Function func);

调用参数:

func: Function, 以事务方式执行的函数

返回结果:

Boolean, 返回事务是否提交，正常 commit 时返回 true, rollback 时返回 false，如果事务出错则抛出错误

func 执行有三种结果：

函数正常返回，包括运行结束和主动 return，此时事务将自动提交
函数返回 false，此时事务将回滚
函数运行错误，事务自动回滚

进入事务执行一个函数，并根据函数执行情况提交或者回滚

1
2
Boolean MySQL.trans(String point,
    Function func);

调用参数:

point: String, 指定事务的名称
func: Function, 以事务方式执行的函数

返回结果:

Boolean, 返回事务是否提交，正常 commit 时返回 true, rollback 时返回 false，如果事务出错则抛出错误

func 执行有三种结果：

函数正常返回，包括运行结束和主动 return，此时事务将自动提交
函数返回 false，此时事务将回滚
函数运行错误，事务自动回滚

execute

执行一个 sql 命令，并返回执行结果

1
NArray MySQL.execute(String sql) async;

调用参数:

sql: String, 字符串

返回结果:

NArray, 返回包含结果记录的数组，如果请求是 UPDATE 或者 INSERT，返回结果还会包含 affected 和 insertId，mssql 不支持 insertId。

执行一个 sql 命令，并返回执行结果，可根据参数格式化字符串

1
2
NArray MySQL.execute(String sql,
    ...args) async;

调用参数:

sql: String, 格式化字符串，可选参数用 ? 指定。例如：'SELECT FROM TEST WHERE [id]=?'
args: ..., 可选参数列表

返回结果:

NArray, 返回包含结果记录的数组，如果请求是 UPDATE 或者 INSERT，返回结果还会包含 affected 和 insertId，mssql 不支持 insertId。

createTable

创建数据表

1
MySQL.createTable(Object opts) async;

调用参数:

opts: Object, 参数列表

dropTable

删除数据表

1
MySQL.dropTable(Object opts) async;

调用参数:

opts: Object, 参数列表

createIndex

创建数据表索引

1
MySQL.createIndex(Object opts) async;

调用参数:

opts: Object, 参数列表

dropIndex

删除数据表索引

1
MySQL.dropIndex(Object opts) async;

调用参数:

opts: Object, 参数列表

insert

插入新记录

1
Number MySQL.insert(Object opts) async;

调用参数:

opts: Object, 参数列表

返回结果:

Number, 返回包含插入的 id，如果引擎不支持则返回 0

find

根据指定的条件查询数据

1
NArray MySQL.find(Object opts) async;

调用参数:

opts: Object, 参数列表

返回结果:

NArray, 返回包含结果记录

count

根据指定的条件统计数据记录数

1
Integer MySQL.count(Object opts) async;

调用参数:

opts: Object, 参数列表

返回结果:

Integer, 返回包含结果记录数

update

根据指定的条件更新数据

1
Integer MySQL.update(Object opts) async;

调用参数:

opts: Object, 参数列表

返回结果:

Integer, 返回包含更新的记录数

remove

根据指定的条件删除数据

1
Integer MySQL.remove(Object opts) async;

调用参数:

opts: Object, 可选参数列表

返回结果:

Integer, 返回包含更新的记录数

format

格式化一个 sql 命令，并返回格式化结果

1
2
String MySQL.format(String method,
    Object opts);

调用参数:

method: String, 指定请求的方法
opts: Object, 可选参数列表

返回结果:

String, 返回格式化之后的 sql 命令

格式化一个 sql 命令，并返回格式化结果

1
2
String MySQL.format(String sql,
    ...args);

调用参数:

sql: String, 格式化字符串，可选参数用 ? 指定。例如：'SELECT FROM TEST WHERE [id]=?'
args: ..., 可选参数列表

返回结果:

String, 返回格式化之后的 sql 命令

toString

返回对象的字符串表示，一般返回 "[Native Object]"，对象可以根据自己的特性重新实现

1
String MySQL.toString();

返回结果:

String, 返回对象的字符串表示

toJSON

返回对象的 JSON 格式表示，一般返回对象定义的可读属性集合

1
Value MySQL.toJSON(String key = "");

调用参数:

key: String, 未使用

返回结果:

Value, 返回包含可 JSON 序列化的值

开发指南

基础模块

内置对象

社区模块

对象 MySQL

继承关系

成员属性

rxBufferSize

txBufferSize

type

成员函数

close

use

begin

commit

rollback

trans

execute

createTable

dropTable

createIndex

dropIndex

insert

find

count

update

remove

format

toString

toJSON