当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
46 Star 180 Fork 4.8K

OpenHarmony/interface_sdk-js
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.data.dataSharePredicates.d.ts 28.24 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684
/*
* Copyright (c) 2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkData
*/
import { ValueType } from './@ohos.data.ValuesBucket';
/**
* This module provides data share services based on the ExtensionAbility.
*
* @namespace dataSharePredicates
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @since 10
*/
/**
* This module provides data share services based on the ExtensionAbility.
*
* @namespace dataSharePredicates
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @since 12
*/
/**
* This module provides data share services based on the ExtensionAbility.
*
* @namespace dataSharePredicates
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace dataSharePredicates {
/**
* Provides a filter object to query data in a database by using DataShare APIs.
* <strong>This type is not multi-thread safe. If a DataSharePredicates instance is operated by multiple threads
* at the same time in an application, use a lock for it.</strong>
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @since 10
*/
/**
* Provides a filter object to query data in a database by using DataShare APIs.
* <strong>This type is not multi-thread safe. If a DataSharePredicates instance is operated by multiple threads
* at the same time in an application, use a lock for it.</strong>
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @since 12
*/
/**
* Manages relational database configurations.
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
class DataSharePredicates {
/**
* Configure the DataSharePredicates to match the field whose data type is ValueType and value is equal
* to a specified value.
* This method is similar to = of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { ValueType } value - Indicates the value to match with the DataSharePredicates.
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @since 10
*/
/**
* Configure the DataSharePredicates to match the field whose data type is ValueType and value is equal
* to a specified value.
* This method is similar to = of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { ValueType } value - Indicates the value to match with the DataSharePredicates.
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @since 12
*/
/**
* Configure the DataSharePredicates to match the field whose data type is ValueType and value is equal
* to a specified value.
* This method is similar to = of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { ValueType } value - Indicates the value to match with the DataSharePredicates.
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
equalTo(field: string, value: ValueType): DataSharePredicates;
/**
* Configure the DataSharePredicates to match the field whose data type is ValueType and value is unequal to
* a specified value.
* This method is similar to != of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { ValueType } value - Indicates the value to match with the DataSharePredicates.
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
notEqualTo(field: string, value: ValueType): DataSharePredicates;
/**
* Adds a left parenthesis to the DataSharePredicates.
* This method is similar to ( of the SQL statement and needs to be used together with endWrap().
* Currently only used for RDB.
*
* @returns { DataSharePredicates } Returns the DataSharePredicates with the left parenthesis.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
beginWrap(): DataSharePredicates;
/**
* Adds a right parenthesis to the DataSharePredicates.
* This method is similar to ) of the SQL statement and needs to be used together
* with beginWrap().
* Currently only used for RDB.
*
* @returns { DataSharePredicates } Returns the DataSharePredicates with the right parenthesis.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
endWrap(): DataSharePredicates;
/**
* Adds an or condition to the DataSharePredicates.
* This method is similar to or of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @returns { DataSharePredicates } Returns the DataSharePredicates with the or condition.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
or(): DataSharePredicates;
/**
* Adds an and condition to the DataSharePredicates.
* This method is similar to and of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @returns { DataSharePredicates } Returns the DataSharePredicates with the and condition.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @since 10
*/
/**
* Adds an and condition to the DataSharePredicates.
* This method is similar to and of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @returns { DataSharePredicates } Returns the DataSharePredicates with the and condition.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @since 12
*/
/**
* Adds an and condition to the DataSharePredicates.
* This method is similar to and of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @returns { DataSharePredicates } Returns the DataSharePredicates with the and condition.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
and(): DataSharePredicates;
/**
* Configure the DataSharePredicates to match the field whose data type is string and value
* contains a specified value.
* This method is similar to contains of the SQL statement.
* Currently only used for RDB.
*
* @param { string } field - Indicates the column name in the database table.
* @param { string } value - Indicates the value to match with the DataSharePredicates.
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
contains(field: string, value: string): DataSharePredicates;
/**
* Configure the DataSharePredicates to match the field whose data type is string and value starts
* with a specified string.
* This method is similar to value% of the SQL statement.
* Currently only used for RDB.
*
* @param { string } field - Indicates the column name in the database table.
* @param { string } value - Indicates the value to match with the DataSharePredicates.
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
beginsWith(field: string, value: string): DataSharePredicates;
/**
* Configure the DataSharePredicates to match the field whose data type is string and value
* ends with a specified string.
* This method is similar to %value of the SQL statement.
* Currently only used for RDB.
*
* @param { string } field - Indicates the column name in the database table.
* @param { string } value - Indicates the value to match with the DataSharePredicates.
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
endsWith(field: string, value: string): DataSharePredicates;
/**
* Configure the DataSharePredicates to match the fields whose value is null.
* This method is similar to is null of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
isNull(field: string): DataSharePredicates;
/**
* Configure the DataSharePredicates to match the specified fields whose value is not null.
* This method is similar to is not null of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
isNotNull(field: string): DataSharePredicates;
/**
* Configure the DataSharePredicates to match the fields whose data type is string and value is
* similar to a specified string.
* This method is similar to like of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { string } value - Indicates the value to match with the DataSharePredicates. The percent sign (%) in the value
* is a wildcard (like * in a regular expression).
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
like(field: string, value: string): DataSharePredicates;
/**
* Configure the DataSharePredicates to match the fields whose data type is string and value is
* not similar to a specified string.
* This method is similar to unlike of the SQL statement.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { string } value - Indicates the value to match with the DataSharePredicates. The percent sign (%) in the value
* is a wildcard (like * in a regular expression).
* @returns { DataSharePredicates } Returns the DataSharePredicates that match the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
unlike(field: string, value: string): DataSharePredicates;
/**
* Configure DataSharePredicates to match the specified field whose data type is string and the value contains
* a wildcard.
* Different from like, the input parameters of this method are case-sensitive.
* Currently only used for RDB.
*
* @param { string } field - Indicates the column name in the database table.
* @param { string } value - Indicates the value to match with DataSharePredicates.
* @returns { DataSharePredicates } Returns the SQL statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
glob(field: string, value: string): DataSharePredicates;
/**
* Restricts the value of the field to the range between low value and high value.
* Currently only used for RDB.
*
* @param { string } field - Indicates the column name.
* @param { ValueType } low - Indicates the minimum value.
* @param { ValueType } high - Indicates the maximum value.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
between(field: string, low: ValueType, high: ValueType): DataSharePredicates;
/**
* Configure DataSharePredicates to match the specified field whose data type is int and value is
* out of a given range.
* Currently only used for RDB.
*
* @param { string } field - Indicates the column name in the database table.
* @param { ValueType } low - Indicates the minimum value to match with DataSharePredicates.
* @param { ValueType } high - Indicates the maximum value to match with DataSharePredicates.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
notBetween(field: string, low: ValueType, high: ValueType): DataSharePredicates;
/**
* Restricts the value of the field to be greater than the specified value.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name.
* @param { ValueType } value - Indicates the String field.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
greaterThan(field: string, value: ValueType): DataSharePredicates;
/**
* Restricts the value of the field to be smaller than the specified value.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name.
* @param { ValueType } value - Indicates the String field.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
lessThan(field: string, value: ValueType): DataSharePredicates;
/**
* Restricts the value of the field to be greater than or equal to the specified value.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name.
* @param { ValueType } value - Indicates the String field.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates;
/**
* Restricts the value of the field to be smaller than or equal to the specified value.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name.
* @param { ValueType } value - Indicates the String field.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
lessThanOrEqualTo(field: string, value: ValueType): DataSharePredicates;
/**
* Restricts the ascending order of the return list. When there are several orders,
* the one close to the head has the highest priority.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name for sorting the return list.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @since 10
*/
/**
* Restricts the ascending order of the return list. When there are several orders,
* the one close to the head has the highest priority.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name for sorting the return list.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @since 12
*/
/**
* Restricts the ascending order of the return list. When there are several orders,
* the one close to the head has the highest priority.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name for sorting the return list.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
orderByAsc(field: string): DataSharePredicates;
/**
* Restricts the descending order of the return list. When there are several orders,
* the one close to the head has the highest priority.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name for sorting the return list.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @since 10
*/
/**
* Restricts the descending order of the return list. When there are several orders,
* the one close to the head has the highest priority.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name for sorting the return list.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @since 12
*/
/**
* Restricts the descending order of the return list. When there are several orders,
* the one close to the head has the highest priority.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name for sorting the return list.
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
orderByDesc(field: string): DataSharePredicates;
/**
* Restricts each row of the query result to be unique.
* Currently only used for RDB.
*
* @returns { DataSharePredicates } Returns the SQL query statement with the specified DataSharePredicates.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
distinct(): DataSharePredicates;
/**
* Construct a query object to specify the number of results and the starting position.
* Currently only used for RDB and KVDB(schema).
*
* @param { number } total - Represents the specified number of results.
* @param { number } offset - Indicates the starting position.
* @returns { DataSharePredicates } Returns the query object.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @since 10
*/
/**
* Construct a query object to specify the number of results and the starting position.
* Currently only used for RDB and KVDB(schema).
*
* @param { number } total - Represents the specified number of results.
* @param { number } offset - Indicates the starting position.
* @returns { DataSharePredicates } Returns the query object.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @since 12
*/
/**
* Construct a query object to specify the number of results and the starting position.
* Currently only used for RDB and KVDB(schema).
*
* @param { number } total - Represents the specified number of results.
* @param { number } offset - Indicates the starting position.
* @returns { DataSharePredicates } Returns the query object.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
limit(total: number, offset: number): DataSharePredicates;
/**
* Configure {@code DataSharePredicates} to group query results by specified columns.
* Currently only used for RDB.
*
* @param { Array<string> } fields - Indicates the specified columns by which query results are grouped.
* @returns { DataSharePredicates } Returns the DataSharePredicates with the specified columns by which query results are grouped.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
groupBy(fields: Array<string>): DataSharePredicates;
/**
* Configure {@code DataSharePredicates} to specify the index column.
* Before using this method, you need to create an index column.
* Currently only used for RDB.
*
* @param { string } field - Indicates the name of the index column.
* @returns { DataSharePredicates } Returns DataSharePredicates with the specified index column.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
indexedBy(field: string): DataSharePredicates;
/**
* Configure {@code DataSharePredicates} to match the specified field whose data type is ValueType array and values
* are within a given range.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { Array<ValueType> } value - Indicates the values to match with DataSharePredicates.
* @returns { DataSharePredicates } Returns DataSharePredicates that matches the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @since 10
*/
/**
* Configure {@code DataSharePredicates} to match the specified field whose data type is ValueType array and values
* are within a given range.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { Array<ValueType> } value - Indicates the values to match with DataSharePredicates.
* @returns { DataSharePredicates } Returns DataSharePredicates that matches the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @since 12
*/
/**
* Configure {@code DataSharePredicates} to match the specified field whose data type is ValueType array and values
* are within a given range.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { Array<ValueType> } value - Indicates the values to match with DataSharePredicates.
* @returns { DataSharePredicates } Returns DataSharePredicates that matches the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @StageModelOnly
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
in(field: string, value: Array<ValueType>): DataSharePredicates;
/**
* Configure {@code DataSharePredicates} to match the specified field whose data type is String array and values
* are out of a given range.
* Currently only used for RDB and KVDB(schema).
*
* @param { string } field - Indicates the column name in the database table.
* @param { Array<ValueType> } value - Indicates the values to match with DataSharePredicates.
* @returns { DataSharePredicates } Returns DataSharePredicates that matches the specified field.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
notIn(field: string, value: Array<ValueType>): DataSharePredicates;
/**
* Configure {@code DataSharePredicates} Creates a query condition using the specified key prefix.
* Currently only used for KVDB.
*
* @param { string } prefix - Represents the specified key prefix.
* @returns { DataSharePredicates } Returns the query object.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
prefixKey(prefix: string): DataSharePredicates;
/**
* Configure {@code DataSharePredicates} to match the specified value whose key is within a given range.
* Currently only used for KVDB.
*
* @param { Array<string> } keys - Represents the key names.
* @returns { DataSharePredicates } Returns the query object.
* @syscap SystemCapability.DistributedDataManager.DataShare.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
inKeys(keys: Array<string>): DataSharePredicates;
}
}
export default dataSharePredicates;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助