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

導(dǎo)入模塊

import relationalStore from '@ohos.data.relationalStore'

relationalStore.getRdbStore

getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback<RdbStore>): void

獲得一個(gè)相關(guān)的RdbStore，操作關(guān)系型數(shù)據(jù)庫(kù)，用戶可以根據(jù)自己的需求配置RdbStore的參數(shù)，然后通過(guò)RdbStore調(diào)用相關(guān)接口可以執(zhí)行相關(guān)的數(shù)據(jù)操作，使用callback異步回調(diào)。

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

參數(shù)：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)關(guān)系型數(shù)據(jù)庫(kù)錯(cuò)誤碼。

示例：

FA模型示例：

import featureAbility from '@ohos.ability.featureAbility'

var store;

// 獲取context
let context = featureAbility.getContext();

const STORE_CONFIG = {
  name: "RdbTest.db",
  securityLevel: relationalStore.SecurityLevel.S1
};

relationalStore.getRdbStore(context, STORE_CONFIG, function (err, rdbStore) {
  store = rdbStore;
  if (err) {
    console.error(`Get RdbStore failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`Get RdbStore successfully.`);
})

Stage模型示例：

import UIAbility from '@ohos.app.ability.UIAbility'

class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage) {
    var store;
    const STORE_CONFIG = {
      name: "RdbTest.db",
      securityLevel: relationalStore.SecurityLevel.S1
    };
        
    relationalStore.getRdbStore(this.context, STORE_CONFIG, function (err, rdbStore) {
      store = rdbStore;
      if (err) {
        console.error(`Get RdbStore failed, code is ${err.code},message is ${err.message}`);
        return;
      }
      console.info(`Get RdbStore successfully.`);
    })
  }
}

relationalStore.getRdbStore

getRdbStore(context: Context, config: StoreConfig): Promise<RdbStore>

獲得一個(gè)相關(guān)的RdbStore，操作關(guān)系型數(shù)據(jù)庫(kù)，用戶可以根據(jù)自己的需求配置RdbStore的參數(shù)，然后通過(guò)RdbStore調(diào)用相關(guān)接口可以執(zhí)行相關(guān)的數(shù)據(jù)操作，使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)關(guān)系型數(shù)據(jù)庫(kù)錯(cuò)誤碼。

示例：

FA模型示例：

import featureAbility from '@ohos.ability.featureAbility'

var store;

// 獲取context
let context = featureAbility.getContext();

const STORE_CONFIG = {
  name: "RdbTest.db",
  securityLevel: relationalStore.SecurityLevel.S1
};

let promise = relationalStore.getRdbStore(context, STORE_CONFIG);
promise.then(async (rdbStore) => {
  store = rdbStore;
  console.info(`Get RdbStore successfully.`);
}).catch((err) => {
  console.error(`Get RdbStore failed, code is ${err.code},message is ${err.message}`);
})

Stage模型示例：

import UIAbility from '@ohos.app.ability.UIAbility'

class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage) {
    var store;
    const STORE_CONFIG = {
      name: "RdbTest.db",
      securityLevel: relationalStore.SecurityLevel.S1
    };
        
    let promise = relationalStore.getRdbStore(this.context, STORE_CONFIG);
    promise.then(async (rdbStore) => {
      store = rdbStore;
      console.info(`Get RdbStore successfully.`)
    }).catch((err) => {
      console.error(`Get RdbStore failed, code is ${err.code},message is ${err.message}`);
    })
  }
}

relationalStore.deleteRdbStore

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

刪除數(shù)據(jù)庫(kù)，使用callback異步回調(diào)。

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

參數(shù)：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)關(guān)系型數(shù)據(jù)庫(kù)錯(cuò)誤碼。

示例：

FA模型示例：

import featureAbility from '@ohos.ability.featureAbility'

// 獲取context
let context = featureAbility.getContext()

relationalStore.deleteRdbStore(context, "RdbTest.db", function (err) {
  if (err) {
    console.error(`Delete RdbStore failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`Delete RdbStore successfully.`);
})

Stage模型示例：

import UIAbility from '@ohos.app.ability.UIAbility'

class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    relationalStore.deleteRdbStore(this.context, "RdbTest.db", function (err) {
      if (err) {
        console.error(`Delete RdbStore failed, code is ${err.code},message is ${err.message}`);
        return;
      }
      console.info(`Delete RdbStore successfully.`);
    })
  }
}

relationalStore.deleteRdbStore

deleteRdbStore(context: Context, name: string): Promise<void>

使用指定的數(shù)據(jù)庫(kù)文件配置刪除數(shù)據(jù)庫(kù)，使用Promise異步回調(diào)。

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

參數(shù)

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)關(guān)系型數(shù)據(jù)庫(kù)錯(cuò)誤碼。

示例：

FA模型示例：

import featureAbility from '@ohos.ability.featureAbility'

// 獲取context
let context = featureAbility.getContext();

let promise = relationalStore.deleteRdbStore(context, "RdbTest.db");
promise.then(()=>{
  console.info(`Delete RdbStore successfully.`);
}).catch((err) => {
  console.error(`Delete RdbStore failed, code is ${err.code},message is ${err.message}`);
})

Stage模型示例：

import UIAbility from '@ohos.app.ability.UIAbility'

class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    let promise = relationalStore.deleteRdbStore(this.context, "RdbTest.db");
    promise.then(()=>{
      console.info(`Delete RdbStore successfully.`);
    }).catch((err) => {
      console.error(`Delete RdbStore failed, code is ${err.code},message is ${err.message}`);
    })
  }
}

StoreConfig

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

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

SecurityLevel

數(shù)據(jù)庫(kù)的安全級(jí)別枚舉。

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

ValueType

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

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

ValuesBucket

用于存儲(chǔ)鍵值對(duì)的類型。該類型不是多線程安全的，如果應(yīng)用中存在多線程同時(shí)操作該類派生出的實(shí)例，注意加鎖保護(hù)。

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

SyncMode

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

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

SubscribeType

描述訂閱類型。

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

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

RdbPredicates

表示關(guān)系型數(shù)據(jù)庫(kù)（RDB）的謂詞。該類確定RDB中條件表達(dá)式的值是true還是false。該類型不是多線程安全的，如果應(yīng)用中存在多線程同時(shí)操作該類派生出的實(shí)例，注意加鎖保護(hù)。

constructor

constructor(name: string)

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

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

參數(shù)：

示例：

let predicates = new relationalStore.RdbPredicates("EMPLOYEE");

inDevices

inDevices(devices: Array<string>): RdbPredicates

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

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

參數(shù)：

返回值：

示例：

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

inAllDevices

inAllDevices(): RdbPredicates

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

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

返回值：

示例：

let predicates = new relationalStore.RdbPredicates("EMPLOYEE");
predicates.inAllDevices();

equalTo

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

配置謂詞以匹配數(shù)據(jù)表的field列中值為value的字段。

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

參數(shù)：

返回值：

示例：

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

notEqualTo

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

配置謂詞以匹配數(shù)據(jù)表的field列中值不為value的字段。

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

參數(shù)：

返回值：

示例：

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

beginWrap

beginWrap(): RdbPredicates

向謂詞添加左括號(hào)。

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

返回值：

示例：

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

endWrap

endWrap(): RdbPredicates

向謂詞添加右括號(hào)。

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

返回值：

示例：

let predicates = new relationalStore.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 relationalStore.RdbPredicates("EMPLOYEE");
predicates.equalTo("NAME", "Lisa")
    .or()
    .equalTo("NAME", "Rose")

and

and(): RdbPredicates

向謂詞添加和條件。

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

返回值：

示例：

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

contains

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

配置謂詞以匹配數(shù)據(jù)表的field列中包含value的字段。

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

參數(shù)：

返回值：

示例：

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

beginsWith

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

配置謂詞以匹配數(shù)據(jù)表的field列中以value開頭的字段。

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

參數(shù)：

返回值：

示例：

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

endsWith

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

配置謂詞以匹配數(shù)據(jù)表的field列中以value結(jié)尾的字段。

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

參數(shù)：

返回值：

示例：

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

isNull

isNull(field: string): RdbPredicates

配置謂詞以匹配數(shù)據(jù)表的field列中值為null的字段。

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

參數(shù)：

返回值：

示例：

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

isNotNull

isNotNull(field: string): RdbPredicates

配置謂詞以匹配數(shù)據(jù)表的field列中值不為null的字段。

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

參數(shù)：

返回值：

示例：

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

like

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

配置謂詞以匹配數(shù)據(jù)表的field列中值類似于value的字段。

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

參數(shù)：

返回值：

示例：

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

glob

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

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

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

參數(shù)：

返回值：

示例：

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

between

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

配置謂詞以匹配數(shù)據(jù)表的field列中值在給定范圍內(nèi)的字段。

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

參數(shù)：

返回值：

示例：

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

notBetween

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

配置謂詞以匹配數(shù)據(jù)表的field列中值超出給定范圍的字段。

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

參數(shù)：

返回值：

示例：

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

greaterThan

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

配置謂詞以匹配數(shù)據(jù)表的field列中值大于value的字段。

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

參數(shù)：

返回值：

示例：

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

lessThan

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

配置謂詞以匹配數(shù)據(jù)表的field列中值小于value的字段。

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

參數(shù)：

返回值：

示例：

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

greaterThanOrEqualTo

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

配置謂詞以匹配數(shù)據(jù)表的field列中值大于或者等于value的字段。

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

參數(shù)：

返回值：

示例：

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

lessThanOrEqualTo

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

配置謂詞以匹配數(shù)據(jù)表的field列中值小于或者等于value的字段。

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

參數(shù)：

返回值：

示例：

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

orderByAsc

orderByAsc(field: string): RdbPredicates

配置謂詞以匹配數(shù)據(jù)表的field列中值按升序排序的列。

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

參數(shù)：

返回值：

示例：

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

orderByDesc

orderByDesc(field: string): RdbPredicates

配置謂詞以匹配數(shù)據(jù)表的field列中值按降序排序的列。

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

參數(shù)：

返回值：

示例：

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

distinct

distinct(): RdbPredicates

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

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

返回值：

示例：

let predicates = new relationalStore.RdbPredicates("EMPLOYEE");
predicates.equalTo("NAME", "Rose").distinct();

limitAs

limitAs(value: number): RdbPredicates

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

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

參數(shù)：

返回值：

示例：

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

offsetAs

offsetAs(rowOffset: number): RdbPredicates

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

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

參數(shù)：

返回值：

示例：

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

groupBy

groupBy(fields: Array<string>): RdbPredicates

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

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

參數(shù)：

返回值：

示例：

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

indexedBy

indexedBy(field: string): RdbPredicates

配置謂詞以指定索引列。

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

參數(shù)：

返回值：

示例：

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

in

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

配置謂詞以匹配數(shù)據(jù)表的field列中值在給定范圍內(nèi)的字段。

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

參數(shù)：

返回值：

示例：

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

notIn

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

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

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

參數(shù)：

返回值：

示例：

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

RdbStore

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

在使用以下相關(guān)接口前，請(qǐng)使用executeSql接口初始化數(shù)據(jù)庫(kù)表結(jié)構(gòu)和相關(guān)數(shù)據(jù)，具體可見(jiàn)通過(guò)關(guān)系型數(shù)據(jù)庫(kù)實(shí)現(xiàn)數(shù)據(jù)持久化。

insert

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

向目標(biāo)表中插入一行數(shù)據(jù)，使用callback異步回調(diào)。

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

參數(shù)：

示例：

const valueBucket = {
  "NAME": "Lisa",
  "AGE": 18,
  "SALARY": 100.5,
  "CODES": new Uint8Array([1, 2, 3, 4, 5]),
};
store.insert("EMPLOYEE", valueBucket, function (err, rowId) {
  if (err) {
    console.error(`Insert is failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`Insert is successful, rowId = ${rowId}`);
})

insert

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

向目標(biāo)表中插入一行數(shù)據(jù)，使用Promise異步回調(diào)。

系統(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 = store.insert("EMPLOYEE", valueBucket);
promise.then((rowId) => {
  console.info(`Insert is successful, rowId = ${rowId}`);
}).catch((err) => {
  console.error(`Insert is failed, code is ${err.code},message is ${err.message}`);
})

batchInsert

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

向目標(biāo)表中插入一組數(shù)據(jù)，使用callback異步回調(diào)。

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

參數(shù)：

示例：

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);
store.batchInsert("EMPLOYEE", valueBuckets, function(err, insertNum) {
  if (err) {
    console.error(`batchInsert is failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`batchInsert is successful, the number of values that were inserted = ${insertNum}`);
})

batchInsert

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

向目標(biāo)表中插入一組數(shù)據(jù)，使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

示例：

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 = store.batchInsert("EMPLOYEE", valueBuckets);
promise.then((insertNum) => {
  console.info(`batchInsert is successful, the number of values that were inserted = ${insertNum}`);
}).catch((err) => {
  console.error(`batchInsert is failed, code is ${err.code},message is ${err.message}`);
})

update

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

根據(jù)RdbPredicates的指定實(shí)例對(duì)象更新數(shù)據(jù)庫(kù)中的數(shù)據(jù)，使用callback異步回調(diào)。

系統(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 relationalStore.RdbPredicates("EMPLOYEE");
predicates.equalTo("NAME", "Lisa");
store.update(valueBucket, predicates, function (err, rows) {
  if (err) {
    console.error(`Updated failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`Updated row count: ${rows}`);
})

update

update(values: ValuesBucket, predicates: RdbPredicates):Promise<number>

根據(jù)RdbPredicates的指定實(shí)例對(duì)象更新數(shù)據(jù)庫(kù)中的數(shù)據(jù)，使用Promise異步回調(diào)。

系統(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 relationalStore.RdbPredicates("EMPLOYEE");
predicates.equalTo("NAME", "Lisa");
let promise = store.update(valueBucket, predicates);
promise.then(async (rows) => {
  console.info(`Updated row count: ${rows}`);
}).catch((err) => {
  console.error(`Updated failed, code is ${err.code},message is ${err.message}`);
})

delete

delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void

根據(jù)RdbPredicates的指定實(shí)例對(duì)象從數(shù)據(jù)庫(kù)中刪除數(shù)據(jù)，使用callback異步回調(diào)。

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

參數(shù)：

示例：

let predicates = new relationalStore.RdbPredicates("EMPLOYEE");
predicates.equalTo("NAME", "Lisa");
store.delete(predicates, function (err, rows) {
  if (err) {
    console.error(`Delete failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`Delete rows: ${rows}`);
})

delete

delete(predicates: RdbPredicates):Promise<number>

根據(jù)RdbPredicates的指定實(shí)例對(duì)象從數(shù)據(jù)庫(kù)中刪除數(shù)據(jù)，使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

示例：

let predicates = new relationalStore.RdbPredicates("EMPLOYEE");
predicates.equalTo("NAME", "Lisa");
let promise = store.delete(predicates);
promise.then((rows) => {
  console.info(`Delete rows: ${rows}`);
}).catch((err) => {
  console.error(`Delete failed, code is ${err.code},message is ${err.message}`);
})

query

query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>):void

根據(jù)指定條件查詢數(shù)據(jù)庫(kù)中的數(shù)據(jù)，使用callback異步回調(diào)。

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

參數(shù)：

示例：

let predicates = new relationalStore.RdbPredicates("EMPLOYEE");
predicates.equalTo("NAME", "Rose");
store.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) {
  if (err) {
    console.error(`Query failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`ResultSet column names: ${resultSet.columnNames}`);
  console.info(`ResultSet column count: ${resultSet.columnCount}`);
})

query

query(predicates: RdbPredicates, columns?: Array<string>):Promise<ResultSet>

根據(jù)指定條件查詢數(shù)據(jù)庫(kù)中的數(shù)據(jù)，使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

示例：

let predicates = new relationalStore.RdbPredicates("EMPLOYEE");
predicates.equalTo("NAME", "Rose");
let promise = store.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSet) => {
console.info(`ResultSet column names: ${resultSet.columnNames}`);
console.info(`ResultSet column count: ${resultSet.columnCount}`);
}).catch((err) => {
console.error(`Query failed, code is ${err.code},message is ${err.message}`);
})

remoteQuery

remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array<string> , callback: AsyncCallback<ResultSet>): void

根據(jù)指定條件查詢遠(yuǎn)程設(shè)備數(shù)據(jù)庫(kù)中的數(shù)據(jù)。使用callback異步回調(diào)。

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

參數(shù)：

示例：

let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
predicates.greaterThan("id", 0);
store.remoteQuery("deviceId", "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"],
  function(err, resultSet) {
    if (err) {
      console.error(`Failed to remoteQuery, code is ${err.code},message is ${err.message}`);
      return;
    }
    console.info(`ResultSet column names: ${resultSet.columnNames}`);
    console.info(`ResultSet column count: ${resultSet.columnCount}`);
  }
)

remoteQuery

remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array<string>): Promise<ResultSet>

根據(jù)指定條件查詢遠(yuǎn)程設(shè)備數(shù)據(jù)庫(kù)中的數(shù)據(jù)。使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

示例：

let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
predicates.greaterThan("id", 0);
let promise = store.remoteQuery("deviceId", "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSet) => {
  console.info(`ResultSet column names: ${resultSet.columnNames}`);
  console.info(`ResultSet column count: ${resultSet.columnCount}`);
}).catch((err) => {
  console.error(`Failed to remoteQuery, code is ${err.code},message is ${err.message}`);
})

querySql

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

根據(jù)指定SQL語(yǔ)句查詢數(shù)據(jù)庫(kù)中的數(shù)據(jù)，使用callback異步回調(diào)。

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

參數(shù)：

示例：

store.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) {
  if (err) {
    console.error(`Query failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`ResultSet column names: ${resultSet.columnNames}`);
  console.info(`ResultSet column count: ${resultSet.columnCount}`);
})

querySql

querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet>

根據(jù)指定SQL語(yǔ)句查詢數(shù)據(jù)庫(kù)中的數(shù)據(jù)，使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

示例：

let promise = store.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = 'sanguo'");
promise.then((resultSet) => {
  console.info(`ResultSet column names: ${resultSet.columnNames}`);
  console.info(`ResultSet column count: ${resultSet.columnCount}`);
}).catch((err) => {
  console.error(`Query failed, code is ${err.code},message is ${err.message}`);
})

executeSql

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

執(zhí)行包含指定參數(shù)但不返回值的SQL語(yǔ)句，使用callback異步回調(diào)。

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

參數(shù)：

示例：

const SQL_DELETE_TABLE = "DELETE FROM test WHERE name = ?"
store.executeSql(SQL_DELETE_TABLE, ['zhangsan'], function(err) {
  if (err) {
    console.error(`ExecuteSql failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`Delete table done.`);
})

executeSql

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

執(zhí)行包含指定參數(shù)但不返回值的SQL語(yǔ)句，使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

示例：

const SQL_DELETE_TABLE = "DELETE FROM test WHERE name = 'zhangsan'"
let promise = store.executeSql(SQL_DELETE_TABLE);
promise.then(() => {
    console.info(`Delete table done.`);
}).catch((err) => {
    console.error(`ExecuteSql failed, code is ${err.code},message is ${err.message}`);
})

beginTransaction

beginTransaction():void

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

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

示例：

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext();
const STORE_CONFIG = { 
  name: "RdbTest.db",
  securityLevel: relationalStore.SecurityLevel.S1
};
relationalStore.getRdbStore(context, STORE_CONFIG, async function (err, store) {
  if (err) {
    console.error(`GetRdbStore failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  store.beginTransaction();
  const valueBucket = {
    "name": "lisi",
    "age": 18,
    "salary": 100.5,
    "blobType": new Uint8Array([1, 2, 3]),
  };
  await store.insert("test", valueBucket);
  store.commit();
})

commit

commit():void

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

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

示例：

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext();
const STORE_CONFIG = { 
  name: "RdbTest.db",
  securityLevel: relationalStore.SecurityLevel.S1
};
relationalStore.getRdbStore(context, STORE_CONFIG, async function (err, store) {
  if (err) {
     console.error(`GetRdbStore failed, code is ${err.code},message is ${err.message}`);
     return;
  }
  store.beginTransaction();
  const valueBucket = {
    "name": "lisi",
    "age": 18,
    "salary": 100.5,
    "blobType": new Uint8Array([1, 2, 3]),
  };
  await store.insert("test", valueBucket);
  store.commit();
})

rollBack

rollBack():void

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

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

示例：

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext();
const STORE_CONFIG = { 
  name: "RdbTest.db",
  securityLevel: relationalStore.SecurityLevel.S1
};
relationalStore.getRdbStore(context, STORE_CONFIG, async function (err, store) {
  if (err) {
    console.error(`GetRdbStore failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  try {
    store.beginTransaction()
    const valueBucket = {
      "id": 1,
      "name": "lisi",
      "age": 18,
      "salary": 100.5,
      "blobType": new Uint8Array([1, 2, 3]),
    };
    await store.insert("test", valueBucket);
    store.commit();
  } catch (err) {
    console.error(`Transaction failed, code is ${err.code},message is ${err.message}`);
    store.rollBack();
  }
})

backup

backup(destName:string, callback: AsyncCallback<void>):void

以指定名稱備份數(shù)據(jù)庫(kù)，使用callback異步回調(diào)。

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

參數(shù)：

示例：

store.backup("dbBackup.db", function(err) {
  if (err) {
    console.error(`Backup failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`Backup success.`);
})

backup

backup(destName:string): Promise<void>

以指定名稱備份數(shù)據(jù)庫(kù)，使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

示例：

let promiseBackup = store.backup("dbBackup.db");
promiseBackup.then(()=>{
  console.info(`Backup success.`);
}).catch((err)=>{
  console.error(`Backup failed, code is ${err.code},message is ${err.message}`);
})

restore

restore(srcName:string, callback: AsyncCallback<void>):void

從指定的數(shù)據(jù)庫(kù)備份文件恢復(fù)數(shù)據(jù)庫(kù)，使用callback異步回調(diào)。

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

參數(shù)：

示例：

store.restore("dbBackup.db", function(err) {
  if (err) {
    console.error(`Restore failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`Restore success.`);
})

restore

restore(srcName:string): Promise<void>

從指定的數(shù)據(jù)庫(kù)備份文件恢復(fù)數(shù)據(jù)庫(kù)，使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

示例：

let promiseRestore = store.restore("dbBackup.db");
promiseRestore.then(()=>{
  console.info(`Restore success.`);
}).catch((err)=>{
  console.error(`Restore failed, code is ${err.code},message is ${err.message}`);
})

setDistributedTables

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

設(shè)置分布式列表，使用callback異步回調(diào)。

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

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

參數(shù)：

示例：

store.setDistributedTables(["EMPLOYEE"], function (err) {
  if (err) {
    console.error(`SetDistributedTables failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`SetDistributedTables successfully.`);
})

setDistributedTables

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

設(shè)置分布式列表，使用Promise異步回調(diào)。

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

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

參數(shù)：

返回值：

示例：

let promise = store.setDistributedTables(["EMPLOYEE"]);
promise.then(() => {
  console.info(`SetDistributedTables successfully.`);
}).catch((err) => {
  console.error(`SetDistributedTables failed, code is ${err.code},message is ${err.message}`);
})

obtainDistributedTableName

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

根據(jù)本地表名獲取指定遠(yuǎn)程設(shè)備的分布式表名。在查詢遠(yuǎn)程設(shè)備數(shù)據(jù)庫(kù)時(shí)，需要使用分布式表名, 使用callback異步回調(diào)。

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

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

參數(shù)：

示例：

store.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {
    if (err) {
        console.error(`ObtainDistributedTableName failed, code is ${err.code},message is ${err.message}`);
        return;
    }
    console.info(`ObtainDistributedTableName successfully, tableName= ${tableName}`);
})

obtainDistributedTableName

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

根據(jù)本地表名獲取指定遠(yuǎn)程設(shè)備的分布式表名。在查詢遠(yuǎn)程設(shè)備數(shù)據(jù)庫(kù)時(shí)，需要使用分布式表名，使用Promise異步回調(diào)。

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

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

參數(shù)：

返回值：

示例：

let promise = store.obtainDistributedTableName("12345678abcde", "EMPLOYEE");
promise.then((tableName) => {
  console.info(`ObtainDistributedTableName successfully, tableName= ${tableName}`);
}).catch((err) => {
  console.error(`ObtainDistributedTableName failed, code is ${err.code},message is ${err.message}`);
})

sync

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

在設(shè)備之間同步數(shù)據(jù), 使用callback異步回調(diào)。

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

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

參數(shù)：

示例：

let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
predicates.inDevices(['12345678abcde']);
store.sync(relationalStore.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) {
  if (err) {
    console.error(`Sync failed, code is ${err.code},message is ${err.message}`);
    return;
  }
  console.info(`Sync done.`);
  for (let i = 0; i < result.length; i++) {
    console.info(`device= ${result[i][0]}, status= ${result[i][1]}`);
  }
})

sync

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

在設(shè)備之間同步數(shù)據(jù)，使用Promise異步回調(diào)。

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

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

參數(shù)：

返回值：

示例：

let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
predicates.inDevices(['12345678abcde']);
let promise = store.sync(relationalStore.SyncMode.SYNC_MODE_PUSH, predicates);
promise.then((result) =>{
  console.info(`Sync done.`);
  for (let i = 0; i < result.length; i++) {
    console.info(`device= ${result[i][0]}, status= ${result[i][1]}`);
  }
}).catch((err) => {
  console.error(`Sync failed, code is ${err.code},message is ${err.message}`);
})

on('dataChange')

on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void

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

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