mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-08 15:54:33 +00:00
109 lines
2.9 KiB
TypeScript
109 lines
2.9 KiB
TypeScript
/*
|
|
* Copyright (c) 2021-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.
|
|
*/
|
|
|
|
import featureAbility from '../@ohos.ability.featureAbility';
|
|
import dataAbility from '../@ohos.data.dataAbility';
|
|
import rdb from '../@ohos.data.rdb';
|
|
|
|
/**
|
|
* Indicates an array of data operations that can contain several different operations on the database.
|
|
*
|
|
* @typedef DataAbilityOperation
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
|
* @since 7
|
|
*/
|
|
export interface DataAbilityOperation {
|
|
/**
|
|
* Indicates the path of data to operate.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
|
* @FAModelOnly
|
|
* @since 7
|
|
*/
|
|
uri: string;
|
|
|
|
/**
|
|
* Indicates a operation type.
|
|
*
|
|
* @type { featureAbility.DataAbilityOperationType }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
|
* @FAModelOnly
|
|
* @since 7
|
|
*/
|
|
type: featureAbility.DataAbilityOperationType;
|
|
|
|
/**
|
|
* Indicates the data values to be set.
|
|
*
|
|
* @type { ?rdb.ValuesBucket }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
|
* @FAModelOnly
|
|
* @since 7
|
|
*/
|
|
valuesBucket?: rdb.ValuesBucket;
|
|
|
|
/**
|
|
* Indicates the valuesBucket object containing a set of key-value pairs.
|
|
*
|
|
* @type { ?rdb.ValuesBucket }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
|
* @FAModelOnly
|
|
* @since 7
|
|
*/
|
|
valueBackReferences?: rdb.ValuesBucket;
|
|
|
|
/**
|
|
* Indicates the filter criteria to set. If this parameter is null, all data records
|
|
* will be operated by default.
|
|
*
|
|
* @type { ?dataAbility.DataAbilityPredicates }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
|
* @FAModelOnly
|
|
* @since 7
|
|
*/
|
|
predicates?: dataAbility.DataAbilityPredicates;
|
|
|
|
/**
|
|
* Indicates the back reference to be used as a filter criterion in predicates.
|
|
*
|
|
* @type { ?Map<number, number> }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
|
* @FAModelOnly
|
|
* @since 7
|
|
*/
|
|
predicatesBackReferences?: Map<number, number>;
|
|
|
|
/**
|
|
* Specifies whether a batch operation can be interrupted.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
|
* @FAModelOnly
|
|
* @since 7
|
|
*/
|
|
interrupted?: boolean;
|
|
|
|
/**
|
|
* Indicates the expected number of rows to update or delete.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
|
* @FAModelOnly
|
|
* @since 7
|
|
*/
|
|
expectedCount?: number;
|
|
}
|