my.ix.dbcontrol -凯发app官方网站

android 开发文档

windows 开发文档

linux 开发文档

iot 小程序开发文档

其它

iot 开放平台 spi 流程概览

复杂类型管理

api

iot 小程序 api 概述

收银台

刷脸核身

刷脸登录

会员与授权

发送付款码

发送和接收小指令

版本查询

获取系统属性

系统设置页面

二维码识别

生成二维码

ui 控制

语音播报

本地数据库

本地图片存储

串口通信

外设管理

打印指令

监听按键事件

身份证读卡器适配

电子秤

钱箱

非接卡通信

ic 卡通信

红外测温仪

消息服务

日志服务

前后屏通信

更多使用指南

更新时间：2022-11-15 16:40:11

订阅更新

我的文档

设置

简介

my.ix.dbcontrol

是控制数据库增删改查等操作的接口。

数据库类型为安卓系统提供的 sqlite 数据库，使用场景为大量数据储存、查询等时使用，如超市商品数据储存等。

使用限制

iot 小程序容器 10.1.80.14 版本开始提供支持。

接口调用

数据库栏位支持的资料型态：

属性	类型
integer	整数
real	浮点数
text	文字
datetime	日期

这里提供小程序数据库增删改查等操作范例。

deletedb

deletedb 是删除数据库范例。

示例代码

// .js

my.ix.dbcontrol({

cmd:'deletedb',

db: 'school',

success: (r) => {

console.log(json.stringify(r))

fail: (r) => {

console.log(json.stringify(r))

})

入参

属性	类型	必填	描述
cmd	string	是	指令：deletedb。
db	string	是	欲删除的数据库名称。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

showdb

showdb 是显示全部数据库范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：showdb。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。
dbs	string list	返回的数据库列表。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

showdbversion

showdbversion 是显示指定的数据库版本范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：showdbversion。
db	string	是	欲查询的数据库名称。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

成功

属性	类型	描述
success	boolean	值为 true。
version	integer	返回的数据库版号。

说明：

返回內容为 {success: true, version: 1}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

altertable

altertable 是变更表单栏位范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：altertable。
db	string	是	欲操作的数据库名称。
table	string	是	欲操作的表单名称。
dbversion	integer	是	对应的数据库版本。
data	string	是	表单的栏位名称、类型。
upgraderule	json	否	表单的升级规则 json。{版本编号 integer：升级规则 string}。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

注意

：

●

upgraderule 数据库预设版本号为 1，栏位型态为 json，key 为整数，value 为升级规则字串，该字串会自动加上前缀"alert table"后调用 onupgrade 函数。（dbversion 指定的数据库版本和本地数据库版本不一致时会调用 onupgrade 函式）。

●

upgraderule 的升级规则字串，可以用分号;分隔，即一个版本执行多个升级操作，其中遇到操作失败会自动回滚到原版本。例如：upgraderule:{2:"add column phone text;add column birth datetime"}。

出参

成功

属性	类型	描述
success	boolean	值为 true。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

createtable

createtable 是新增表单范例。

注意

：若数据库不存在，可在创建表单的同时创建数据库。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：createtable。
db	string	是	欲新增的数据库名称。
table	string	是	欲新增的表单名称。
data	string	是	表单的栏位名称、类型。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

deletetable

deletetable 是删除表单范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：deletetable。
db	string	是	欲操作的数据库名称。
table	string	是	欲删除的表单名称。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参 (成功)

属性	类型	描述
success	boolean	值为 true。

说明：

返回內容为 {success: true}。

出参 (失败)

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

showtablecolumn

showtablecolumn 是显示表单栏位范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：showtablecolumn。
db	string	是	欲操作的数据库名称。
table	string	是	欲操作的表单名称。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。
columns	string list	返回的栏位列表。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

showtables

showtables 是显示全部表单范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：showtables。
db	string	是	欲操作的数据库名称。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。
tables	string list	返回的表单列表。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

insert

insert 是插入一笔资料范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：insertmany。
db	string	是	欲操作的数据库名称。
table	string	是	欲操作的表单名称。
data	jsonarray	是	欲新增的数据，栏位类型需和数据库一致。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

count

count 是查询符合条件的笔数范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：count。
db	string	是	欲操作的数据库名称。
table	string	是	欲操作的表单名称。
filter	string	是	欲过滤的条件。注意： ●filter 栏位支持sql运算符（ex. or、and等）。详细运算符可查看：ex1. "age>=18 and name='john'" ex2. "name like 'jo'" ●filter 栏位为必填，若不需请置空字串 filter:""。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。
count	integer	查询到的数据数量。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

find

find 是查询符合条件的资料范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：findmany。
db	string	是	欲操作的数据库名称。
table	string	是	欲操作的表单名称。
filter	string	是	欲过滤的条件。注意： ●filter 栏位支持sql运算符（ex. or、and等）。详细运算符可查看：ex1. "age>=18 and name='john'" ex2. "name like 'jo'" ●filter 栏位为必填，若不需请置空字串 filter:""。
paginate	json	是	欲显示的页数/笔数json。 {page:integer,count:integer) 注意：最多回传100条数据。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。
result	jsonarray	查询到的数据列表。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

findanddelete

findanddelete 是查询符合条件的资料并全部删除范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：findanddelete。
db	string	是	欲操作的数据库名称。
table	string	是	欲操作的表单名称。
filter	string	是	欲过滤的条件。注意： ●filter 栏位支持sql运算符 (ex. or、and等)。详细运算符可查看：ex1. "age>=18 and name='john'" ex2. "name like 'jo'" ●filter 栏位为必填，若不需请置空字串 filter:""。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

findandupdate

findandupdate 是查询符合条件的一笔资料並全部更新范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：findandupdate。
db	string	是	欲操作的数据库名称。
table	string	是	欲操作的表单名称。
filter	string	是	欲过滤的条件。注意： ●filter 栏位支持sql运算符 (ex. or、and等)。详细运算符可查看：ex1. "age>=18 and name='john'" ex2. "name like 'jo'" ●filter 栏位为必填，若不需请置空字串 filter:""。
update	json	是	欲更新的栏位数据。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

execsql

execsql 是执行 execsql 命令范例。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：count。
db	string	是	欲操作的数据库名称。
table	string	是	欲操作的表单名称。
data	jsonarray	是	欲执行的命令集，格式如下： {"第一条指令","第二条指令",....} 注意：data 为欲执行的命令集，可以执行多个升级操作，其中遇到操作失败会自动回滚到未执行指令前的状态。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

rawquery

rawquery 是执行 rawquery 命令范例。

一次查询最多回传 100 条数据。

示例代码

.js 示例代码

入参

属性	类型	必填	描述
cmd	string	是	指令：rawquery。
db	string	是	欲操作的数据库名称。
table	string	是	欲操作的表单名称。
data	string	是	欲执行的命令。
success	function	是	成功的回调函数。
fail	function	是	失败的回调函数。
complete	function	否	结束的回调函数： ●成功时，先回调 success 再回调 complete。 ●失败时，先回调 fail 再回调 complete。

出参

成功

属性	类型	描述
success	boolean	值为 true。

说明：

返回內容为 {success: true}。

失败

属性	类型	描述
error	integer	错误码。
errormessage	string	错误的详细叙述。

说明：

返回内容只包含 {error: number, errormessage: 'xxx'}。

相关问题