HarmonyOS API:@ohos.data.rdb (关系型数据库)

joytrian
发布于 2023-4-6 17:01
浏览
0收藏

版本:v3.1 Beta

@ohos.data.rdb (关系型数据库)

greaterThan

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

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

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

参数:

参数名

类型

必填

说明

field

string

数据库表中的列名。

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

参数:

参数名

类型

必填

说明

field

string

数据库表中的列名。

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

参数:

参数名

类型

必填

说明

field

string

数据库表中的列名。

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

参数:

参数名

类型

必填

说明

field

string

数据库表中的列名。

value

​ValueType​

指示要与谓词匹配的值。

返回值

类型

说明

​RdbPredicates​

返回与指定字段匹配的谓词。

示例:

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

orderByAsc

orderByAsc(field: string): RdbPredicates

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

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

参数:

参数名

类型

必填

说明

field

string

数据库表中的列名。

返回值

类型

说明

​RdbPredicates​

返回与指定字段匹配的谓词。

示例:

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

orderByDesc

orderByDesc(field: string): RdbPredicates

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

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

参数:

参数名

类型

必填

说明

field

string

数据库表中的列名。

返回值

类型

说明

​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()

limitAs

limitAs(value: number): RdbPredicates

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

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

参数:

参数名

类型

必填

说明

value

number

最大数据记录数。

返回值

类型

说明

​RdbPredicates​

返回可用于设置最大数据记录数的谓词。

示例:

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

offsetAs

offsetAs(rowOffset: number): RdbPredicates

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

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

参数:

参数名

类型

必填

说明

rowOffset

number

返回结果的起始位置,取值为正整数。

返回值

类型

说明

​RdbPredicates​

返回具有指定返回结果起始位置的谓词。

示例:

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

groupBy

groupBy(fields: Array<string>): RdbPredicates

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

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

参数:

参数名

类型

必填

说明

fields

Array<string>

指定分组依赖的列名。

返回值

类型

说明

​RdbPredicates​

返回分组查询列的谓词。

示例:

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

indexedBy

indexedBy(field: string): RdbPredicates

配置RdbPredicates以指定索引列。

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

参数:

参数名

类型

必填

说明

field

string

索引列的名称。

返回值

类型

说明

​RdbPredicates​

返回具有指定索引列的RdbPredicates。

示例:

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

in

in(field: string, value: Array<ValueType>): RdbPredicates

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

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

参数:

参数名

类型

必填

说明

field

string

数据库表中的列名。

value

Array<​​ValueType​​>

以ValueType型数组形式指定的要匹配的值。

返回值

类型

说明

​RdbPredicates​

返回与指定字段匹配的谓词。

示例:

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

notIn

notIn(field: string, value: Array<ValueType>): RdbPredicates

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

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

参数:

参数名

类型

必填

说明

field

string

数据库表中的列名。

value

Array<​​ValueType​​>

以ValueType数组形式指定的要匹配的值。

返回值

类型

说明

​RdbPredicates​

返回与指定字段匹配的谓词。

示例:

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

RdbStore

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

在使用以下相关接口前,请使用​​executeSql​​​接口初始化数据库表结构和相关数据,具体可见​​关系型数据库开发指导​​。

insert

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

向目标表中插入一行数据,使用callback异步回调。

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

参数:

参数名

类型

必填

说明

table

string

指定的目标表名。

values

​ValuesBucket​

表示要插入到表中的数据行。

callback

AsyncCallback<number>

指定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 (status, rowId) {
    if (status) {
        console.log("Insert is failed");
        return;
    }
    console.log("Insert is successful, rowId = " + rowId);
})

insert

insert(table: string, values: ValuesBucket):Promise<number>

向目标表中插入一行数据,使用Promise异步回调。

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

参数:

参数名

类型

必填

说明

table

string

指定的目标表名。

values

​ValuesBucket​

表示要插入到表中的数据行。

返回值

类型

说明

Promise<number>

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((rowId) => {
    console.log("Insert is successful, rowId = " + rowId);
}).catch((status) => {
    console.log("Insert is failed");
})

batchInsert

batchInsert(table: string, values: Array<ValuesBucket>, callback: AsyncCallback<number>):void

向目标表中插入一组数据,使用callback异步回调。

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

参数:

参数名

类型

必填

说明

table

string

指定的目标表名。

values

Array<​​ValuesBucket​​>

表示要插入到表中的一组数据。

callback

AsyncCallback<number>

指定callback回调函数。如果操作成功,返回插入的数据个数,否则返回-1。

示例:

const valueBucket1 = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5])
}
const valueBucket2 = {
    "NAME": "Jack",
    "AGE": 19,
    "SALARY": 101.5,
    "CODES": new Uint8Array([6, 7, 8, 9, 10])
}
const valueBucket3 = {
    "NAME": "Tom",
    "AGE": 20,
    "SALARY": 102.5,
    "CODES": new Uint8Array([11, 12, 13, 14, 15])
}

let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
rdbStore.batchInsert("EMPLOYEE", valueBuckets, function(status, insertNum) {
    if (status) {
        console.log("batchInsert is failed, status = " + status);
        return;
    }
    console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
})

batchInsert

batchInsert(table: string, values: Array<ValuesBucket>):Promise<number>

向目标表中插入一组数据,使用Promise异步回调。

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

参数:

参数名

类型

必填

说明

table

string

指定的目标表名。

values

Array<​​ValuesBucket​​>

表示要插入到表中的一组数据。

返回值

类型

说明

Promise<number>

Promise对象。如果操作成功,返回插入的数据个数,否则返回-1。

示例:

const valueBucket1 = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5])
}
const valueBucket2 = {
    "NAME": "Jack",
    "AGE": 19,
    "SALARY": 101.5,
    "CODES": new Uint8Array([6, 7, 8, 9, 10])
}
const valueBucket3 = {
    "NAME": "Tom",
    "AGE": 20,
    "SALARY": 102.5,
    "CODES": new Uint8Array([11, 12, 13, 14, 15])
}

let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
let promise = rdbStore.batchInsert("EMPLOYEE", valueBuckets);
promise.then((insertNum) => {
    console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
}).catch((status) => {
    console.log("batchInsert is failed, status = " + status);
})

update

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

根据RdbPredicates的指定实例对象更新数据库中的数据,使用callback异步回调。

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

参数:

参数名

类型

必填

说明

values

​ValuesBucket​

values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。

predicates

​RdbPredicates​

RdbPredicates的实例对象指定的更新条件。

callback

AsyncCallback<number>

指定的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<number>

根据RdbPredicates的指定实例对象更新数据库中的数据,使用Promise异步回调。

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

参数:

参数名

类型

必填

说明

values

​ValuesBucket​

values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。

predicates

​RdbPredicates​

RdbPredicates的实例对象指定的更新条件。

返回值

类型

说明

Promise<number>

指定的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<number>):void

根据RdbPredicates的指定实例对象从数据库中删除数据,使用callback异步回调。

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

参数:

参数名

类型

必填

说明

predicates

​RdbPredicates​

RdbPredicates的实例对象指定的删除条件。

callback

AsyncCallback<number>

指定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<number>

根据RdbPredicates的指定实例对象从数据库中删除数据,使用Promise异步回调。

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

参数:

参数名

类型

必填

说明

predicates

​RdbPredicates​

RdbPredicates的实例对象指定的删除条件。

返回值

类型

说明

Promise<number>

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<string>, callback: AsyncCallback<ResultSet>):void

根据指定条件查询数据库中的数据,使用callback异步回调。

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

参数:

参数名

类型

必填

说明

predicates

​RdbPredicates​

RdbPredicates的实例对象指定的查询条件。

columns

Array<string>

表示要查询的列。如果值为空,则查询应用于所有列。

callback

AsyncCallback<​​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<string>):Promise<ResultSet>

根据指定条件查询数据库中的数据,使用Promise异步回调。

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

参数:

参数名

类型

必填

说明

predicates

​RdbPredicates​

RdbPredicates的实例对象指定的查询条件。

columns

Array<string>

表示要查询的列。如果值为空,则查询应用于所有列。

返回值

类型

说明

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<ValueType>, callback: AsyncCallback<ResultSet>):void

根据指定SQL语句查询数据库中的数据,使用callback异步回调。

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

参数:

参数名

类型

必填

说明

sql

string

指定要执行的SQL语句。

bindArgs

Array<​​ValueType​​>

SQL语句中参数的值。

callback

AsyncCallback<​​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<ValueType>):Promise<ResultSet>

根据指定SQL语句查询数据库中的数据,使用Promise异步回调。

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

参数:

参数名

类型

必填

说明

sql

string

指定要执行的SQL语句。

bindArgs

Array<​​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)
})

executeSql8+

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

执行包含指定参数但不返回值的SQL语句,使用callback异步回调。

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

参数:

参数名

类型

必填

说明

sql

string

指定要执行的SQL语句。

bindArgs

Array<​​ValueType​​>

SQL语句中参数的值。

callback

AsyncCallback<void>

指定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.')
})

executeSql8+

executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void>

执行包含指定参数但不返回值的SQL语句,使用Promise异步回调。

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

参数:

参数名

类型

必填

说明

sql

string

指定要执行的SQL语句。

bindArgs

Array<​​ValueType​​>

SQL语句中参数的值。

返回值

类型

说明

Promise<void>

无返回结果的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

示例:

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
    rdbStore.beginTransaction()
    const valueBucket = {
        "name": "lisi",
        "age": 18,
        "salary": 100.5,
        "blobType": new Uint8Array([1, 2, 3]),
    }
    await rdbStore.insert("test", valueBucket)
    rdbStore.commit()
})

commit8+

commit():void

提交已执行的SQL语句。

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

示例:

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
    rdbStore.beginTransaction()
    const valueBucket = {
        "name": "lisi",
        "age": 18,
        "salary": 100.5,
        "blobType": new Uint8Array([1, 2, 3]),
    }
    await rdbStore.insert("test", valueBucket)
    rdbStore.commit()
})

rollBack8+

rollBack():void

回滚已经执行的SQL语句。

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

示例:

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
    try {
        rdbStore.beginTransaction()
        const valueBucket = {
            "id": 1,
            "name": "lisi",
            "age": 18,
            "salary": 100.5,
            "blobType": new Uint8Array([1, 2, 3]),
        }
        await rdbStore.insert("test", valueBucket)
        rdbStore.commit()
    } catch (e) {
        rdbStore.rollBack()
    }
})

setDistributedTables8+

setDistributedTables(tables: Array<string>, callback: AsyncCallback<void>): void

设置分布式列表,使用callback异步回调。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

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

参数:

参数名

类型

必填

说明

tables

Array<string>

要设置的分布式列表表名

callback

AsyncCallback<void>

指定callback回调函数。

示例:

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

setDistributedTables8+

setDistributedTables(tables: Array<string>): Promise<void>

设置分布式列表,使用Promise异步回调。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

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

参数:

参数名

类型

必填

说明

tables

Array<string>

要设置的分布式列表表名。

返回值

类型

说明

Promise<void>

无返回结果的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<string>): void

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

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

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

参数:

参数名

类型

必填

说明

device

string

远程设备 。

table

string

本地表名。

callback

AsyncCallback<string>

指定的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<string>

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

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

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

参数:

参数名

类型

必填

说明

device

string

远程设备。

table

string

本地表名。

返回值

类型

说明

Promise<string>

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​

约束同步数据和设备。

callback

AsyncCallback<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<string>>): void

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

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

参数:

参数名

类型

必填

说明

event

string

取值为'dataChange',表示数据更改。

type

​SubscribeType​

订阅类型。

observer

Callback<Array<string>>

指分布式数据库中数据更改事件的观察者。

示例:

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<string>>): void

从数据库中删除指定类型的指定观察者, 使用callback异步回调。

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

参数:

参数名

类型

必填

说明

event

string

取值为'dataChange',表示数据更改。

type

​SubscribeType​

订阅类型。

observer

Callback<Array<string>>

指已注册的数据更改观察者。

示例:

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

名称

类型

必填

说明

name

string

数据库文件名。


文件转载自:​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-data-rdb-0000001478181637-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001478181637__storeconfigdeprecated​

已于2023-4-6 17:01:01修改
收藏
回复
举报
回复
    相关推荐