uexDataBaseMgr查看3.0文档

数据库插件

1.1、说明

该对象主要封装了数据库的打开关闭,创建表,插入数据,查询数据,执行事务的接口

本文的目的是为了开发能够更好更快地将API集成到自己的项目中,在使用前最好先使用好我们提供的demo并对照文档运行看看效果。
这里可以【参考教程】下载AppCan IDE为开发者工具开发,然后集成到自己的项目上。

1.2、开源源码

插件测试用例与源码下载:点击插件中心至插件详情页 (插件测试用例与插件源码已经提供)

1.3、平台版本支持

本插件的所有API默认支持Android4.0+iOS7.0+操作系统. 有特殊版本要求的API会在文档中额外说明.

1.4、接口有效性

本插件所有API默认在插件版本4.0.0+可用.
在后续版本中新添加的接口会在文档中额外说明.

2、API概览

2.1、方法
open //打开数据库并得到数据库对象

uexDataBaseMgr.open(dbName)

说明:

打开数据库并得到数据库对象.

参数:

参数名称 参数类型 是否必选 说明
dbName String 数据库名称

返回值:

该函数同步返回DB Object.结果不为null即为打开成功,后续接口传入此对象进行操作,开发者不需要关心里面的数据结构.

示例:

var db = uexDataBaseMgr.open("uexDB");
if(!db){
  alert("打开失败!");
}
sql //Sql语句的执行

uexDataBaseMgr.sql(db,sql,callbackFunction)

说明:

Sql语句的执行,对数据库数据的增删改.执行完成后回调callbackFunction 参数:

参数名称 参数类型 是否必选 说明
db DB Object open接口同步返回的对象
sql String 要执行的sql语句
callbackFunction Function 回调函数,返回执行的结果

回调参数:

var callbackFunction = function(error){}
参数名称 类型 说明
error Number 执行结果,0表示成功,非0表示失败

示例:

var sql = "CREATE TABLE testTable (_id  INTEGER PRIMARY KEY,name TEXT)";
uexDataBaseMgr.sql(db,sql, function(error) {
    if (!error) {
        alert('执行成功')
    }
});
select //Sql语句的查询

uexDataBaseMgr.select(db,sql, callbackFunction)

说明:

Sql语句的查询,对数据库中数据的查询.

参数:

参数名称 参数类型 是否必选 说明
db DB Object open接口同步返回的对象
sql String 要查询的sql语句
callbackFunction 函数 回调函数,返回执行的结果

回调参数:

var callbackFunction = function(error, data){
}
参数名称 类型 说明
error Number 执行结果,0表示成功,非0表示失败
data Array 查询结果

示例:

var sql = "SELECT * FROM testTable";
uexDataBaseMgr.select(db,sql, function (error,data) {
    if (error) {
        alert('执行失败');
    } else {
        alert('data:' + JSON.stringify(data));
    }
});
transactionEx //事务的执行 

uexDataBaseMgr.transactionEx(db,sqls, callbackFunction)

说明:

事务的执行, 执行完成后回调callbackFunction,不支持select相关的语句

参数:

参数名称 参数类型 是否必选 说明
db DB Object open接口同步返回的对象
sqls String sql语句数组的Json字符串
callbackFunction Function 回调函数,返回执行的结果

回调参数:

var callbackFunction = function(error){}
参数名称 类型 说明
error Number 执行结果,0表示成功,非0表示失败

示例:

var sqls=[
    "DROP TABLE testTable",
    "CREATE TABLE testTable (_id INTEGER PRIMARY KEY,name TEXT)",
    "INSERT INTO testTable (name) VALUES ('this is a case')",
    "UPDATE testTable SET name='这是更改' WHERE _id = 1"
];
uexDataBaseMgr.transactionEx(db,JSON.stringify(sqls), function(error) {
    alert("transaction result:"+error);
});
close //关闭数据库

uexDataBaseMgr.close(db)

说明:

关闭数据库.

参数:

参数名称 参数类型 是否必选 说明
db DB Object open对象同步返回的对象

返回值:

返回值为Boolean类型,表示关闭的结果,true为成功, false 为失败

示例:

var result = uexDataBaseMgr.close(db);
alert(result);
copyDataBaseFile //拷贝内置数据库

uexDataBaseMgr.copyDataBaseFile(path,callback)

说明:

需要APP使用内置数据库时使用。先将数据库文件放置在res://目录下,然后调用该接口。后面使用与之前一致。

如果数据库的版本不为1,需要在open接口传入数据库的版本号

注:该接口只需要调用一次,再次调用会覆盖之前的数据库

参数:

参数名称 参数类型 是否必选 说明
path String 存放数据库的路径,支持AppCan 协议,不支持网络路径
callback Function 拷贝完成的回调
var callback=function(error){
      //!error 表示成功 
}

示例:

uexDataBaseMgr.copyDataBaseFile("res://musicEx.db",function (error) {
    if (!error) {

        var db = uexDataBaseMgr.open("musicEx.db", 1017);
        if (db != null) {
            var sql = "SELECT * FROM Song";
            uexDataBaseMgr.select(db, sql, function (error, data) {
                if (error) {
                    console.log("failed");
                } else {
                    console.log(JSON.stringify(data));
                }
                db.close();
            });
        } else {
            console.log("failed");
        }
    }else{
        console.log("failed");
    }
});

3、更新历史

iOS

API版本: uexDataBaseMgr-4.0.2

最近更新时间:2017-02-27

历史发布版本 更新内容
4.0.2 修复一个导致空指针app闪退的bug
4.0.1 支持拷贝预置数据库
Android

API版本: uexDataBaseMgr-4.0.1

最近更新时间:2016-12-12

历史发布版本 更新内容
4.0.1 支持拷贝预置数据库
还需要帮助吗? 联系我们
最新更新 9th Mar 2017