關(guān)系型數(shù)據(jù)庫

關(guān)系型數(shù)據(jù)庫（Relational Database，RDB）是一種基于關(guān)系模型來管理數(shù)據(jù)的數(shù)據(jù)庫。關(guān)系型數(shù)據(jù)庫基于SQLite組件提供了一套完整的對本地數(shù)據(jù)庫進(jìn)行管理的機制，對外提供了一系列的增、刪、改、查等接口，也可以直接運行用戶輸入的SQL語句來滿足復(fù)雜的場景需要。

該模塊提供以下關(guān)系型數(shù)據(jù)庫相關(guān)的常用功能：

• [RdbPredicates]： 數(shù)據(jù)庫中用來代表數(shù)據(jù)實體的性質(zhì)、特征或者數(shù)據(jù)實體之間關(guān)系的詞項，主要用來定義數(shù)據(jù)庫的操作條件。
• [RdbStore]：提供管理關(guān)系數(shù)據(jù)庫(RDB)方法的接口。

說明：
開發(fā)前請熟悉鴻蒙開發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨標(biāo)記接口的起始版本。

導(dǎo)入模塊

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

data_rdb.getRdbStore

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

獲得一個相關(guān)的RdbStore，操作關(guān)系型數(shù)據(jù)庫，用戶可以根據(jù)自己的需求配置RdbStore的參數(shù)，然后通過RdbStore調(diào)用相關(guān)接口可以執(zhí)行相關(guān)的數(shù)據(jù)操作，結(jié)果以callback形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

獲得一個相關(guān)的RdbStore，操作關(guān)系型數(shù)據(jù)庫，用戶可以根據(jù)自己的需求配置RdbStore的參數(shù)，然后通過RdbStore調(diào)用相關(guān)接口可以執(zhí)行相關(guān)的數(shù)據(jù)操作，結(jié)果以Promise形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

刪除數(shù)據(jù)庫，結(jié)果以callback形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

使用指定的數(shù)據(jù)庫文件配置刪除數(shù)據(jù)庫，結(jié)果以Promise形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)

返回值 ：

示例：

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

表示關(guān)系型數(shù)據(jù)庫（RDB）的謂詞。該類確定RDB中條件表達(dá)式的值是true還是false。

constructor

constructor(name: string)

構(gòu)造函數(shù)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

inDevices8+

inDevices(devices: Array): RdbPredicates

同步分布式數(shù)據(jù)庫時指定組網(wǎng)內(nèi)的遠(yuǎn)程設(shè)備。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

inAllDevices8+

inAllDevices(): RdbPredicates

同步分布式數(shù)據(jù)庫時連接到組網(wǎng)內(nèi)的所有遠(yuǎn)程設(shè)備。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值 ：

示例：

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

equalTo

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

配置謂詞以匹配數(shù)據(jù)字段為ValueType且值等于指定值的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

notEqualTo

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

配置謂詞以匹配數(shù)據(jù)字段為ValueType且值不等于指定值的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

beginWrap

beginWrap(): RdbPredicates

向謂詞添加左括號。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值 ：

示例：

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

endWrap

endWrap(): RdbPredicates

向謂詞添加右括號。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值 ：

示例：

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

or

or(): RdbPredicates

將或條件添加到謂詞中。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值 ：

示例：

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

and

and(): RdbPredicates

向謂詞添加和條件。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值 ：

示例：

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

contains

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

配置謂詞以匹配數(shù)據(jù)字段為string且value包含指定值的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

beginsWith

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

配置謂詞以匹配數(shù)據(jù)字段為string且值以指定字符串開頭的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

endsWith

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

配置謂詞以匹配數(shù)據(jù)字段為string且值以指定字符串結(jié)尾的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

isNull

isNull(field: string): RdbPredicates

配置謂詞以匹配值為null的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

• 示例

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

isNotNull

isNotNull(field: string): RdbPredicates

配置謂詞以匹配值不為null的指定字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

like

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

配置謂詞以匹配數(shù)據(jù)字段為string且值類似于指定字符串的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

glob

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

配置RdbPredicates匹配數(shù)據(jù)字段為string的指定字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

between

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

將謂詞配置為匹配數(shù)據(jù)字段為ValueType且value在給定范圍內(nèi)的指定字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

notBetween

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

配置RdbPredicates以匹配數(shù)據(jù)字段為ValueType且value超出給定范圍的指定字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

greaterThan

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

配置謂詞以匹配數(shù)據(jù)字段為ValueType且值大于指定值的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

lessThan

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

配置謂詞以匹配數(shù)據(jù)字段為valueType且value小于指定值的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

greaterThanOrEqualTo

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

配置謂詞以匹配數(shù)據(jù)字段為ValueType且value大于或等于指定值的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

lessThanOrEqualTo

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

配置謂詞以匹配數(shù)據(jù)字段為ValueType且value小于或等于指定值的字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

orderByAsc

orderByAsc(field: string): RdbPredicates

配置謂詞以匹配其值按升序排序的列。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

orderByDesc

orderByDesc(field: string): RdbPredicates

配置謂詞以匹配其值按降序排序的列。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

distinct

distinct(): RdbPredicates

配置謂詞以過濾重復(fù)記錄并僅保留其中一個。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值 ：

示例：

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

設(shè)置最大數(shù)據(jù)記錄數(shù)的謂詞。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

offsetAs

offsetAs(rowOffset: number): RdbPredicates

配置RdbPredicates以指定返回結(jié)果的起始位置。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

groupBy

groupBy(fields: Array): RdbPredicates

配置RdbPredicates按指定列分組查詢結(jié)果。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

indexedBy

indexedBy(field: string): RdbPredicates

配置RdbPredicates以指定索引列。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

in

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

配置RdbPredicates以匹配數(shù)據(jù)字段為ValueType數(shù)組且值在給定范圍內(nèi)的指定字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

notIn

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

將RdbPredicates配置為匹配數(shù)據(jù)字段為ValueType且值超出給定范圍的指定字段。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

RdbStore

提供管理關(guān)系數(shù)據(jù)庫(RDB)方法的接口。

insert

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

向目標(biāo)表中插入一行數(shù)據(jù)，結(jié)果以callback形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

向目標(biāo)表中插入一行數(shù)據(jù)，結(jié)果以Promise形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

根據(jù)RdbPredicates的指定實例對象更新數(shù)據(jù)庫中的數(shù)據(jù)，結(jié)果以callback形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

根據(jù)RdbPredicates的指定實例對象更新數(shù)據(jù)庫中的數(shù)據(jù)，結(jié)果以Promise形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

根據(jù)RdbPredicates的指定實例對象從數(shù)據(jù)庫中刪除數(shù)據(jù)，結(jié)果以callback形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

根據(jù)RdbPredicates的指定實例對象從數(shù)據(jù)庫中刪除數(shù)據(jù)，結(jié)果以Promise形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

根據(jù)指定條件查詢數(shù)據(jù)庫中的數(shù)據(jù)，結(jié)果以callback形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

根據(jù)指定條件查詢數(shù)據(jù)庫中的數(shù)據(jù)，結(jié)果以Promise形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

根據(jù)指定SQL語句查詢數(shù)據(jù)庫中的數(shù)據(jù)，結(jié)果以callback形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

根據(jù)指定SQL語句查詢數(shù)據(jù)庫中的數(shù)據(jù)，結(jié)果以Promise形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

執(zhí)行包含指定參數(shù)但不返回值的SQL語句，結(jié)果以callback形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

執(zhí)行包含指定參數(shù)但不返回值的SQL語句，結(jié)果以Promise形式返回。

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

在開始執(zhí)行SQL語句之前，開始事務(wù)。

系統(tǒng)能力： 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

提交已執(zhí)行的SQL語句。

系統(tǒng)能力： 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;

回滾已經(jīng)執(zhí)行的SQL語句。

系統(tǒng)能力： 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

設(shè)置分布式列表，結(jié)果以callback形式返回。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

setDistributedTables8+

setDistributedTables(tables: Array): Promise

設(shè)置分布式列表，結(jié)果以Promise形式返回。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

根據(jù)本地表名獲取指定遠(yuǎn)程設(shè)備的分布式表名。在查詢遠(yuǎn)程設(shè)備數(shù)據(jù)庫時，需要使用分布式表名, 結(jié)果以callback形式返回。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

根據(jù)本地表名獲取指定遠(yuǎn)程設(shè)備的分布式表名。在查詢遠(yuǎn)程設(shè)備數(shù)據(jù)庫時，需要使用分布式表名，結(jié)果以Promise形式返回。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

在設(shè)備之間同步數(shù)據(jù), 結(jié)果以callback形式返回。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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>

在設(shè)備之間同步數(shù)據(jù)，結(jié)果以Promise形式返回。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

返回值 ：

示例：

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

注冊數(shù)據(jù)庫的觀察者。當(dāng)分布式數(shù)據(jù)庫中的數(shù)據(jù)發(fā)生更改時，將調(diào)用回調(diào)。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

從數(shù)據(jù)庫中刪除指定類型的指定觀察者, 結(jié)果以callback形式返回。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC

系統(tǒng)能力： SystemCapability.DistributedDataManager.RelationalStore.Core。

參數(shù)：

示例：

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

管理關(guān)系數(shù)據(jù)庫配置。

系統(tǒng)能力： 以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.DistributedDataManager.RelationalStore.Core。

ValueType

用于表示允許的數(shù)據(jù)字段類型。

系統(tǒng)能力： 以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.DistributedDataManager.RelationalStore.Core。

ValuesBucket

用于存儲鍵值對。

系統(tǒng)能力： 以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.DistributedDataManager.RelationalStore.Core。

SyncMode8+

指數(shù)據(jù)庫同步模式。

系統(tǒng)能力： 以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.DistributedDataManager.RelationalStore.Core。

SubscribeType8+

描述訂閱類型。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC

系統(tǒng)能力： 以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.DistributedDataManager.RelationalStore.Core。

審核編輯 黃宇