W3Cschool
恭喜您成為首批注冊(cè)用戶
獲得88經(jīng)驗(yàn)值獎(jiǎng)勵(lì)
DataAbility 謂詞用于構(gòu)造關(guān)系型數(shù)據(jù)庫(kù)的謂詞,提供用于實(shí)現(xiàn)不同查詢方法的謂詞。
本模塊首批接口從API version 7開(kāi)始支持。后續(xù)版本的新增接口,采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。
createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): rdb.RdbPredicates
通過(guò)表名和DataAbility謂詞對(duì)象創(chuàng)建Rdb謂詞對(duì)象。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
name | string | 是 | 數(shù)據(jù)庫(kù)表中的表名。 |
dataAbilityPredicates | 是 | DataAbility謂詞。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
rdb.RdbPredicates | 返回RdbPredicates對(duì)象。 |
示例:
- let dataAbilityPredicates = new dataAbility.DataAbilityPredicates()
- dataAbilityPredicates.equalTo("NAME", "Rose")
- let predicates = dataAbility.createRdbPredicates("EMPLOYEE", dataAbilityPredicates)
提供用于實(shí)現(xiàn)不同查詢方法的謂詞。
初始化:
- let dataAbilityPredicates = new dataAbility.DataAbilityPredicates()
equalTo(field: string, value: ValueType): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù),數(shù)據(jù)的指定字段數(shù)據(jù)類(lèi)型為ValueType且值等于指定值。
此方法類(lèi)似于SQL語(yǔ)句的“=”。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.equalTo("NAME", "lisi")
notEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù),數(shù)據(jù)的指定字段數(shù)據(jù)類(lèi)型為ValueType且不等于指定值。
此方法類(lèi)似于SQL語(yǔ)句的“!=”。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.notEqualTo("NAME", "lisi")
beginWrap(): DataAbilityPredicates
在謂詞中添加左括號(hào)。此方法類(lèi)似于SQL語(yǔ)句的“(”,需要與endWrap一起使用。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回帶有左括號(hào)的DataAbility謂詞。 |
示例:
- dataAbilityPredicates.equalTo("NAME", "lisi")
- .beginWrap()
- .equalTo("AGE", 18)
- .or()
- .equalTo("SALARY", 200.5)
- .endWrap()
endWrap(): DataAbilityPredicates
在謂詞中添加右括號(hào)。此方法類(lèi)似于SQL語(yǔ)句的“)”,需要和beginWrap一起使用。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回帶有右括號(hào)的DataAbility謂詞。 |
示例:
- dataAbilityPredicates.equalTo("NAME", "lisi")
- .beginWrap()
- .equalTo("AGE", 18)
- .or()
- .equalTo("SALARY", 200.5)
- .endWrap()
or(): DataAbilityPredicates
將或條件添加到謂詞中。
此方法類(lèi)似于SQL語(yǔ)句“or”。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回帶有或條件的DataAbility謂詞。 |
示例:
- dataAbilityPredicates.equalTo("NAME", "Lisa")
- .or()
- .equalTo("NAME", "Rose")
and(): DataAbilityPredicates
將和條件添加到謂詞中。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回帶有和條件的DataAbility謂詞。 |
示例:
- dataAbilityPredicates.equalTo("NAME", "Lisa")
- .and()
- .equalTo("SALARY", 200.5)
contains(field: string, value: string): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為string且value包含指定值的字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | string | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.contains("NAME", "os")
beginsWith(field: string, value: string): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為string且值以指定字符串開(kāi)頭的字段。
此方法類(lèi)似于SQL語(yǔ)句的“%”。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | string | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.beginsWith("NAME", "os")
endsWith(field: string, value: string): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為string且值以指定字符串結(jié)尾的字段。
此方法類(lèi)似于SQL語(yǔ)句的“%”。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | string | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.endsWith("NAME", "se")
isNull(field: string): DataAbilityPredicates
配置謂詞以匹配值為null的字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.isNull("NAME")
isNotNull(field: string): DataAbilityPredicates
配置謂詞以匹配值不為null的指定字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.isNotNull("NAME")
like(field: string, value: string): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為string且值類(lèi)似于指定字符串的字段。
此方法類(lèi)似于SQL語(yǔ)句“l(fā)ike”。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | string | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.like("NAME", "%os%")
glob(field: string, value: string): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為string的指定字段。與like方法不同,該方法的輸入?yún)?shù)區(qū)分大小寫(xiě)。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | string | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.glob("NAME", "?h*g")
- // 僅可匹配到"name"字段值為“Lisa”
- dataAbilityPredicates.glob("NAME", "Lisa")
- // 僅可以匹配到"name"字段值為“l(fā)isa”
- dataAbilityPredicates.glob("NAME", "lisa")
between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為ValueType且value在指定范圍內(nèi)的指定字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.between("AGE", 10, 50)
notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為ValueType且value超出給定范圍的指定字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.notBetween("AGE", 10, 50)
greaterThan(field: string, value: ValueType): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為ValueType且值大于指定值的字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.greaterThan("AGE", 18)
lessThan(field: string, value: ValueType): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為valueType且value小于指定值的字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.lessThan("AGE", 20)
greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為ValueType且value大于或等于指定值的字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.greaterThanOrEqualTo("AGE", 18)
lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為ValueType且value小于或等于指定值的字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | 是 | 指示要與謂詞匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.lessThanOrEqualTo("AGE", 20)
orderByAsc(field: string): DataAbilityPredicates
配置謂詞以匹配其值按升序排序的列。當(dāng)有多個(gè)orderByAsc使用時(shí),最先使用的具有最高優(yōu)先級(jí)。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- // 先按“name”字段排序,相同時(shí)按“AGE”字段排序,其次按“SALARY”排序
- dataAbilityPredicates.orderByAsc("NAME").orderByAsc("AGE").orderByAsc("SALARY")
orderByDesc(field: string): DataAbilityPredicates
配置謂詞以匹配其值按降序排序的列。當(dāng)有多個(gè)orderByDesc使用時(shí),最先使用的具有最高優(yōu)先級(jí)。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- // 優(yōu)先按“AGE”排序,相同時(shí)按“SALARY”排序
- dataAbilityPredicates.orderByDesc("AGE").orderByDesc("SALARY")
distinct(): DataAbilityPredicates
配置謂詞以過(guò)濾重復(fù)記錄并僅保留其中一個(gè)。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回可用于過(guò)濾重復(fù)記錄的謂詞。 |
示例:
- dataAbilityPredicates.equalTo("NAME", "Rose").distinct()
limitAs(value: number): DataAbilityPredicates
設(shè)置最大數(shù)據(jù)記錄數(shù)的謂詞。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
value | number | 是 | 最大數(shù)據(jù)記錄數(shù)。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回可用于設(shè)置最大數(shù)據(jù)記錄數(shù)的謂詞。 |
示例:
- dataAbilityPredicates.equalTo("NAME", "Rose").limitAs(3)
offsetAs(rowOffset: number): DataAbilityPredicates
配置謂詞以指定返回結(jié)果的起始位置。將此方法必須與limitAs一起使用。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
rowOffset | number | 是 | 返回結(jié)果的起始位置,取值為正整數(shù)。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回具有指定返回結(jié)果起始位置的謂詞。 |
示例:
- // 跳過(guò)前三條數(shù)據(jù),顯示后續(xù)三條數(shù)據(jù)
- dataAbilityPredicates.equalTo("NAME", "Rose").offsetAs(3).limitAs(3)
groupBy(fields: Array<string>): DataAbilityPredicates
配置謂詞按指定列分組查詢結(jié)果。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
fields | Array<string> | 是 | 指定分組依賴的列名。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回分組查詢列的謂詞。 |
示例:
- dataAbilityPredicates.groupBy(["AGE", "NAME"])
indexedBy(field: string): DataAbilityPredicates
配置謂詞以指定索引列。在使用此方法之前,您需要?jiǎng)?chuàng)建一個(gè)索引列。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
indexName | string | 是 | 創(chuàng)建的索引列名稱。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回具有指定索引列的謂詞。 |
示例:
- import rdb from '@ohos.data.rdb'; // 導(dǎo)入模塊
- import featureAbility from '@ohos.ability.featureAbility';
- import dataAbility from '@ohos.data.dataAbility';
- let context = getContext(this);
- const STORE_CONFIG : rdb.StoreConfig= {
- name: 'RdbTest.db', // 數(shù)據(jù)庫(kù)文件名
- };
- // 表結(jié)構(gòu):EMPLOYEE (NAME, AGE, SALARY, CODES)
- 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)'; // 建表Sql語(yǔ)句
- rdb.getRdbStore(this.context, STORE_CONFIG, 3, async (err, store) => {
- if (err) {
- console.error(`Failed to get RdbStore. Code:${err.code}, message:${err.message}`);
- return;
- }
- console.info('Succeeded in getting RdbStore.');
- await store.executeSql(SQL_CREATE_TABLE); // 創(chuàng)建數(shù)據(jù)表
- // 創(chuàng)建索引
- const SQL_CREATE_INDEX = 'CREATE INDEX SALARY_INDEX ON EMPLOYEE(SALARY)'
- await store.executeSql(SQL_CREATE_INDEX);
- // ...
- let dataAbilityPredicates = new dataAbility.DataAbilityPredicates()
- dataAbilityPredicates.indexedBy("SALARY_INDEX")
- // ...
- })
in(field: string, value: Array<ValueType>): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為ValueType數(shù)組且值在給定范圍內(nèi)的指定字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | Array<ValueType> | 是 | 以ValueType類(lèi)型數(shù)組形式指定的要匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.in("AGE", [18, 20])
notIn(field: string, value: Array<ValueType>): DataAbilityPredicates
配置謂詞以匹配數(shù)據(jù)類(lèi)型為ValueType數(shù)組且值不在給定范圍內(nèi)的指定字段。
系統(tǒng)能力: SystemCapability.DistributedDataManager.DataShare.Core。
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
field | string | 是 | 數(shù)據(jù)庫(kù)表中的列名。 |
value | Array<ValueType> | 是 | 以ValueType類(lèi)型數(shù)組形式指定的要匹配的值。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
返回與指定字段匹配的謂詞。 |
示例:
- dataAbilityPredicates.notIn("NAME", ["Lisa", "Rose"])
Copyright©2021 w3cschool編程獅|閩ICP備15016281號(hào)-3|閩公網(wǎng)安備35020302033924號(hào)
違法和不良信息舉報(bào)電話:173-0602-2364|舉報(bào)郵箱:jubao@eeedong.com
掃描二維碼
下載編程獅App
編程獅公眾號(hào)
聯(lián)系方式:
更多建議: