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

2024-06-07 23:52

本文主要是介绍鸿蒙开发接口数据管理:【@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订阅远程数据更改。

这篇关于鸿蒙开发接口数据管理:【@ohos.data.rdb (关系型数据库)】的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1040660

相关文章

关于如何更好管理好数据库的一点思考

本文尝试从数据库设计理论、ER图简介、性能优化、避免过度设计及权限管理方面进行思考阐述。 一、数据库范式 以下通过详细的示例说明数据库范式的概念,将逐步规范化一个例子,逐级说明每个范式的要求和变换过程。 示例:学生课程登记系统 初始表格如下: 学生ID学生姓名课程ID课程名称教师教师办公室1张三101数学王老师101室2李四102英语李老师102室3王五101数学王老师101室4赵六103物理陈

数据库期末复习知识点

A卷 1. 选择题(30') 2. 判断范式(10') 判断到第三范式 3. 程序填空(20') 4. 分析填空(15') 5. 写SQL(25') 5'一题 恶性 B卷 1. 单选(30') 2. 填空 (20') 3. 程序填空(20') 4. 写SQL(30') 知识点 第一章 数据库管理系统(DBMS)  主要功能 数据定义功能 (DDL, 数据定义语

给数据库的表添加字段

周五有一个需求是这样的: 原来数据库有一个表B,现在需要添加一个字段C,我把代码中增删改查部分进行了修改, 比如insert中也添入了字段C。 但没有考虑到一个问题,数据库的兼容性。因为之前的版本已经投入使用了,再升级的话,需要进行兼容处理,当时脑子都蒙了,转不过来,后来同事解决了这个问题。 现在想想,思路就是,把数据库的表结构存入文件中,如xxx.sql 实时更新该文件: CREAT

Eclipse+ADT与Android Studio开发的区别

下文的EA指Eclipse+ADT,AS就是指Android Studio。 就编写界面布局来说AS可以边开发边预览(所见即所得,以及多个屏幕预览),这个优势比较大。AS运行时占的内存比EA的要小。AS创建项目时要创建gradle项目框架,so,创建项目时AS比较慢。android studio基于gradle构建项目,你无法同时集中管理和维护多个项目的源码,而eclipse ADT可以同时打开

Python应用开发——30天学习Streamlit Python包进行APP的构建(9)

st.area_chart 显示区域图。 这是围绕 st.altair_chart 的语法糖。主要区别在于该命令使用数据自身的列和指数来计算图表的 Altair 规格。因此,在许多 "只需绘制此图 "的情况下,该命令更易于使用,但可定制性较差。 如果 st.area_chart 无法正确猜测数据规格,请尝试使用 st.altair_chart 指定所需的图表。 Function signa

SQL Server中,查询数据库中有多少个表,以及数据库其余类型数据统计查询

sqlserver查询数据库中有多少个表 sql server 数表:select count(1) from sysobjects where xtype='U'数视图:select count(1) from sysobjects where xtype='V'数存储过程select count(1) from sysobjects where xtype='P' SE

SQL Server中,添加数据库到AlwaysOn高可用性组条件

1、将数据添加到AlwaysOn高可用性组,需要满足以下条件: 2、更多具体AlwaysOn设置,参考:https://msdn.microsoft.com/zh-cn/library/windows/apps/ff878487(v=sql.120).aspx 注:上述资源来自MSDN。

SQL Server中,用Restore DataBase把数据库还原到指定的路径

restore database 数据库名 from disk='备份文件路径' with move '数据库文件名' to '数据库文件放置路径', move '日志文件名' to '日志文件存放置路径' Go 如: restore database EaseWe from disk='H:\EaseWe.bak' with move 'Ease

vue3项目将所有访问后端springboot的接口统一管理带跨域

vue3项目将所有访问后端springboot的接口统一管理带跨域 一、前言1.安装Axios2.创建Axios实例3.创建API服务文件4.在组件中使用API服务 二、跨域三、总结 一、前言 在Vue 3项目中,统一管理所有访问后端Spring Boot接口的最佳实践是创建一个专门的API服务层。这可以让你的代码更加模块化、可维护和集中管理。你可以使用Axios库作为HTT

数据库原理与安全复习笔记(未完待续)

1 概念 产生与发展:人工管理阶段 → \to → 文件系统阶段 → \to → 数据库系统阶段。 数据库系统特点:数据的管理者(DBMS);数据结构化;数据共享性高,冗余度低,易于扩充;数据独立性高。DBMS 对数据的控制功能:数据的安全性保护;数据的完整性检查;并发控制;数据库恢复。 数据库技术研究领域:数据库管理系统软件的研发;数据库设计;数据库理论。数据模型要素 数据结构:描述数据库