@ohos.data.dataSharePredicates (DataShare Predicates)

You can use DataSharePredicates to specify conditions for updating, deleting, and querying data when DataShare is used to manage data.

The APIs provided by DataSharePredicates correspond to the filter criteria of the database. Before using the APIs, you need to have basic database knowledge.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs provided by this module are system APIs.

Modules to Import

import dataSharePredicates from '@ohos.data.dataSharePredicates';

DataSharePredicates

Provides methods for setting different DataSharePredicates objects.

equalTo

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

Sets a DataSharePredicates object to search for the data that is equal to the specified value.

Currently, only the relational database (RDB) and key-value database (KVDB, schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose")

notEqualTo

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

Sets a DataSharePredicates object to search for the data that is not equal to the specified value.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.notEqualTo("NAME", "Rose")

beginWrap

beginWrap(): DataSharePredicates

Adds a left parenthesis to this DataSharePredicates.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()

endWrap

endWrap(): DataSharePredicates

Adds a right parenthesis to this DataSharePredicates object.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()

or

or(): DataSharePredicates

Adds the OR condition to this DataSharePredicates object.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "lisi")
    .or()
    .equalTo("NAME", "Rose")

and

and(): DataSharePredicates

Adds the AND condition to this DataSharePredicates object.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "lisi")
    .and()
    .equalTo("SALARY", 200.5)

contains

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

Sets a DataSharePredicates object to search for the data that contains the specified value.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.contains("NAME", "os")

beginsWith

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

Sets a DataSharePredicates object to search for the data that begins with the specified value.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.beginsWith("NAME", "os")

endsWith

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

Sets a DataSharePredicates object to search for the data that ends with the specified value.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.endsWith("NAME", "os")

isNull

isNull(field: string): DataSharePredicates

Sets a DataSharePredicates object to search for the data whose value is null.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.isNull("NAME")

isNotNull

isNotNull(field: string): DataSharePredicates

Sets a DataSharePredicates object to search for the data whose value is not null.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.isNotNull("NAME")

like

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

Sets a DataSharePredicates object to search for the data that matches the specified wildcard expression.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.like("NAME", "%os%")

unlike

unlike(field: string, value: string): DataSharePredicates

Sets a DataSharePredicates object to search for the data that does not match the specified wildcard expression.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.unlike("NAME", "%os%")

glob

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

Sets a DataSharePredicates object to search for the data that matches the specified wildcard expression.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.glob("NAME", "?h*g")

between

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

Sets a DataSharePredicates object to search for the data that is within the specified range, including the start and end values.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.between("AGE", 10, 50)

notBetween

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

Sets a DataSharePredicates object to search for the data that is out of the specified range, excluding the start and end values.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.notBetween("AGE", 10, 50)

greaterThan

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

Sets a DataSharePredicates object to search for the data that is greater than the specified value.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.greaterThan("AGE", 10)

lessThan

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

Sets a DataSharePredicates object to search for the data that is less than the specified value.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.lessThan("AGE", 50)

greaterThanOrEqualTo

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

Sets a DataSharePredicates object to search for the data that is greater than or equal to the specified value.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.greaterThanOrEqualTo("AGE", 10)

lessThanOrEqualTo

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

Sets a DataSharePredicates object to search for the data that is less than or equal to the specified value.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.lessThanOrEqualTo("AGE", 50)

orderByAsc

orderByAsc(field: string): DataSharePredicates

Sets a DataSharePredicates object that sorts data in ascending order.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.orderByAsc("AGE")

orderByDesc

orderByDesc(field: string): DataSharePredicates

Sets a DataSharePredicates object that sorts data in descending order.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.orderByDesc("AGE")

distinct

distinct(): DataSharePredicates

Sets a DataSharePredicates object to filter out duplicate data records.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose").distinct()

limit

limit(total: number, offset: number): DataSharePredicates

Sets a DataSharePredicates object to specify the number of results and the start position.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose").limit(10, 3)

groupBy

groupBy(fields: Array<string>): DataSharePredicates

Sets a DataSharePredicates object group the records according to the specified fields.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.groupBy(["AGE", "NAME"])

indexedBy

indexedBy(field: string): DataSharePredicates

Sets a DataSharePredicates object to list data by the specified index.

Currently, only the RDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.indexedBy("SALARY_INDEX")

in

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

Sets a DataSharePredicates object to search for the data that is within the specified value.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.in("AGE", [18, 20])

notIn

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

Sets a DataSharePredicates object to search for the data that is not in the specified value.

Currently, only the RDB and KVDB (schema) support this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.notIn("NAME", ["Lisa", "Rose"])

prefixKey

prefixKey(prefix: string): DataSharePredicates

Sets a DataSharePredicates object to search for the data with the specified key prefix.

Currently, only the KVDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.prefixKey("NAME")

inKeys

inKeys(keys: Array<string>): DataSharePredicates

Sets a DataSharePredicates object to search for the data whose keys are within the given range.

Currently, only the KVDB supports this DataSharePredicates object.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Return value

Example

let predicates = new dataSharePredicates.DataSharePredicates()
predicates.inKeys(["Lisa", "Rose"])