1 Star 0 Fork 3.9K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.data.distributedKVStore.d.ts 150.65 KB
一键复制 编辑 原始数据 按行查看 历史
王斌 提交于 2024-08-14 19:03 +08:00 . fix kv 一致性问题
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150
/*
* Copyright (c) 2022 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 { AsyncCallback, Callback } from './@ohos.base';
import { ValuesBucket } from './@ohos.data.ValuesBucket';
import dataSharePredicates from './@ohos.data.dataSharePredicates';
import BaseContext from './application/BaseContext';
/**
* Provider interfaces to create a {@link KVManager} instance.
*
* @namespace distributedKVStore
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
declare namespace distributedKVStore {
/**
* Provides configuration information to create a {@link KVManager} instance,
* which includes the caller's package name and ability or hap context.
*
* @interface KVManagerConfig
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
interface KVManagerConfig {
/**
* Indicates the bundleName
*
* @type { string }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
bundleName: string;
/**
* Indicates the ability or hap context
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* if swap the area, you should close all the KV store and use the new Context to create the KVManager
* @since 9
*/
/**
* Indicates the ability or hap context
*
* @type { BaseContext }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* if swap the area, you should close all the KV store and use the new BaseContext to create the KVManager
* @since 10
*/
context: BaseContext;
}
/**
* KVStore constants
*
* @interface Constants
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
interface Constants {
/**
* Max key length is 1024.
*
* @type { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
readonly MAX_KEY_LENGTH: number;
/**
* Max value length is 4194303.
*
* @type { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
readonly MAX_VALUE_LENGTH: number;
/**
* Max device coordinate key length is 896.
*
* @type { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
readonly MAX_KEY_LENGTH_DEVICE: number;
/**
* Max store id length is 128.
*
* @type { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
readonly MAX_STORE_ID_LENGTH: number;
/**
* Max query length is 512000.
*
* @type { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
readonly MAX_QUERY_LENGTH: number;
/**
* Max batch operation size is 128.
*
* @type { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
readonly MAX_BATCH_SIZE: number;
}
/**
* Indicates the {@code ValueType}.
* <p>{@code ValueType} is obtained based on the value.
*
* @enum { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
enum ValueType {
/**
* Indicates that the value type is string.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
STRING,
/**
* Indicates that the value type is int.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
INTEGER,
/**
* Indicates that the value type is float.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
FLOAT,
/**
* Indicates that the value type is byte array.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
BYTE_ARRAY,
/**
* Indicates that the value type is boolean.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
BOOLEAN,
/**
* Indicates that the value type is double.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
DOUBLE
}
/**
* Obtains {@code Value} objects stored in a {@link SingleKVStore} or {@link DeviceKVStore} database.
*
* @interface Value
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
interface Value {
/**
* Indicates the value type
*
* @type { ValueType }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
* @see ValueType
*/
type: ValueType;
/**
* Indicates the value
*
* @type { Uint8Array | string | number | boolean }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
value: Uint8Array | string | number | boolean;
}
/**
* Provides key-value pairs stored in the distributedKVStore.
*
* @interface Entry
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
interface Entry {
/**
* Indicates the key
*
* @type { string }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
key: string;
/**
* Indicates the value
*
* @type { Value }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
value: Value;
}
/**
* Receive notifications of all data changes, including data insertion, update, and deletion.
* <p>If you have subscribed to {@code SingleKVStore} or {@code DeviceKVStore}, you will receive
* data change notifications and obtain the changed data from the parameters in callback methods
* upon data insertion, update or deletion.
*
* @interface ChangeNotification
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
interface ChangeNotification {
/**
* Indicates data insertion records.
*
* @type { Entry[] }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
insertEntries: Entry[];
/**
* Indicates data update records.
*
* @type { Entry[] }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
updateEntries: Entry[];
/**
* Indicates data deletion records.
*
* @type { Entry[] }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
deleteEntries: Entry[];
/**
* Indicates the device id which brings the data change.
*
* @type { string }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
deviceId: string;
}
/**
* Indicates the database synchronization mode.
*
* @enum { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
enum SyncMode {
/**
* Indicates that data is only pulled from the remote end.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
PULL_ONLY,
/**
* Indicates that data is only pushed from the local end.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
PUSH_ONLY,
/**
* Indicates that data is pushed from the local end, and then pulled from the remote end.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
PUSH_PULL
}
/**
* Describes the subscription type.
*
* @enum { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
enum SubscribeType {
/**
* Subscription to local data changes
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
SUBSCRIBE_TYPE_LOCAL,
/**
* Subscription to remote data changes
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
SUBSCRIBE_TYPE_REMOTE,
/**
* Subscription to both local and remote data changes
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
SUBSCRIBE_TYPE_ALL
}
/**
* Describes the KVStore type.
*
* @enum { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
enum KVStoreType {
/**
* Device-collaboration database, as specified by {@code DeviceKVStore}
*
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
DEVICE_COLLABORATION,
/**
* Single-version database, as specified by {@code SingleKVStore}
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
SINGLE_VERSION
}
/**
* Describes the KVStore security level.
*
* @enum { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
enum SecurityLevel {
/**
* S1: means the db is in the low security level
* There are some low impact when the data is leaked.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
S1,
/**
* S2: means the db is in the middle security level
* There are some major impact when the data is leaked.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
S2,
/**
* S3: means the db is in the high security level
* There are some severity impact when the data is leaked.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
S3,
/**
* S4: means the db is in the critical security level
* There are some critical impact when the data is leaked.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
S4
}
/**
* Provides configuration options to create a {@code SingleKVStore} or {@code DeviceKVStore}.
*
* @interface Options
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
interface Options {
/**
* Indicates whether to create a database when the database file does not exist
*
* @type { ?boolean }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
createIfMissing?: boolean;
/**
* Indicates whether database files to be encrypted
*
* @type { ?boolean }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
encrypt?: boolean;
/**
* Indicates whether to back up database files
*
* @type { ?boolean }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
backup?: boolean;
/**
* Indicates whether database files are automatically synchronized
*
* @permission ohos.permission.DISTRIBUTED_DATASYNC
* @type { ?boolean }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
autoSync?: boolean;
/**
* Indicates the database type
*
* @type { ?KVStoreType }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
kvStoreType?: KVStoreType;
/**
* Indicates the database security level
*
* @type { SecurityLevel }
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
securityLevel: SecurityLevel;
/**
* Indicates the database schema
*
* @type { ?Schema }
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
schema?: Schema;
}
/**
* Represents the database schema.
* You can set the schema object in options when create or open the database.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
class Schema {
/**
* A constructor used to create a Schema instance.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
constructor();
/**
* Indicates the root json object.
*
* @type { FieldNode }
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
root: FieldNode;
/**
* Indicates the string array of json.
*
* @type { Array<string> }
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
indexes: Array<string>;
/**
* Indicates the mode of schema.
*
* @type { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
mode: number;
/**
* Indicates the skip size of schema.
*
* @type { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
skip: number;
}
/**
* Represents a node of a {@link Schema} instance.
* <p>With a {@link Schema} instance, you can define the value fields which stored in the database.
* <p>A FieldNode of the {@link Schema} instance is either a leaf or a non-leaf node.
* <p>The leaf node must have a value; the non-leaf node must have a child {@code FieldNode}.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
class FieldNode {
/**
* A constructor used to create a FieldNode instance with the specified field.
* name Indicates the field node name.
*
* @param { string } name - It can not be empty.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
constructor(name: string);
/**
* Adds a child node to this {@code FieldNode}.
* <p>Add a child node to makes this node a non-leaf node and field value will be ignored if it has a child node.
*
* @param { FieldNode } child - The field node to append.
* @returns { boolean } Returns true if the child node is successfully added to this {@code FieldNode} and false otherwise.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
appendChild(child: FieldNode): boolean;
/**
* Indicates the default value of field node.
*
* @type { string }
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
default: string;
/**
* Indicates the nullable of database field.
*
* @type { boolean }
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
nullable: boolean;
/**
* Indicates the type of value.
*
* @type { number }
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
type: number;
}
/**
* Provides methods to operate the result set of the {@code SingleKVStore} or {@code DeviceKVStore} database.
* <p>The result set is created by using the {@code getResultSet} method in the {@code SingleKVStore} or
* {@code DeviceKVStore} class. This interface also provides methods to move the data read
* position in the result set.
*
* @interface KVStoreResultSet
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
interface KVStoreResultSet {
/**
* Obtains the number of lines in a result set.
*
* @returns { number } Returns the number of lines.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getCount(): number;
/**
* Obtains the current read position in a result set.
*
* @returns { number } Returns the current read position. The read position starts with 0.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getPosition(): number;
/**
* Moves the read position to the first line.
* <p>If the result set is empty, false is returned.
*
* @returns { boolean } Returns true if the operation succeeds; return false otherwise.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
moveToFirst(): boolean;
/**
* Moves the read position to the last line.
* <p>If the result set is empty, false is returned.
*
* @returns { boolean } Returns true if the operation succeeds; return false otherwise.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
moveToLast(): boolean;
/**
* Moves the read position to the next line.
* <p>If the result set is empty or the data in the last line is being read, false is returned.
*
* @returns { boolean } Returns true if the operation succeeds; return false otherwise.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
moveToNext(): boolean;
/**
* Moves the read position to the previous line.
* <p>If the result set is empty or the data in the first line is being read, false is returned.
*
* @returns { boolean } Returns true if the operation succeeds; return false otherwise.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
moveToPrevious(): boolean;
/**
* Moves the read position by a relative offset to the current position.
*
* @param { number } offset - Indicates the relative offset to the current position. A negative offset indicates moving
* backwards, and a positive offset indicates moving forwards. For example, if the current position is entry 1 and
* this offset is 2, the destination position will be entry 3; if the current position is entry 3 and this offset is -2,
* the destination position will be entry 1. The valid final position after moving forwards starts with 0. If the
* final position is invalid, false will be returned.
* @returns { boolean } Returns true if the operation succeeds; return false otherwise.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
move(offset: number): boolean;
/**
* Moves the read position from 0 to an absolute position.
*
* @param { number } position - Indicates the absolute position.
* @returns { boolean } Returns true if the operation succeeds; return false otherwise.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
moveToPosition(position: number): boolean;
/**
* Checks whether the read position is the first line.
*
* @returns { boolean } Returns true if the read position is the first line; returns false otherwise.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
isFirst(): boolean;
/**
* Checks whether the read position is the last line.
*
* @returns { boolean } Returns true if the read position is the last line; returns false otherwise.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
isLast(): boolean;
/**
* Checks whether the read position is before the last line.
*
* @returns { boolean } Returns true if the read position is before the first line; returns false otherwise.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
isBeforeFirst(): boolean;
/**
* Checks whether the read position is after the last line.
*
* @returns { boolean } Returns true if the read position is after the last line; returns false otherwise.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
isAfterLast(): boolean;
/**
* Obtains a key-value pair.
*
* @returns { Entry } Returns a key-value pair.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getEntry(): Entry;
}
/**
* Represents a database query using predicates.
* <p>This class provides a constructor used to create a {@code Query} instance, which is used to query data
* matching specified conditions in the database.
* <p>This class also provides methods to add predicates to the {@code Query} instance.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
class Query {
/**
* A constructor used to create a Query instance.
*
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
constructor();
/**
* Resets this {@code Query} object.
*
* @returns { Query } Returns the reset {@code Query} object.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
reset(): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is equal to the specified long value.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { number | string | boolean } value - Indicates the value to be compared.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
equalTo(field: string, value: number | string | boolean): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is not equal to the specified int value.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { number | string | boolean } value - Indicates the value to be compared.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
notEqualTo(field: string, value: number | string | boolean): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is greater than or equal to the
* specified int value.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { number | string | boolean } value - Indicates the value to be compared.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
greaterThan(field: string, value: number | string | boolean): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is less than the specified int value.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { number | string } value - Indicates the value to be compared.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
lessThan(field: string, value: number | string): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is greater than or
* equal to the specified int value.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { number | string } value - Indicates the value to be compared.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
greaterThanOrEqualTo(field: string, value: number | string): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is less than or equal to the
* specified int value.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { number | string } value - Indicates the value to be compared.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
lessThanOrEqualTo(field: string, value: number | string): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is null.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
isNull(field: string): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is within the specified int value list.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { number[] } valueList - Indicates the int value list.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
inNumber(field: string, valueList: number[]): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is within the specified string value list.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { string[] } valueList - Indicates the string value list.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
inString(field: string, valueList: string[]): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is not within the specified int value list.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { number[] } valueList - Indicates the int value list.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
notInNumber(field: string, valueList: number[]): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is not within the specified string value list.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { string[] } valueList - Indicates the string value list.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
notInString(field: string, valueList: string[]): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is similar to the specified string value.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { string } value - Indicates the string value.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
like(field: string, value: string): Query;
/**
* Constructs a {@code Query} object to query entries with the specified field whose value is not similar to the specified string value.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @param { string } value - Indicates the string value.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
unlike(field: string, value: string): Query;
/**
* Constructs a {@code Query} object with the and condition.
* <p>Multiple predicates should be connected using the and or or condition.
*
* @returns { Query } Returns the {@coed Query} object.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
and(): Query;
/**
* Constructs a {@code Query} object with the or condition.
* <p>Multiple predicates should be connected using the and or or condition.
*
* @returns { Query } Returns the {@coed Query} object.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
or(): Query;
/**
* Constructs a {@code Query} object to sort the query results in ascending order.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
orderByAsc(field: string): Query;
/**
* Constructs a {@code Query} object to sort the query results in descending order.
*
* @param { string } field - Indicates the field, which cannot contain ^.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
orderByDesc(field: string): Query;
/**
* Constructs a {@code Query} object to specify the number of results and the start position.
*
* @param { number } total - Indicates the number of results.
* @param { number } offset - Indicates the start position.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
limit(total: number, offset: number): Query;
/**
* Creates a {@code Query} condition with a specified field that is not null.
*
* @param { string } field - Indicates the specified field.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
isNotNull(field: string): Query;
/**
* Creates a query condition group with a left bracket.
* <p>Multiple query conditions in an {@code Query} object can be grouped. The query conditions in a group can be used as a
* whole to combine with other query conditions.
*
* @returns { Query } Returns the {@coed Query} object.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
beginGroup(): Query;
/**
* Creates a query condition group with a right bracket.
* <p>Multiple query conditions in an {@code Query} object can be grouped. The query conditions in a group can be used as a
* whole to combine with other query conditions.
*
* @returns { Query } Returns the {@coed Query} object.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
endGroup(): Query;
/**
* Creates a query condition with a specified key prefix.
*
* @param { string } prefix - Indicates the specified key prefix.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
prefixKey(prefix: string): Query;
/**
* Sets a specified index that will be preferentially used for query.
*
* @param { string } index - Indicates the index to set.
* @returns { Query } Returns the {@coed Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
setSuggestIndex(index: string): Query;
/**
* Add device ID key prefix.Used by {@code DeviceKVStore}.
*
* @param { string } deviceId - Specify device id to query from, It can not be empty.
* @returns { Query } Returns the {@code Query} object with device ID prefix added.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
deviceId(deviceId: string): Query;
/**
* Get a String that represents this {@code Query}.
* <p>The String would be parsed to DB query format.
* The String length should be no longer than 500kb.
*
* @returns { string } String representing this {@code Query}.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getSqlLike(): string;
}
/**
* Provides methods related to single-version distributed databases.
* <p>To create a {@code SingleKVStore} database,
* you can use the {@link data.distributed.common.KVManager#getKVStore​(Options, String)} method
* with {@code KVStoreType} set to {@code SINGLE_VERSION} for the input parameter {@code Options}.
* This database synchronizes data to other databases in time sequence.
* The {@code SingleKVStore} database does not support
* synchronous transactions, or data search using snapshots.
*
* @interface SingleKVStore
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
interface SingleKVStore {
/**
* Writes a key-value pair of the string type into the {@code SingleKVStore} database.
* <p>If you do not want to synchronize this key-value pair to other devices, set the write option in the local database.
*
* @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}.
* Spaces before and after the key will be cleared.
* @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted.
* @param { AsyncCallback<void> } callback - the callback of put.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Writes a key-value pair of the string type into the {@code SingleKVStore} database.
* <p>If you do not want to synchronize this key-value pair to other devices, set the write option in the local database.
*
* @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}.
* Spaces before and after the key will be cleared.
* @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted.
* @param { AsyncCallback<void> } callback - the callback of put.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback<void>): void;
/**
* Writes a key-value pair of the string type into the {@code SingleKVStore} database.
* <p>If you do not want to synchronize this key-value pair to other devices, set the write option in the local database.
*
* @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}.
* Spaces before and after the key will be cleared.
* @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Writes a key-value pair of the string type into the {@code SingleKVStore} database.
* <p>If you do not want to synchronize this key-value pair to other devices, set the write option in the local database.
*
* @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}.
* Spaces before and after the key will be cleared.
* @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
put(key: string, value: Uint8Array | string | number | boolean): Promise<void>;
/**
* Inserts key-value pairs into the {@code SingleKVStore} database in batches.
*
* @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches.
* @param { AsyncCallback<void> } callback - the callback of putBatch.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Inserts key-value pairs into the {@code SingleKVStore} database in batches.
*
* @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches.
* @param { AsyncCallback<void> } callback - the callback of putBatch.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
putBatch(entries: Entry[], callback: AsyncCallback<void>): void;
/**
* Inserts key-value pairs into the {@code SingleKVStore} database in batches.
*
* @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Inserts key-value pairs into the {@code SingleKVStore} database in batches.
*
* @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
putBatch(entries: Entry[]): Promise<void>;
/**
* Writes values of ValuesBucket type into the {@code SingleKVStore} database.
*
* @param { Array<ValuesBucket> } value - Indicates the ValuesBucket array to be inserted.
* @param { AsyncCallback<void> } callback - the callback of putBatch.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Writes values of ValuesBucket type into the {@code SingleKVStore} database.
*
* @param { Array<ValuesBucket> } value - Indicates the ValuesBucket array to be inserted.
* @param { AsyncCallback<void> } callback - the callback of putBatch.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @systemapi
* @StageModelOnly
* @since 10
*/
putBatch(value: Array<ValuesBucket>, callback: AsyncCallback<void>): void;
/**
* Writes values of ValuesBucket type into the {@code SingleKVStore} database.
*
* @param { Array<ValuesBucket> } value - Indicates the ValuesBucket array to be inserted.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Writes values of ValuesBucket type into the {@code SingleKVStore} database.
*
* @param { Array<ValuesBucket> } value - Indicates the ValuesBucket array to be inserted.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @systemapi
* @StageModelOnly
* @since 10
*/
putBatch(value: Array<ValuesBucket>): Promise<void>;
/**
* Deletes the key-value pair based on a specified key.
*
* @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}.
* Spaces before and after the key will be cleared.
* @param { AsyncCallback<void> } callback - the callback of delete.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Deletes the key-value pair based on a specified key.
*
* @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}.
* Spaces before and after the key will be cleared.
* @param { AsyncCallback<void> } callback - the callback of delete.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
delete(key: string, callback: AsyncCallback<void>): void;
/**
* Deletes the key-value pair based on a specified key.
*
* @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}.
* Spaces before and after the key will be cleared.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Deletes the key-value pair based on a specified key.
*
* @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}.
* Spaces before and after the key will be cleared.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
delete(key: string): Promise<void>;
/**
* Deletes the key-value pairs based on the dataSharePredicates.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates.
* @param { AsyncCallback<void> } callback - the callback of delete.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Deletes the key-value pairs based on the dataSharePredicates.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates.
* @param { AsyncCallback<void> } callback - the callback of delete.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 10
*/
delete(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<void>);
/**
* Deletes the key-value pairs based on the dataSharePredicates.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Deletes the key-value pairs based on the dataSharePredicates.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 10
*/
delete(predicates: dataSharePredicates.DataSharePredicates): Promise<void>;
/**
* Deletes key-value pairs in batches from the {@code SingleKVStore} database.
*
* @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty.
* @param { AsyncCallback<void> } callback - the callback of deleteBatch.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Deletes key-value pairs in batches from the {@code SingleKVStore} database.
*
* @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty.
* @param { AsyncCallback<void> } callback - the callback of deleteBatch.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
deleteBatch(keys: string[], callback: AsyncCallback<void>): void;
/**
* Deletes key-value pairs in batches from the {@code SingleKVStore} database.
*
* @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Deletes key-value pairs in batches from the {@code SingleKVStore} database.
*
* @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
deleteBatch(keys: string[]): Promise<void>;
/**
* Removes data of the specified device from current database. This method is used to remove only the data
* synchronized from remote devices. This operation does not synchronize data to other databases or affect
* subsequent data synchronization.
*
* @param { string } deviceId - Identifies the device whose data is to be removed and the value cannot be the current device ID.
* @param { AsyncCallback<void> } callback - the callback of removeDeviceData.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void;
/**
* Removes data of the specified device from current database. This method is used to remove only the data
* synchronized from remote devices. This operation does not synchronize data to other databases or affect
* subsequent data synchronization.
*
* @param { string } deviceId - Identifies the device whose data is to be removed and the value cannot be the current device ID.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
removeDeviceData(deviceId: string): Promise<void>;
/**
* Obtains the value of a specified key.
*
* @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}.
* @param { AsyncCallback<boolean | string | number | Uint8Array> } callback -
* {Uint8Array|string|boolean|number}: the returned value specified by the key.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100004 - Not found.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
get(key: string, callback: AsyncCallback<boolean | string | number | Uint8Array>): void;
/**
* Obtains the value of a specified key.
*
* @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}.
* @returns { Promise<boolean | string | number | Uint8Array> }
* {Uint8Array|string|boolean|number}: the returned value specified by the key.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100004 - Not found.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
get(key: string): Promise<boolean | string | number | Uint8Array>;
/**
* Obtains all key-value pairs that match a specified key prefix.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @param { AsyncCallback<Entry[]> } callback - {Entry[]}: the list of all key-value pairs
* that match the specified key prefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getEntries(keyPrefix: string, callback: AsyncCallback<Entry[]>): void;
/**
* Obtains all key-value pairs that match a specified key prefix.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @returns { Promise<Entry[]> } {Entry[]}: the list of all key-value pairs that match the
* specified key prefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getEntries(keyPrefix: string): Promise<Entry[]>;
/**
* Obtains the list of key-value pairs matching the specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<Entry[]> } callback - {Entry[]}: the list of all key-value pairs
* matching the specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getEntries(query: Query, callback: AsyncCallback<Entry[]>): void;
/**
* Obtains the list of key-value pairs matching the specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<Entry[]> } {Entry[]}: the list of all key-value pairs matching the
* specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getEntries(query: Query): Promise<Entry[]>;
/**
* Obtains the result set with a specified prefix from a {@code SingleKVStore} database. The {@code KVStoreResultSet}
* object can be used to query all key-value pairs that meet the search criteria. Each {@code SingleKVStore}
* instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created
* four objects, calling this method will return a failure. Therefore, you are advised to call the closeResultSet
* method to close unnecessary {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Obtains the result set with a specified prefix from a {@code SingleKVStore} database. The {@code KVStoreResultSet}
* object can be used to query all key-value pairs that meet the search criteria. Each {@code SingleKVStore}
* instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created
* four objects, calling this method will return a failure. Therefore, you are advised to call the closeResultSet
* method to close unnecessary {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
getResultSet(keyPrefix: string, callback: AsyncCallback<KVStoreResultSet>): void;
/**
* Obtains the result set with a specified prefix from a {@code SingleKVStore} database. The {@code KVStoreResultSet}
* object can be used to query all key-value pairs that meet the search criteria. Each {@code SingleKVStore}
* instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created
* four objects, calling this method will return a failure. Therefore, you are advised to call the closeResultSet
* method to close unnecessary {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Obtains the result set with a specified prefix from a {@code SingleKVStore} database. The {@code KVStoreResultSet}
* object can be used to query all key-value pairs that meet the search criteria. Each {@code SingleKVStore}
* instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created
* four objects, calling this method will return a failure. Therefore, you are advised to call the closeResultSet
* method to close unnecessary {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
getResultSet(keyPrefix: string): Promise<KVStoreResultSet>;
/**
* Obtains the {@code KVStoreResultSet} object matching the specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Obtains the {@code KVStoreResultSet} object matching the specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
getResultSet(query: Query, callback: AsyncCallback<KVStoreResultSet>): void;
/**
* Obtains the {@code KVStoreResultSet} object matching the specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Obtains the {@code KVStoreResultSet} object matching the specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
getResultSet(query: Query): Promise<KVStoreResultSet>;
/**
* Obtains the KVStoreResultSet object matching the specified predicate object.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Obtains the KVStoreResultSet object matching the specified predicate object.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 10
*/
getResultSet(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<KVStoreResultSet>): void;
/**
* Obtains the KVStoreResultSet object matching the specified predicate object.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Obtains the KVStoreResultSet object matching the specified predicate object.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 10
*/
getResultSet(predicates: dataSharePredicates.DataSharePredicates): Promise<KVStoreResultSet>;
/**
* Closes a {@code KVStoreResultSet} object returned by getResultSet method.
*
* @param { KVStoreResultSet } resultSet - Indicates the {@code KVStoreResultSet} object to close.
* @param { AsyncCallback<void> } callback - the callback of closeResultSet.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
closeResultSet(resultSet: KVStoreResultSet, callback: AsyncCallback<void>): void;
/**
* Closes a {@code KVStoreResultSet} object returned by getResultSet method.
*
* @param { KVStoreResultSet } resultSet - Indicates the {@code KVStoreResultSet} object to close.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
closeResultSet(resultSet: KVStoreResultSet): Promise<void>;
/**
* Obtains the number of results matching the specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<number> } callback - {number}: the number of results matching the
* specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getResultSize(query: Query, callback: AsyncCallback<number>): void;
/**
* Obtains the number of results matching the specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<number> } {number}: the number of results matching the specified
* {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getResultSize(query: Query): Promise<number>;
/**
* Backs up a database in the specified filename.
*
* @param { string } file - Indicates the database backup filename, It can not be empty and
* The length must be less than {@code MAX_KEY_LENGTH}.
* @param { AsyncCallback<void> } callback - the callback of backup.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
backup(file: string, callback: AsyncCallback<void>): void;
/**
* Backs up a database in the specified filename.
*
* @param { string } file - Indicates the database backup filename, It can not be empty and
* The length must be less than {@code MAX_KEY_LENGTH}.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
backup(file: string): Promise<void>;
/**
* Restores a database from a specified database file.
*
* @param { string } file - Indicates the database backup filename, It can not be empty and
* The length must be less than {@code MAX_KEY_LENGTH}.
* @param { AsyncCallback<void> } callback - the callback of restore.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
restore(file: string, callback: AsyncCallback<void>): void;
/**
* Restores a database from a specified database file.
*
* @param { string } file - Indicates the database backup filename, It can not be empty and
* The length must be less than {@code MAX_KEY_LENGTH}.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
restore(file: string): Promise<void>;
/**
* Delete database backup files based on the specified filenames.
*
* @param { Array<string> } files - Indicates the backup filenames to be deleted, It can not be empty and
* The length must be less than {@code MAX_KEY_LENGTH}.
* @param { AsyncCallback<Array<[string, number]>> } callback - {Array<[string, number]>}:
* the list of backup file and it's corresponding delete result which 0 means delete success
* and otherwise failed.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
deleteBackup(files: Array<string>, callback: AsyncCallback<Array<[string, number]>>): void;
/**
* Delete database backup files based on the specified filenames.
*
* @param { Array<string> } files - Indicates the backup filenames to be deleted, It can not be empty and
* The length must be less than {@code MAX_KEY_LENGTH}.
* @returns { Promise<Array<[string, number]>> } {Array<[string, number]>}: the list of backup
* file and it's corresponding delete result which 0 means delete success and otherwise failed.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
deleteBackup(files: Array<string>): Promise<Array<[string, number]>>;
/**
* Starts a transaction operation in the {@code SingleKVStore} database.
* <p>After the database transaction is started, you can submit or roll back the operation.
*
* @param { AsyncCallback<void> } callback - the callback of startTransaction.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Starts a transaction operation in the {@code SingleKVStore} database.
* <p>After the database transaction is started, you can submit or roll back the operation.
*
* @param { AsyncCallback<void> } callback - the callback of startTransaction.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
startTransaction(callback: AsyncCallback<void>): void;
/**
* Starts a transaction operation in the {@code SingleKVStore} database.
* <p>After the database transaction is started, you can submit or roll back the operation.
*
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Starts a transaction operation in the {@code SingleKVStore} database.
* <p>After the database transaction is started, you can submit or roll back the operation.
*
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
startTransaction(): Promise<void>;
/**
* Submits a transaction operation in the {@code SingleKVStore} database.
*
* @param { AsyncCallback<void> } callback - the callback of commit.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
commit(callback: AsyncCallback<void>): void;
/**
* Submits a transaction operation in the {@code SingleKVStore} database.
*
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
commit(): Promise<void>;
/**
* Rolls back a transaction operation in the {@code SingleKVStore} database.
*
* @param { AsyncCallback<void> } callback - the callback of rollback.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
rollback(callback: AsyncCallback<void>): void;
/**
* Rolls back a transaction operation in the {@code SingleKVStore} database.
*
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
rollback(): Promise<void>;
/**
* Sets whether to enable synchronization.
*
* @param { boolean } enabled - Specifies whether to enable synchronization. The value true
* means to enable synchronization, and false means the opposite.
* @param { AsyncCallback<void> } callback - the callback of enableSync.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
enableSync(enabled: boolean, callback: AsyncCallback<void>): void;
/**
* Sets whether to enable synchronization.
*
* @param { boolean } enabled - Specifies whether to enable synchronization. The value true
* means to enable synchronization, and false means the opposite.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
enableSync(enabled: boolean): Promise<void>;
/**
* Sets synchronization range labels.
* <p>The labels determine the devices with which data will be synchronized.
*
* @param { string[] } localLabels - Indicates the synchronization labels of the local device.
* @param { string[] } remoteSupportLabels - Indicates the labels of the devices with which
* data will be synchronized.
* @param { AsyncCallback<void> } callback - the callback of setSyncRange.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback<void>): void;
/**
* Sets synchronization range labels.
* <p>The labels determine the devices with which data will be synchronized.
*
* @param { string[] } localLabels - Indicates the synchronization labels of the local device.
* @param { string[] } remoteSupportLabels - Indicates the labels of the devices with which
* data will be synchronized.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise<void>;
/**
* Sets the default delay allowed for database synchronization
*
* @param { number } defaultAllowedDelayMs - Indicates the default delay allowed for the
* database synchronization, in milliseconds.
* @param { AsyncCallback<void> } callback - the callback of setSyncParam.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback<void>): void;
/**
* Sets the default delay allowed for database synchronization
*
* @param { number } defaultAllowedDelayMs - Indicates the default delay allowed for the
* database synchronization, in milliseconds.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
setSyncParam(defaultAllowedDelayMs: number): Promise<void>;
/**
* Synchronize the database to the specified devices with the specified delay allowed.
*
* @permission ohos.permission.DISTRIBUTED_DATASYNC
* @param { string[] } deviceIds - Indicates the list of devices to which to synchronize the database.
* @param { SyncMode } mode - Indicates the synchronization mode. The value can be {@code PUSH},
* {@code PULL}, or {@code PUSH_PULL}.
* @param { number } delayMs - Indicates the delay allowed for the synchronization, in milliseconds.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100004 - Not found.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void;
/**
* Synchronize the database to the specified devices with the specified delay allowed.
*
* @permission ohos.permission.DISTRIBUTED_DATASYNC
* @param { string[] } deviceIds - Indicates the list of devices to which to synchronize the database.
* @param { Query } query - Indicates the {@code Query} object.
* @param { SyncMode } mode - Indicates the synchronization mode. The value can be {@code PUSH},
* {@code PULL}, or {@code PUSH_PULL}.
* @param { number } delayMs - Indicates the delay allowed for the synchronization, in milliseconds.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100004 - Not found.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
sync(deviceIds: string[], query: Query, mode: SyncMode, delayMs?: number): void;
/**
* Register a callback to the database and when data in the distributed database has changed,
* the callback will be invoked.
*
* @param { 'dataChange' } event - Subscribed event name, fixed as 'dataChange', indicates the data change event.
* @param { SubscribeType } type - Indicates the subscription type, which is defined in {@code SubscribeType}.
* @param { Callback<ChangeNotification> } listener - {ChangeNotification}: the {@code ChangeNotification}
* object indicates the data change events in the distributed database.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Register a callback to the database and when data in the distributed database has changed,
* the callback will be invoked.
*
* @param { 'dataChange' } event - Subscribed event name, fixed as 'dataChange', indicates the data change event.
* @param { SubscribeType } type - Indicates the subscription type, which is defined in {@code SubscribeType}.
* @param { Callback<ChangeNotification> } listener - {ChangeNotification}: the {@code ChangeNotification}
* object indicates the data change events in the distributed database.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
on(event: 'dataChange', type: SubscribeType, listener: Callback<ChangeNotification>): void;
/**
* Register a databases synchronization callback to the database.
* <p> Sync result is returned through asynchronous callback.
*
* @param { 'syncComplete' } event - Subscribed event name, fixed as 'syncComplete', indicates the synchronization completion event.
* @param { Callback<Array<[string, number]>> } syncCallback - {Array<[string, number]>}: the
* deviceId and it's corresponding synchronization result which 0 means synchronization success
* and otherwise failed.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void;
/**
* Unsubscribe from the SingleKVStore database based on the specified subscribeType and listener.
*
* @param { 'dataChange' } event - The unsubscribe event name, fixed as 'dataChange', indicates the data change event.
* @param { Callback<ChangeNotification> } listener - {ChangeNotification}: the {@code ChangeNotification}
* object indicates the data change events in the distributed database.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
off(event: 'dataChange', listener?: Callback<ChangeNotification>): void;
/**
* Unregister the database synchronization callback.
*
* @param { 'syncComplete' } event - The unsubscribe event name, fixed as 'syncComplete', indicates the synchronization completion event.
* @param { Callback<Array<[string, number]>> } syncCallback - {Array<[string, number]>}: the
* deviceId and it's corresponding synchronization result which 0 means synchronization success
* and otherwise failed.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void;
/**
* Get the security level of the database.
*
* @param { AsyncCallback<SecurityLevel> } callback - {SecurityLevel}: the {@code SecurityLevel}
* object indicates the security level of the database.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getSecurityLevel(callback: AsyncCallback<SecurityLevel>): void;
/**
* Get the security level of the database.
*
* @returns { Promise<SecurityLevel> } {SecurityLevel}: the {@code SecurityLevel} object indicates
* the security level of the database.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getSecurityLevel(): Promise<SecurityLevel>;
}
/**
* Provides methods related to device-collaboration distributed databases.
* <p>To create a {@code DeviceKVStore} database, you can use the {@link data.distributed.common.KVManager.getKVStore(Options, String)}
* method with {@code KVStoreType} set to {@code DEVICE_COLLABORATION} for the input parameter Options. This database manages distributed
* data by device, and cannot modify data synchronized from remote devices. When an application writes a key-value pair entry
* into the database, the system automatically adds the ID of the device running the application to the key.
*
* @interface DeviceKVStore
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
interface DeviceKVStore extends SingleKVStore {
/**
* Obtains the value matching the local device ID and specified key.
*
* @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}.
* @param { AsyncCallback<boolean | string | number | Uint8Array> } callback -
* {Uint8Array|string|boolean|number}: the returned value specified by the local device ID and specified key.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100004 - Not found.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
get(key: string, callback: AsyncCallback<boolean | string | number | Uint8Array>): void;
/**
* Obtains the value matching the local device ID and specified key.
*
* @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}.
* @returns { Promise<boolean | string | number | Uint8Array> }
* {Uint8Array|string|boolean|number}: the returned value specified by the local device ID and specified key.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100004 - Not found.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
get(key: string): Promise<boolean | string | number | Uint8Array>;
/**
* Obtains the value matching a specified device ID and key.
*
* @param { string } deviceId - Indicates the device to be queried.
* @param { string } key - Indicates the key of the value to be queried. The length must be less than {@code MAX_KEY_LENGTH}.
* @param { AsyncCallback<boolean | string | number | Uint8Array> } callback -
* {boolean | string | number | Uint8Array}: the returned value specified by the deviceId and key.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100004 - Not found.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
get(deviceId: string, key: string, callback: AsyncCallback<boolean | string | number | Uint8Array>): void;
/**
* Obtains the value matching a specified device ID and key.
*
* @param { string } deviceId - Indicates the device to be queried.
* @param { string } key - Indicates the key of the value to be queried. The length must be less than {@code MAX_KEY_LENGTH}.
* @returns { Promise<boolean | string | number | Uint8Array> }
* {Uint8Array|string|boolean|number}: the returned value specified by the deviceId and key.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100004 - Not found.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
get(deviceId: string, key: string): Promise<boolean | string | number | Uint8Array>;
/**
* Obtains all key-value pairs that match the local device ID and specified key prefix.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @param { AsyncCallback<Entry[]> } callback - {Entry[]}: the list of all key-value pairs
* that match the local device ID and specified key prefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getEntries(keyPrefix: string, callback: AsyncCallback<Entry[]>): void;
/**
* Obtains all key-value pairs that match the local device ID and specified key prefix.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @returns { Promise<Entry[]> } {Entry[]}: the list of all key-value pairs that match the
* local device ID and specified key prefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getEntries(keyPrefix: string): Promise<Entry[]>;
/**
* Obtains all key-value pairs matching a specified device ID and key prefix.
*
* @param { string } deviceId - Identifies the device whose data is to be queried.
* @param { string } keyPrefix - Indicates the key prefix to match.
* @param { AsyncCallback<Entry[]> } callback - {Entry[]}: the list of all key-value pairs
* that match the specified deviceId and key prefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry[]>): void;
/**
* Obtains all key-value pairs matching a specified device ID and key prefix.
*
* @param { string } deviceId - Identifies the device whose data is to be queried.
* @param { string } keyPrefix - Indicates the key prefix to match.
* @returns { Promise<Entry[]> } {Entry[]}: the list of all key-value pairs that match the
* specified deviceId and key prefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
getEntries(deviceId: string, keyPrefix: string): Promise<Entry[]>;
/**
* Obtains the list of key-value pairs matching the local device ID and specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<Entry[]> } callback - {Entry[]}: the list of all key-value pairs
* matching the local device ID and specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getEntries(query: Query, callback: AsyncCallback<Entry[]>): void;
/**
* Obtains the list of key-value pairs matching the local device ID and specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<Entry[]> } {Entry[]}: the list of all key-value pairs matching the local device ID and
* specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getEntries(query: Query): Promise<Entry[]>;
/**
* Obtains the list of key-value pairs matching a specified device ID and {@code Query} object.
*
* @param { string } deviceId - Indicates the ID of the device to which the key-value pairs belong.
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<Entry[]> } callback - {Entry[]}: the list of all key-value pairs
* matching the specified deviceId and {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
getEntries(deviceId: string, query: Query, callback: AsyncCallback<Entry[]>): void;
/**
* Obtains the list of key-value pairs matching a specified device ID and {@code Query} object.
*
* @param { string } deviceId - Indicates the ID of the device to which the key-value pairs belong.
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<Entry[]> } {Entry[]}: the list of all key-value pairs matching the
* specified deviceId and {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
getEntries(deviceId: string, query: Query): Promise<Entry[]>;
/**
* Obtains the result set with the local device ID and specified prefix from a {@code DeviceKVStore} database.
* The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria.
* Each {@code DeviceKVStore} instance can have a maximum of four {@code KVStoreResultSet} objects at the same time.
* If you have created four objects, calling this method will return a failure. Therefore, you are advised to
* call the closeResultSet method to close unnecessary {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Obtains the result set with the local device ID and specified prefix from a {@code DeviceKVStore} database.
* The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria.
* Each {@code DeviceKVStore} instance can have a maximum of four {@code KVStoreResultSet} objects at the same time.
* If you have created four objects, calling this method will return a failure. Therefore, you are advised to
* call the closeResultSet method to close unnecessary {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
getResultSet(keyPrefix: string, callback: AsyncCallback<KVStoreResultSet>): void;
/**
* Obtains the result set with the local device ID and specified prefix from a {@code DeviceKVStore} database.
* The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria.
* Each {@code DeviceKVStore} instance can have a maximum of four {@code KVStoreResultSet} objects at the same time.
* If you have created four objects, calling this method will return a failure. Therefore, you are advised to
* call the closeResultSet method to close unnecessary {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Obtains the result set with the local device ID and specified prefix from a {@code DeviceKVStore} database.
* The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria.
* Each {@code DeviceKVStore} instance can have a maximum of four {@code KVStoreResultSet} objects at the same time.
* If you have created four objects, calling this method will return a failure. Therefore, you are advised to
* call the closeResultSet method to close unnecessary {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } keyPrefix - Indicates the key prefix to match.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
getResultSet(keyPrefix: string): Promise<KVStoreResultSet>;
/**
* Obtains the {@code KVStoreResultSet} object matching the specified device ID and key prefix.
* <p>The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. Each {@code DeviceKVStore}
* instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created four objects,
* calling this method will return a failure. Therefore, you are advised to call the closeResultSet method to close unnecessary
* {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } deviceId - Identifies the device whose data is to be queried.
* @param { string } keyPrefix - Indicates the key prefix to match.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
/**
* Obtains the {@code KVStoreResultSet} object matching the specified device ID and key prefix.
* <p>The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. Each {@code DeviceKVStore}
* instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created four objects,
* calling this method will return a failure. Therefore, you are advised to call the closeResultSet method to close unnecessary
* {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } deviceId - Identifies the device whose data is to be queried.
* @param { string } keyPrefix - Indicates the key prefix to match.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 10
*/
getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback<KVStoreResultSet>): void;
/**
* Obtains the {@code KVStoreResultSet} object matching the specified device ID and key prefix.
* <p>The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. Each {@code DeviceKVStore}
* instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created four objects,
* calling this method will return a failure. Therefore, you are advised to call the closeResultSet method to close unnecessary
* {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } deviceId - Identifies the device whose data is to be queried.
* @param { string } keyPrefix - Indicates the key prefix to match.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
/**
* Obtains the {@code KVStoreResultSet} object matching the specified device ID and key prefix.
* <p>The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. Each {@code DeviceKVStore}
* instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created four objects,
* calling this method will return a failure. Therefore, you are advised to call the closeResultSet method to close unnecessary
* {@code KVStoreResultSet} objects in a timely manner.
*
* @param { string } deviceId - Identifies the device whose data is to be queried.
* @param { string } keyPrefix - Indicates the key prefix to match.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and keyPrefix.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 10
*/
getResultSet(deviceId: string, keyPrefix: string): Promise<KVStoreResultSet>;
/**
* Obtains the {@code KVStoreResultSet} object matching the local device ID and specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Obtains the {@code KVStoreResultSet} object matching the local device ID and specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
getResultSet(query: Query, callback: AsyncCallback<KVStoreResultSet>): void;
/**
* Obtains the {@code KVStoreResultSet} object matching the local device ID and specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
/**
* Obtains the {@code KVStoreResultSet} object matching the local device ID and specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 10
*/
getResultSet(query: Query): Promise<KVStoreResultSet>;
/**
* Obtains the {@code KVStoreResultSet} object matching a specified device ID and {@code Query} object.
*
* @param { string } deviceId - Indicates the ID of the device to which the {@code KVStoreResultSet} object belongs.
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
/**
* Obtains the {@code KVStoreResultSet} object matching a specified device ID and {@code Query} object.
*
* @param { string } deviceId - Indicates the ID of the device to which the {@code KVStoreResultSet} object belongs.
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 10
*/
getResultSet(deviceId: string, query: Query, callback: AsyncCallback<KVStoreResultSet>): void;
/**
* Obtains the {@code KVStoreResultSet} object matching a specified device ID and {@code Query} object.
*
* @param { string } deviceId - Indicates the ID of the device to which the {@code KVStoreResultSet} object belongs.
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
/**
* Obtains the {@code KVStoreResultSet} object matching a specified device ID and {@code Query} object.
*
* @param { string } deviceId - Indicates the ID of the device to which the {@code KVStoreResultSet} object belongs.
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 10
*/
getResultSet(deviceId: string, query: Query): Promise<KVStoreResultSet>;
/**
* Obtains the KVStoreResultSet object matching the local device ID and specified predicate object.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Obtains the KVStoreResultSet object matching the local device ID and specified predicate object.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 10
*/
getResultSet(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<KVStoreResultSet>): void;
/**
* Obtains the KVStoreResultSet object matching the local device ID and specified predicate object.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Obtains the KVStoreResultSet object matching the local device ID and specified predicate object.
*
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 10
*/
getResultSet(predicates: dataSharePredicates.DataSharePredicates): Promise<KVStoreResultSet>;
/**
* Obtains the KVStoreResultSet object matching a specified Device ID and Predicate object.
*
* @param { string } deviceId Indicates the ID of the device to which the results belong.
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Obtains the KVStoreResultSet object matching a specified Device ID and Predicate object.
*
* @param { string } deviceId Indicates the ID of the device to which the results belong.
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates.
* @param { AsyncCallback<KVStoreResultSet> } callback - {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 10
*/
getResultSet(
deviceId: string,
predicates: dataSharePredicates.DataSharePredicates,
callback: AsyncCallback<KVStoreResultSet>
): void;
/**
* Obtains the KVStoreResultSet object matching a specified Device ID and Predicate object.
*
* @param { string } deviceId Indicates the ID of the device to which the results belong.
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 9
*/
/**
* Obtains the KVStoreResultSet object matching a specified Device ID and Predicate object.
*
* @param { string } deviceId Indicates the ID of the device to which the results belong.
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates.
* @returns { Promise<KVStoreResultSet> } {KVStoreResultSet}: the {@code KVStoreResultSet}
* object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 15100001 - Over max limits.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @StageModelOnly
* @since 10
*/
getResultSet(deviceId: string, predicates: dataSharePredicates.DataSharePredicates): Promise<KVStoreResultSet>;
/**
* Obtains the number of results matching the local device ID and specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<number> } callback - {number}: the number of results matching the
* local device ID and specified {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getResultSize(query: Query, callback: AsyncCallback<number>): void;
/**
* Obtains the number of results matching the local device ID and specified {@code Query} object.
*
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<number> } {number}: the number of results matching the local device ID and specified
* {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getResultSize(query: Query): Promise<number>;
/**
* Obtains the number of results matching a specified device ID and {@code Query} object.
*
* @param { string } deviceId - Indicates the ID of the device to which the results belong.
* @param { Query } query - Indicates the {@code Query} object.
* @param { AsyncCallback<number> } callback - {number}: the number of results matching the
* specified deviceId and {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
getResultSize(deviceId: string, query: Query, callback: AsyncCallback<number>): void;
/**
* Obtains the number of results matching a specified device ID and {@code Query} object.
*
* @param { string } deviceId - Indicates the ID of the device to which the results belong.
* @param { Query } query - Indicates the {@code Query} object.
* @returns { Promise<number> } {number}: the number of results matching the specified
* deviceId and {@code Query} object.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types.
* @throws { BusinessError } 15100003 - Database corrupted.
* @throws { BusinessError } 15100005 - Database or result set already closed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
getResultSize(deviceId: string, query: Query): Promise<number>;
}
/**
* Creates a {@link KVManager} instance based on the configuration information.
* <p>You must pass {@link KVManagerConfig} to provide configuration information
* to create a {@link KVManager} instance.
*
* @param { KVManagerConfig } config - Indicates the KVStore configuration information,
* including the package name and context, and package name can not be empty.
* @returns { KVManager } : the {@code KVManager} instance.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
function createKVManager(config: KVManagerConfig): KVManager;
/**
* Provides interfaces to manage a {@code SingleKVStore} database, including obtaining, closing, and deleting the {@code SingleKVStore}.
*
* @interface KVManager
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
interface KVManager {
/**
* Creates and obtains a KVStore database by specifying {@code Options} and {@code storeId}.
*
* @param { string } storeId - Identifies the KVStore database. The value of this parameter must be unique
* for the same application, and different applications can share the same value. The storeId can consist
* of only letters, digits, and underscores (_), and cannot exceed 128 characters.
* @param { Options } options - Indicates the {@code Options} object used for creating and
* obtaining the KVStore database.
* @param { AsyncCallback<T> } callback - {T}: the {@code SingleKVStore} or {@code DeviceKVStore} instance.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100002 - Open existed database with changed options.
* @throws { BusinessError } 15100003 - Database corrupted.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getKVStore<T>(storeId: string, options: Options, callback: AsyncCallback<T>): void;
/**
* Creates and obtains a KVStore database by specifying {@code Options} and {@code storeId}.
*
* @param { string } storeId - Identifies the KVStore database. The value of this parameter must be unique
* for the same application, and different applications can share the same value. The storeId can consist
* of only letters, digits, and underscores (_), and cannot exceed 128 characters.
* @param { Options } options - Indicates the {@code Options} object used for creating and
* obtaining the KVStore database.
* @returns { Promise<T> } {T}: the {@code SingleKVStore} or {@code DeviceKVStore} instance.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @throws { BusinessError } 15100002 - Open existed database with changed options.
* @throws { BusinessError } 15100003 - Database corrupted.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getKVStore<T>(storeId: string, options: Options): Promise<T>;
/**
* Closes the KVStore database.
* <p>Warning: This method is not thread-safe. If you call this method to stop a KVStore database that is running, your
* thread may crash.
* <p>The KVStore database to close must be an object created by using the {@code getKVStore} method. Before using this
* method, release the resources created for the database, for example, {@code KVStoreResultSet} for KVStore, otherwise
* closing the database will fail.
*
* @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters.
* @param { string } storeId - Identifies the KVStore database to close. The storeId can consist of only letters, digits,
* and underscores (_), and cannot exceed 128 characters.
* @param { AsyncCallback<void> } callback - the callback of closeKVStore.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
closeKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): void;
/**
* Closes the KVStore database.
* <p>Warning: This method is not thread-safe. If you call this method to stop a KVStore database that is running, your
* thread may crash.
* <p>The KVStore database to close must be an object created by using the {@code getKVStore} method. Before using this
* method, release the resources created for the database, for example, {@code KVStoreResultSet} for KVStore, otherwise
* closing the database will fail.
*
* @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters.
* @param { string } storeId - Identifies the KVStore database to close. The storeId can consist of only letters, digits,
* and underscores (_), and cannot exceed 128 characters.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
closeKVStore(appId: string, storeId: string): Promise<void>;
/**
* Deletes the KVStore database identified by storeId.
* <p>Before using this method, close all KVStore instances in use that are identified by the same storeId.
* <p>You can use this method to delete a KVStore database not in use. After the database is deleted, all its data will be
* lost.
*
* @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters.
* @param { string } storeId - Identifies the KVStore database to delete. The storeId can consist of only letters, digits,
* and underscores (_), and cannot exceed 128 characters.
* @param { AsyncCallback<void> } callback - the callback of deleteKVStore.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @throws { BusinessError } 15100004 - Not found.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): void;
/**
* Deletes the KVStore database identified by storeId.
* <p>Before using this method, close all KVStore instances in use that are identified by the same storeId.
* <p>You can use this method to delete a KVStore database not in use. After the database is deleted, all its data will be
* lost.
*
* @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters.
* @param { string } storeId - Identifies the KVStore database to delete. The storeId can consist of only letters, digits,
* and underscores (_), and cannot exceed 128 characters.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @throws { BusinessError } 15100004 - Not found.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
deleteKVStore(appId: string, storeId: string): Promise<void>;
/**
* Obtains the storeId of all KVStore databases that are created by using the {@code getKVStore} method and not deleted by
* calling the {@code deleteKVStore} method.
*
* @param { string } appId - Identifies the application that obtains the databases, and cannot exceed 256 characters.
* @param { AsyncCallback<string[]> } callback - {string[]}: the storeId of all created KVStore databases.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void;
/**
* Obtains the storeId of all KVStore databases that are created by using the {@code getKVStore} method and not deleted by
* calling the {@code deleteKVStore} method.
*
* @param { string } appId - Identifies the application that obtains the databases, and cannot exceed 256 characters.
* @returns { Promise<string[]> } {string[]}: the storeId of all created KVStore databases.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified.
* <br>2.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.Core
* @since 9
*/
getAllKVStoreId(appId: string): Promise<string[]>;
/**
* Register a death callback to get notification when the data manager service is terminated.
* <p>If the data manager service is terminated,you need to re-subscribe to data change notifications and synchronization
* completion notifications, and calling the sync method will return a failure.
*
* @param { 'distributedDataServiceDie' } event - Subscribed event name, fixed as 'distributedDataServiceDie', as a service status change events.
* @param { Callback<void> } deathCallback - callback to be invoked when the data manager service is terminated.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): void;
/**
* Unregister the death callback. Not notification will be received when the data manager service is terminated.
* <p>The unregistered death callback must be a registered death callback of the database. If no death callback parameter
* is passed, all database death callbacks will be unregistered.
*
* @param { 'distributedDataServiceDie' } event - Unsubscribe event name, fixed as 'distributedDataServiceDie', as a service status change events.
* @param { Callback<void> } deathCallback - the data manager service is terminated callback which has been registered.
* @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;
* <br>2.Incorrect parameters types;
* <br>3.Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
* @since 9
*/
off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): void;
}
}
export default distributedKVStore;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助