鸿蒙开发接口数据管理:【@ohos.data.rdb (关系型数据库)】

关系型数据库

关系型数据库(Relational Database,RDB)是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制,对外提供了一系列的增、删、改、查等接口,也可以直接运行用户输入的SQL语句来满足复杂的场景需要。

该模块提供以下关系型数据库相关的常用功能:

  • [RdbPredicates]: 数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项,主要用来定义数据库的操作条件。
  • [RdbStore]:提供管理关系数据库(RDB)方法的接口。

说明:

本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import data_rdb from '@ohos.data.rdb';

data_rdb.getRdbStore

getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback): void

获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以callback形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
contextContext应用的上下文。 FA模型的应用Context定义见[Context]。 Stage模型的应用Context定义见[Context]。
config[StoreConfig]与此RDB存储相关的数据库配置。
versionnumber数据库版本。
callbackAsyncCallback<[RdbStore]>指定callback回调函数,返回一个RdbStore。

示例:

const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) {if (err) {console.info("Get RdbStore failed, err: " + err)return}console.log("Get RdbStore successfully.")
})

data_rdb.getRdbStore

getRdbStore(context: Context, config: StoreConfig, version: number): Promise

获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以Promise形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
contextContext应用的上下文。 FA模型的应用Context定义见[Context]。 Stage模型的应用Context定义见[Context]。
config[StoreConfig]与此RDB存储相关的数据库配置。
versionnumber数据库版本。

返回值

类型说明
Promise<[RdbStore]>指定Promise回调函数。返回一个RdbStore。

示例:

const STORE_CONFIG = { name: "RdbTest.db" }
let promise = data_rdb.getRdbStore(this.context, STORE_CONFIG, 1);
promise.then(async (rdbStore) => {console.log("Get RdbStore successfully.")
}).catch((err) => {console.log("Get RdbStore failed, err: " + err)
})

data_rdb.deleteRdbStore

deleteRdbStore(context: Context, name: string, callback: AsyncCallback): void

删除数据库,结果以callback形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
contextContext应用的上下文。 FA模型的应用Context定义见[Context]。 Stage模型的应用Context定义见[Context]。
namestring数据库名称。
callbackAsyncCallback指定callback回调函数。

示例:

data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) {if (err) {console.info("Delete RdbStore failed, err: " + err)return}console.log("Delete RdbStore successfully.")
})

data_rdb.deleteRdbStore

deleteRdbStore(context: Context, name: string): Promise

使用指定的数据库文件配置删除数据库,结果以Promise形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数

参数名类型必填说明
contextContext应用的上下文。 FA模型的应用Context定义见[Context]。 Stage模型的应用Context定义见[Context]。
namestring数据库名称。

返回值

类型说明
Promise指定Promise回调函数。

示例:

let promise = data_rdb.deleteRdbStore(this.context, "RdbTest.db")
promise.then(()=>{console.log("Delete RdbStore successfully.")
}).catch((err) => {console.info("Delete RdbStore failed, err: " + err)
})

RdbPredicates

表示关系型数据库(RDB)的谓词。该类确定RDB中条件表达式的值是true还是false。

constructor

constructor(name: string)

构造函数。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
namestring数据库表名。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")

inDevices8+

inDevices(devices: Array): RdbPredicates

同步分布式数据库时指定组网内的远程设备。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
devicesArray指定的组网内的远程设备ID。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inDevices(['12345678abcde'])

inAllDevices8+

inAllDevices(): RdbPredicates

同步分布式数据库时连接到组网内的所有远程设备。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inAllDevices()

equalTo

equalTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且值等于指定值的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")

notEqualTo

notEqualTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notEqualTo("NAME", "lisi")

beginWrap

beginWrap(): RdbPredicates

向谓词添加左括号。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回带有左括号的Rdb谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi").beginWrap().equalTo("AGE", 18).or().equalTo("SALARY", 200.5).endWrap()

endWrap

endWrap(): RdbPredicates

向谓词添加右括号。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回带有右括号的Rdb谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi").beginWrap().equalTo("AGE", 18).or().equalTo("SALARY", 200.5).endWrap()

or

or(): RdbPredicates

将或条件添加到谓词中。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回带有或条件的Rdb谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa").or().equalTo("NAME", "Rose")

and

and(): RdbPredicates

向谓词添加和条件。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回带有和条件的Rdb谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa").and().equalTo("SALARY", 200.5)

contains

contains(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且value包含指定值的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.contains("NAME", "os")

beginsWith

beginsWith(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且值以指定字符串开头的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.beginsWith("NAME", "os")

endsWith

endsWith(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.endsWith("NAME", "se")

isNull

isNull(field: string): RdbPredicates

配置谓词以匹配值为null的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。
  • 示例
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNull("NAME")

isNotNull

isNotNull(field: string): RdbPredicates

配置谓词以匹配值不为null的指定字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNotNull("NAME")

like

like(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且值类似于指定字符串的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.like("NAME", "%os%")

glob

glob(field: string, value: string): RdbPredicates

配置RdbPredicates匹配数据字段为string的指定字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。 支持通配符,*表示0个、1个或多个数字或字符,?表示1个数字或字符。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.glob("NAME", "?h*g")

between

between(field: string, low: ValueType, high: ValueType): RdbPredicates

将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
low[ValueType]指示与谓词匹配的最小值。
high[ValueType]指示要与谓词匹配的最大值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.between("AGE", 10, 50)

notBetween

notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates

配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
low[ValueType]指示与谓词匹配的最小值。
high[ValueType]指示要与谓词匹配的最大值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notBetween("AGE", 10, 50)

greaterThan

greaterThan(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且值大于指定值的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThan("AGE", 18)

lessThan

lessThan(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为valueType且value小于指定值的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThan("AGE", 20)

greaterThanOrEqualTo

greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThanOrEqualTo("AGE", 18)

lessThanOrEqualTo

lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThanOrEqualTo("AGE", 20)

orderByAsc

orderByAsc(field: string): RdbPredicates

配置谓词以匹配其值按升序排序的列。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByAsc("NAME")

orderByDesc

orderByDesc(field: string): RdbPredicates

配置谓词以匹配其值按降序排序的列。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByDesc("AGE")

distinct

distinct(): RdbPredicates

配置谓词以过滤重复记录并仅保留其中一个。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回可用于过滤重复记录的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").distinct("NAME")
let promise = rdbStore.query(predicates, ["NAME"])
promise.then((resultSet) => {console.log("resultSet column names:" + resultSet.columnNames)console.log("resultSet column count:" + resultSet.columnCount)
}).catch((err) => {console.log("query err.")
})

limitAs

limitAs(value: number): RdbPredicates

设置最大数据记录数的谓词。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
valuenumber最大数据记录数。

返回值

类型说明
[RdbPredicates]返回可用于设置最大数据记录数的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").limitAs(3)

offsetAs

offsetAs(rowOffset: number): RdbPredicates

配置RdbPredicates以指定返回结果的起始位置。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
rowOffsetnumber返回结果的起始位置,取值为正整数。

返回值

类型说明
[RdbPredicates]返回具有指定返回结果起始位置的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").offsetAs(3)

groupBy

groupBy(fields: Array): RdbPredicates

配置RdbPredicates按指定列分组查询结果。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldsArray指定分组依赖的列名。

返回值

类型说明
[RdbPredicates]返回分组查询列的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.groupBy(["AGE", "NAME"])

indexedBy

indexedBy(field: string): RdbPredicates

配置RdbPredicates以指定索引列。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring索引列的名称。

返回值

类型说明
[RdbPredicates]返回具有指定索引列的RdbPredicates。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.indexedBy("SALARY_INDEX")

in

in(field: string, value: Array): RdbPredicates

配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valueArray<[ValueType]>以ValueType型数组形式指定的要匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.in("AGE", [18, 20])

notIn

notIn(field: string, value: Array): RdbPredicates

将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valueArray<[ValueType]>以ValueType数组形式指定的要匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notIn("NAME", ["Lisa", "Rose"])

RdbStore

提供管理关系数据库(RDB)方法的接口。

insert

insert(table: string, values: ValuesBucket, callback: AsyncCallback):void

向目标表中插入一行数据,结果以callback形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
tablestring指定的目标表名。
values[ValuesBucket]表示要插入到表中的数据行。
callbackAsyncCallback指定callback回调函数。如果操作成功,返回行ID;否则返回-1。

示例:

const valueBucket = {"NAME": "Lisa","AGE": 18,"SALARY": 100.5,"CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
rdbStore.insert("EMPLOYEE", valueBucket, function (err, ret) {if (err) {console.info("Insert failed, err: " + err)return}console.log("Insert first done: " + ret)
})

insert

insert(table: string, values: ValuesBucket):Promise

向目标表中插入一行数据,结果以Promise形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
tablestring指定的目标表名。
values[ValuesBucket]表示要插入到表中的数据行。

返回值

类型说明
Promise指定Promise回调函数。如果操作成功,返回行ID;否则返回-1。

示例:

const valueBucket = {"NAME": "Lisa","AGE": 18,"SALARY": 100.5,"CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let promise = rdbStore.insert("EMPLOYEE", valueBucket)
promise.then(async (ret) => {console.log("Insert first done: " + ret)
}).catch((err) => {console.log("Insert failed, err: " + err)
})

update

update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback):void

根据RdbPredicates的指定实例对象更新数据库中的数据,结果以callback形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
values[ValuesBucket]values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。
predicates[RdbPredicates]RdbPredicates的实例对象指定的更新条件。
callbackAsyncCallback指定的callback回调方法。返回受影响的行数。

示例:

const valueBucket = {"NAME": "Rose","AGE": 22,"SALARY": 200.5,"CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
rdbStore.update(valueBucket, predicates, function (err, ret) {if (err) {console.info("Updated failed, err: " + err)return}console.log("Updated row count: " + ret)
})

update

update(values: ValuesBucket, predicates: RdbPredicates):Promise

根据RdbPredicates的指定实例对象更新数据库中的数据,结果以Promise形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
values[ValuesBucket]values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。
predicates[RdbPredicates]RdbPredicates的实例对象指定的更新条件。

返回值

类型说明
Promise指定的Promise回调方法。返回受影响的行数。

示例:

const valueBucket = {"NAME": "Rose","AGE": 22,"SALARY": 200.5,"CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
let promise = rdbStore.update(valueBucket, predicates)
promise.then(async (ret) => {console.log("Updated row count: " + ret)
}).catch((err) => {console.info("Updated failed, err: " + err)
})

delete

delete(predicates: RdbPredicates, callback: AsyncCallback):void

根据RdbPredicates的指定实例对象从数据库中删除数据,结果以callback形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
predicates[RdbPredicates]RdbPredicates的实例对象指定的删除条件。
callbackAsyncCallback指定callback回调函数。返回受影响的行数。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
rdbStore.delete(predicates, function (err, rows) {if (err) {console.info("Delete failed, err: " + err)return}console.log("Delete rows: " + rows)
})

delete

delete(predicates: RdbPredicates):Promise

根据RdbPredicates的指定实例对象从数据库中删除数据,结果以Promise形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
predicates[RdbPredicates]RdbPredicates的实例对象指定的删除条件。

返回值

类型说明
Promise指定Promise回调函数。返回受影响的行数。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
let promise = rdbStore.delete(predicates)
promise.then((rows) => {console.log("Delete rows: " + rows)
}).catch((err) => {console.info("Delete failed, err: " + err)
})

query

query(predicates: RdbPredicates, columns: Array, callback: AsyncCallback):void

根据指定条件查询数据库中的数据,结果以callback形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
predicates[RdbPredicates]RdbPredicates的实例对象指定的查询条件。
columnsArray表示要查询的列。如果值为空,则查询应用于所有列。
callbackAsyncCallback<[ResultSet]>指定callback回调函数。如果操作成功,则返回ResultSet对象。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose")
rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) {if (err) {console.info("Query failed, err: " + err)return}console.log("ResultSet column names: " + resultSet.columnNames)console.log("ResultSet column count: " + resultSet.columnCount)
})

query

query(predicates: RdbPredicates, columns?: Array):Promise

根据指定条件查询数据库中的数据,结果以Promise形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
predicates[RdbPredicates]RdbPredicates的实例对象指定的查询条件。
columnsArray表示要查询的列。如果值为空,则查询应用于所有列。

返回值

类型说明
Promise<[ResultSet]>指定Promise回调函数。如果操作成功,则返回ResultSet对象。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose")
let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promise.then((resultSet) => {console.log("ResultSet column names: " + resultSet.columnNames)console.log("ResultSet column count: " + resultSet.columnCount)
}).catch((err) => {console.info("Query failed, err: " + err)
})

querySql8+

querySql(sql: string, bindArgs: Array, callback: AsyncCallback):void

根据指定SQL语句查询数据库中的数据,结果以callback形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
sqlstring指定要执行的SQL语句。
bindArgsArray<[ValueType]>SQL语句中参数的值。
callbackAsyncCallback<[ResultSet]>指定callback回调函数。如果操作成功,则返回ResultSet对象。

示例:

rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) {if (err) {console.info("Query failed, err: " + err)return}console.log("ResultSet column names: " + resultSet.columnNames)console.log("ResultSet column count: " + resultSet.columnCount)
})

querySql8+

querySql(sql: string, bindArgs?: Array):Promise

根据指定SQL语句查询数据库中的数据,结果以Promise形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
sqlstring指定要执行的SQL语句。
bindArgsArray<[ValueType]>SQL语句中参数的值。

返回值

类型说明
Promise<[ResultSet]>指定Promise回调函数。如果操作成功,则返回ResultSet对象。

示例:

let promise = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'])
promise.then((resultSet) => {console.log("ResultSet column names: " + resultSet.columnNames)console.log("ResultSet column count: " + resultSet.columnCount)
}).catch((err) => {console.info("Query failed, err: " + err)
})

executeSql

executeSql(sql: string, bindArgs: Array, callback: AsyncCallback):void

执行包含指定参数但不返回值的SQL语句,结果以callback形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
sqlstring指定要执行的SQL语句。
bindArgsArray<[ValueType]>SQL语句中参数的值。
callbackAsyncCallback指定callback回调函数。

示例:

const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) {if (err) {console.info("ExecuteSql failed, err: " + err)return}console.info('Create table done.')
})

executeSql

executeSql(sql: string, bindArgs?: Array):Promise

执行包含指定参数但不返回值的SQL语句,结果以Promise形式返回。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
sqlstring指定要执行的SQL语句。
bindArgsArray<[ValueType]>SQL语句中参数的值。

返回值

类型说明
Promise指定Promise回调函数。

示例:

const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
let promise = rdbStore.executeSql(SQL_CREATE_TABLE)
promise.then(() => {console.info('Create table done.')
}).catch((err) => {console.info("ExecuteSql failed, err: " + err)
})

beginTransaction8+

beginTransaction():void

在开始执行SQL语句之前,开始事务。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

示例:

rdbStore.beginTransaction()
const valueBucket = {"name": "lisi","age": 18,"salary": 100.5,"blobType": new Uint8Array([1, 2, 3]),
}
rdbStore.insert("test", valueBucket, function (err, ret) {if (err) {console.info("Insert failed, err: " + err)return}console.log("Insert successfully: " + ret)
})
rdbStore.commit()

commit8+

commit():void

提交已执行的SQL语句。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

示例:

rdbStore.beginTransaction()
const valueBucket = {"name": "lisi","age": 18,"salary": 100.5,"blobType": new Uint8Array([1, 2, 3]),
}rdbStore.insert("test", valueBucket, function (err, ret) {if (err) {console.info("Insert failed, err: " + err)return}console.log("Insert successfully: " + ret)
})
rdbStore.commit()

rollBack8+

rollBack():void;

回滚已经执行的SQL语句。

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

示例:

try {rdbStore.beginTransaction()const valueBucket = {"id": 1,"name": "lisi","age": 18,"salary": 100.5,"blobType": new Uint8Array([1, 2, 3]),}rdbStore.insert("test", valueBucket, function (err, ret) {if (err) {console.info("Insert failed, err: " + err)return}console.log("Insert successfully: " + ret)})rdbStore.commit()
} catch (e) {rdbStore.rollBack()
}

setDistributedTables8+

setDistributedTables(tables: Array, callback: AsyncCallback): void

设置分布式列表,结果以callback形式返回。

需要权限:  ohos.permission.DISTRIBUTED_DATASYNC

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
tablesArray要设置的分布式列表表名
callbackAsyncCallback指定callback回调函数。

示例:

rdbStore.setDistributedTables(["EMPLOYEE"], function (err) {if (err) {console.info('SetDistributedTables failed, err: ' + err)return}console.info('SetDistributedTables successfully.')
})

setDistributedTables8+

setDistributedTables(tables: Array): Promise

设置分布式列表,结果以Promise形式返回。

需要权限:  ohos.permission.DISTRIBUTED_DATASYNC

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
tablesArray要设置的分布式列表表名。

返回值

类型说明
Promise指定Promise回调函数。

示例:

let promise = rdbStore.setDistributedTables(["EMPLOYEE"])
promise.then(() => {console.info("SetDistributedTables successfully.")
}).catch((err) => {console.info("SetDistributedTables failed, err: " + err)
})

obtainDistributedTableName8+

obtainDistributedTableName(device: string, table: string, callback: AsyncCallback): void

根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名, 结果以callback形式返回。

需要权限:  ohos.permission.DISTRIBUTED_DATASYNC

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
devicestring远程设备 。
tablestring本地表名。
callbackAsyncCallback指定的callback回调函数。如果操作成功,返回远程设备的分布式表名。

示例:

rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {if (err) {console.info('ObtainDistributedTableName failed, err: ' + err)return}console.info('ObtainDistributedTableName successfully, tableName=' + tableName)
})

obtainDistributedTableName8+

obtainDistributedTableName(device: string, table: string): Promise

根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,结果以Promise形式返回。

需要权限:  ohos.permission.DISTRIBUTED_DATASYNC

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
devicestring远程设备。
tablestring本地表名。

返回值

类型说明
Promise指定Promise回调函数。如果操作成功,返回远程设备的分布式表名。

示例:

let promise = rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE")
promise.then((tableName) => {console.info('ObtainDistributedTableName successfully, tableName=' + tableName)
}).catch((err) => {console.info('ObtainDistributedTableName failed, err: ' + err)
})

sync8+

sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array<[string, number]>>): void

在设备之间同步数据, 结果以callback形式返回。

需要权限:  ohos.permission.DISTRIBUTED_DATASYNC

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
mode[SyncMode]指同步模式。该值可以是推、拉。
predicates[RdbPredicates]约束同步数据和设备。
callbackAsyncCallback<Array<[string, number]>>指定的callback回调函数,用于向调用者发送同步结果。string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。

示例:

let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.inDevices(['12345678abcde'])
rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) {if (err) {console.log('Sync failed, err: ' + err)return}console.log('Sync done.')for (let i = 0; i < result.length; i++) {console.log('device=' + result[i][0] + ' status=' + result[i][1])}
})

sync8+

sync(mode: SyncMode, predicates: RdbPredicates): Promise<Array<[string, number]>>

在设备之间同步数据,结果以Promise形式返回。

需要权限:  ohos.permission.DISTRIBUTED_DATASYNC

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
mode[SyncMode]指同步模式。该值可以是推、拉。
predicates[RdbPredicates]约束同步数据和设备。

返回值

类型说明
Promise<Array<[string, number]>>指定Promise回调函数,用于向调用者发送同步结果。string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。

示例:

let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.inDevices(['12345678abcde'])
let promise = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates)
promise.then((result) =>{console.log('Sync done.')for (let i = 0; i < result.length; i++) {console.log('device=' + result[i][0] + ' status=' + result[i][1])}
}).catch((err) => {console.log('Sync failed')
})

on(‘dataChange’)8+

on(event: ‘dataChange’, type: SubscribeType, observer: Callback<Array>): void

注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。

需要权限:  ohos.permission.DISTRIBUTED_DATASYNC

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
eventstring取值为’dataChange’,表示数据更改。
type[SubscribeType]指在{@code SubscribeType}中定义的订阅类型。
observerCallback<Array>指分布式数据库中数据更改事件的观察者。

示例:

function storeObserver(devices) {for (let i = 0; i < devices.length; i++) {console.log('device=' + devices[i] + ' data changed')}
}
try {rdbStore.on('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {console.log('Register observer failed')
}

off(‘dataChange’)8+

off(event:‘dataChange’, type: SubscribeType, observer: Callback<Array>): void

从数据库中删除指定类型的指定观察者, 结果以callback形式返回。

需要权限:  ohos.permission.DISTRIBUTED_DATASYNC

系统能力:  SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
eventstring取值为’dataChange’,表示数据更改。
type[SubscribeType]指在{@code SubscribeType}中定义的订阅类型。
observerCallback<Array>指已注册的数据更改观察者。

示例:

function storeObserver(devices) {for (let i = 0; i < devices.length; i++) {console.log('device=' + devices[i] + ' data changed')}
}
try {rdbStore.off('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {console.log('Unregister observer failed')
}

StoreConfig

管理关系数据库配置。

系统能力:  以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

参数名类型必填说明
namestring数据库文件名。

ValueType

用于表示允许的数据字段类型。

系统能力:  以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

名称说明
number表示值类型为数字。
string表示值类型为字符。
boolean表示值类型为布尔值。

ValuesBucket

用于存储键值对。

系统能力:  以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

名称参数类型必填说明
[key: string][ValueType]Uint8Arraynull

SyncMode8+

指数据库同步模式。

系统能力:  以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

名称默认值说明
SYNC_MODE_PUSH0表示数据从本地设备推送到远程设备。
SYNC_MODE_PULL1表示数据从远程设备拉至本地设备。

SubscribeType8+

描述订阅类型。

需要权限:  ohos.permission.DISTRIBUTED_DATASYNC

系统能力:  以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

名称默认值说明
SUBSCRIBE_TYPE_REMOTE0订阅远程数据更改。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/24294.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

数据结构:哈夫曼树及其哈夫曼编码

目录 1.哈夫曼树是什么&#xff1f; 2.哈夫曼编码是什么&#xff1f; 3.哈夫曼编码的应用 4.包含头文件 5.结点设计 6.接口函数定义 7.接口函数实现 8.哈夫曼编码测试案列 哈夫曼树是什么&#xff1f; 哈夫曼树&#xff08;Huffman Tree&#xff09;是一种特殊的二叉树&#xf…

Message forwarding mechanism (消息转发机制)

iOS的消息转发机制 iOS的消息转发机制是在消息发送给对象时&#xff0c;找不到对应的实例方法的情况下启动的。消息转发允许对象在运行时处理无法识别的消息&#xff0c;提供了一种动态的、灵活的消息处理方式。 消息转发机制主要分为三个阶段&#xff1a; 动态方法解析快速…

香港高才通计划续签,很可能大部分人都要烂尾

自2022年12月28日推出以来&#xff0c;截至2024年2月29日&#xff0c;高才通计划申请人数超过了7万宗&#xff0c;获批人数将近6万。 这张表格是从2022年到2023年每个月申请人数情况&#xff0c;高峰时间段达到了一个月7166人申请&#xff1a; 香港高才通计划申请人数72508人&…

PostgreSQL基础(九):PostgreSQL的事务介绍

文章目录 PostgreSQL的事务介绍 一、什么是ACID&#xff08;常识&#xff09; 二、事务的基本使用 三、保存点&#xff08;了解&#xff09; PostgreSQL的事务介绍 一、什么是ACID&#xff08;常识&#xff09; 在日常操作中&#xff0c;对于一组相关操作&#xff0c;通常…

python数据分析-问卷数据分析(地理课)

学生问卷 分析学生背景&#xff1a;班级分布、每周地理课数量、地理成绩分布 根据问卷&#xff0c;可以知道&#xff1a; 班级分布&#xff1a; 七年级有118名学生。 八年级有107名学生。 每周地理课的数量&#xff1a; 有28名学生每周有1节地理课。 有99名学生每周有2…

重新学习STM32(2)NVIC

概念简介 NVIC&#xff0c;即嵌套向量中断控制器&#xff0c;控制着中断相关的功能&#xff0c;是内核里面的一个外设。 中断在单片机编程中的作用是使单片机能及时响应需要立即处理的事件&#xff0c;但是这些事件也分紧急和非紧急&#xff0c;因此需要优先级来区分。…

Mysql基础教程(14):UNION

MySQL UNION 的用法与实例 在本文中&#xff0c;我们讨论在 MySQL 中对两个结果集进行 UNION 运算&#xff0c;以及 UNION 运算的规则。 在 MySQL 中&#xff0c;UNION 操作符是一个集合操作符&#xff0c;它用于合并 【2 个结果集】中的所有的行。 SQL 标准中定义了 3 个集…

MongoDB 正则表达式详解:高效数据查询与处理技巧

MongoDB 的正则表达式&#xff08;Regular Expression&#xff09;功能允许在查询中进行模式匹配和文本搜索&#xff0c;为用户提供了强大的灵活性。 基本语法 MongoDB 中使用正则表达式时&#xff0c;通常是在查询语句中使用 $regex 操作符。基本语法如下&#xff1a; { &l…

Spring AI 第二讲 之 Chat Model API 第八节Anthropic 3 Chat

Anthropic Claude 是一系列基础人工智能模型&#xff0c;可用于各种应用。对于开发人员和企业来说&#xff0c;您可以利用 API 访问&#xff0c;直接在 Anthropic 的人工智能基础架构之上进行构建。 Spring AI 支持用于同步和流式文本生成的 Anthropic 消息 API。 Anthropic …

MSA(the Method of Successive Averages)算法的满足条件是怎么来的?

文章目录 摘要前言MSA算法MSA算法简介与来源算法收敛性证明使用MSA算法对确定性网络均衡问题收敛性的验证使用MSA算法对随机网络均衡问题收敛性的验证 此文章属于文献研读内容&#xff0c;文章内容来源于以下文献 Warren B. Powell, Yosef Sheffi , (1982) The Convergence of …

二轴机器人大米装箱机:技术创新引领智能包装新潮流

在科技日新月异的今天&#xff0c;自动化和智能化已成为各行各业追求高效、精准生产的关键。作为粮食加工行业的重要一环&#xff0c;大米装箱机的技术创新与应用价值日益凸显。其中&#xff0c;二轴机器人大米装箱机以其高效、稳定、智能的特点&#xff0c;成为市场的新宠。星…

Python怎么循环计数:深入解析与实践

Python怎么循环计数&#xff1a;深入解析与实践 在Python编程中&#xff0c;循环计数是一项基础且重要的技能。无论是处理列表、遍历文件&#xff0c;还是执行重复任务&#xff0c;循环计数都发挥着不可或缺的作用。本文将从四个方面、五个方面、六个方面和七个方面详细阐述Py…

Python爬虫小练习

爬虫的本质 爬虫的本质就是通过程序模拟正常人向网站发送请求获取信息。 关于爬虫的一些闲聊 按照我们的常识来说&#xff0c;我们不可能在1秒钟访问这个网站100次&#xff0c;请求100次数据&#xff0c;所以过多的请求很有可能会被网站认为你在使用脚本进行爬虫&#xff0c…

从入门到精通:基础IO

引言 在编程的世界里&#xff0c;文件输入输出&#xff08;IO&#xff09;是与操作系统交互的重要方式。无论你是开发应用程序、处理数据&#xff0c;还是管理系统资源&#xff0c;掌握文件IO操作都是必不可少的。本篇博客将带你深入了解C语言中的基础IO操作&#xff0c;从入门…

使用 IPSET 添加 CDN 节点 IP(IPv4/IPv6)到防火墙白名单

明月的服务器一直使用的是 iptables,随着近几年 IPv6 的普及&#xff0c;明月切身体会到还是 IPSET 最方便了&#xff0c;无论你是 IPv4 还是 IPv6 都可以方便的管理&#xff0c;无论你是加入白名单还是黑名单&#xff0c;都非常的简单高效&#xff01;今天就参照明月自己的实操…

东方博宜1317 - 正多边形每个内角的度数?

问题描述 根据多边形内角和定理&#xff0c;正多边形内角和等于&#xff1a;&#xff08; n&#xff0d;2 &#xff09; 180∘( n 大于等于 3 且 n 为整数&#xff09;。 请根据正多边形的边数&#xff0c;计算该正多边形每个内角的度数。&#xff08;结果保留1位小数&#x…

Python 机器学习 基础 之 【实战案例】新闻内容分类实战

Python 机器学习 基础 之 【实战案例】新闻内容分类实战 目录 Python 机器学习 基础 之 【实战案例】新闻内容分类实战 一、简单介绍 二、新闻内容分类实战 三、数据准备 四、分词与清洗工作 1、读取数据 2、使用 jieba 分词器进行分词&#xff0c;使用 Pandas 创建Data…

cesium已知两个点 写一个简单具有动画尾迹效果的抛物线

// 定义起点和终点的经纬度和高度 var start = {longitude: 111.09683723811149, latitude: 38.92112250636146, elevation: 603.5831692856873 }; var end = {longitude: 111.09769465526689, latitude: 38.92815375977821, elevation: 627.0132157062261 }; // 生成更多的中…

【亲测可用】Linux的wget太慢,使用mwget加速下载

微信公众号&#xff1a;leetcode_algos_life&#xff0c;代码随想随记 小红书&#xff1a;412408155 CSDN&#xff1a;https://blog.csdn.net/woai8339?typeblog &#xff0c;代码随想随记 GitHub: https://github.com/riverind 抖音【暂未开始&#xff0c;计划开始】&#xf…

R语言探索与分析19-CPI的分析和研究

一、选题背景 CPI&#xff08;居民消费价格指数&#xff09;作为一个重要的宏观经济指标&#xff0c;扮演着评估通货膨胀和居民生活水平的关键角色。在湖北省这个经济活跃的地区&#xff0c;CPI的波动对于居民生活、企业经营以及政府宏观经济政策制定都具有重要的影响。因此&a…