Name	Type	Mandatory	Description
name	string	Yes	Name of the database table. It cannot be an empty string.
dataAbilityPredicates	DataAbilityPredicates	Yes	Predicate.

Type	Description
rdb.RdbPredicates	RdbPredicates object that matches the specified field.

Type	Description
DataAbilityPredicates	DataSharePredicates object with a left parenthesis.

Type	Description
DataAbilityPredicates	DataSharePredicates object with a right parenthesis.

Type	Description
DataAbilityPredicates	Predicate with logical OR.

Type	Description
DataAbilityPredicates	Predicate with logical AND.

Name	Type	Mandatory	Description
value	number	Yes	Maximum number of records. The value should be a positive integer. If a value less than or equal to 0 is specified, the number of records is not limited.

Name	Type	Mandatory	Description
rowOffset	number	Yes	Start position of the returned result. If a positive integer is passed in, the result is returned from the specified position. If the value passed in is less than or equal to 0, the query result is returned from the first element.

Name	Type	Mandatory	Description
fields	Array<string>	Yes	Names of columns to group.

Name	Type	Mandatory	Description
field	string	Yes	Name of the index to create.

import { UIAbility } from '@kit.AbilityKit';
import { dataAbility, relationalStore } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  async onCreate(): Promise<void> {
    let store: relationalStore.RdbStore | undefined = undefined;
    let context = this.context;

    try {
      const STORE_CONFIG: relationalStore.StoreConfig = {
        name: 'RdbTest.db', // Database file name.
        securityLevel: relationalStore.SecurityLevel.S3,
      };
      // Table structure: EMPLOYEE (ID, 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)'; // Create the table SQL statement.
      store = await relationalStore.getRdbStore(context, STORE_CONFIG);
      console.info('Succeeded in getting RdbStore.');
      await store.executeSql(SQL_CREATE_TABLE); // Create a data table.
    } catch (e) {
      const err = e as BusinessError;
      console.error(`Failed to get RdbStore. Code:${err.code}, message:${err.message}`);
    }

    if (!store) {
      return;
    }

    // Create an index.
    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");

    // ...
  }
}

[h2]in

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

Creates a DataAbilityPredicates object to search for the records in the specified column that are in the given range.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Name	Type	Mandatory	Description
field	string	Yes	Column name in the database table. It cannot be an empty string.
value	Array<ValueType>	Yes	Array of ValueTypes to match.

Return value

Type	Description
DataAbilityPredicates	DataAbilityPredicates object created.

Example

dataAbilityPredicates.in("AGE", [18, 20]);

[h2]notIn

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

Creates a DataAbilityPredicates object to search for the records in the specified column that are out of the given range.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Parameters

Name	Type	Mandatory	Description
field	string	Yes	Column name in the database table. It cannot be an empty string.
value	Array<ValueType>	Yes	Array of ValueTypes to match.

Return value

Type	Description
DataAbilityPredicates	DataAbilityPredicates object created.

Example

dataAbilityPredicates.notIn("NAME", ["Lisa", "Rose"]);

ValueType

type ValueType = number | string | boolean

Defines the value types.

System capability: SystemCapability.DistributedDataManager.DataShare.Core

Type	Description
number	The value is a number.
string	String.
boolean	The value is of Boolean type.

目录

@ohos.data.dataAbility (DataAbility Predicates)

Modules to Import

dataAbility.createRdbPredicates

DataAbilityPredicates

[h2]equalTo

[h2]notEqualTo

[h2]beginWrap

[h2]endWrap

[h2]or

[h2]and

[h2]contains

[h2]beginsWith

[h2]endsWith

[h2]isNull

[h2]isNotNull

[h2]like

[h2]glob

[h2]between

[h2]notBetween

[h2]greaterThan

[h2]lessThan

[h2]greaterThanOrEqualTo

[h2]lessThanOrEqualTo

[h2]orderByAsc

[h2]orderByDesc

[h2]distinct

[h2]limitAs

[h2]offsetAs

[h2]groupBy

[h2]indexedBy

[h2]in

[h2]notIn

ValueType