From 87b6c96241580a41939260c8eaf87d64e02ec49d Mon Sep 17 00:00:00 2001 From: asfasdff Date: Wed, 5 Jan 2022 17:19:27 +0800 Subject: [PATCH 1/6] api fix up Signed-off-by: asfasdff --- .../apis/js-apis-distributed-data.md | 292 +++++++++--------- 1 file changed, 147 insertions(+), 145 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index 58cf342b9ae..a0244de60dd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -62,7 +62,7 @@ createKVManager\(config: KVManagerConfig, callback: AsyncCallback\): bundleName : 'com.example.datamanagertest', userInfo : { userId : '0', - userType : SAME_USER_ID + userType : 0 } } distributedData.createKVManager(kvManagerConfig, function (err, manager) { @@ -136,7 +136,7 @@ createKVManager\(config: KVManagerConfig\): Promise bundleName : 'com.example.datamanagertest', userInfo : { userId : '0', - userType : SAME_USER_ID + userType : 0 } } distributedData.createKVManager(kvManagerConfig).then((manager) => { @@ -310,8 +310,8 @@ getKVStore\(storeId: string, options: Options, callback: Asy encrypt : false, backup : false, autoSync : true, - kvStoreType : SINGLE_VERSION, - securityLevel : S2, + kvStoreType : 1, + securityLevel : 3, }; kvManager.getKVStore('storeId', options, function (err, store) { if (err) { @@ -395,8 +395,8 @@ getKVStore\(storeId: string, options: Options\): Promise encrypt : false, backup : false, autoSync : true, - kvStoreType : SINGLE_VERSION, - securityLevel : S2, + kvStoreType : 1, + securityLevel : 3, }; kvManager.getKVStore('storeId', options).then((store) => { console.log("getKVStore success"); @@ -409,7 +409,7 @@ getKVStore\(storeId: string, options: Options\): Promise } ``` -### closeKVStore ### +### closeKVStore8+ ### closeKVStore\(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback\): void; @@ -483,7 +483,7 @@ closeKVStore\(appId: string, storeId: string, kvStore: KVStore, callback: AsyncC } ``` -### closeKVStore ### +### closeKVStore8+ ### closeKVStore\(appId: string, storeId: string, kvStore: KVStore\): Promise; @@ -554,7 +554,7 @@ closeKVStore\(appId: string, storeId: string, kvStore: KVStore\): Promise ``` let KvStore; try { - kvManager.closeKVStore('appId', 'storId', KvStore).then(() => { + kvManager.closeKVStore('appId', 'storId', kvStore).then(() => { console.log('CloseKVStore success'); }).catch((err) => { console.log('CloseKVStore err ' + JSON.stringify(err)); @@ -565,7 +565,7 @@ closeKVStore\(appId: string, storeId: string, kvStore: KVStore\): Promise ``` -### deleteKVStore ### +### deleteKVStore8+ ### deleteKVStore(appId: string, storeId: string, callback: AsyncCallback): void; @@ -631,7 +631,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback): vo } ``` -### deleteKVStore ### +### deleteKVStore8+ ### deleteKVStore\(appId: string, storeId: string\): Promise; @@ -693,7 +693,7 @@ deleteKVStore\(appId: string, storeId: string\): Promise; ``` let KvStore; try { - kvManager.deleteKVStore('appId', 'storId', KvStore).then(() => { + kvManager.deleteKVStore('appId', 'storId', kvStore).then(() => { console.log('deleteKVStore success'); }).catch((err) => { console.log('deleteKVStore err ' + JSON.stringify(err)); @@ -704,7 +704,7 @@ deleteKVStore\(appId: string, storeId: string\): Promise; ``` -### getAllKVStoreId ### +### getAllKVStoreId8+ ### getAllKVStoreId(appId: string, callback: AsyncCallback): void; @@ -758,7 +758,7 @@ getAllKVStoreId(appId: string, callback: AsyncCallback): void; ``` -### getAllKVStoreId ### +### getAllKVStoreId8+ ### getAllKVStoreId\(appId: string\): Promise; @@ -828,7 +828,7 @@ getAllKVStoreId\(appId: string\): Promise; ``` -### on ### +### on8+ ### on\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; @@ -884,7 +884,7 @@ on\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; ``` -### off ### +### off8+ ### off\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; @@ -1163,11 +1163,11 @@ KVStore常量。 -## Schema ## +## Schema8+ ## 表示数据库架构，可以创建 Schema 对象，并在创建或打开数据库时将其放置在 Option 中。 -### constructor ### +### constructor ###8+ constructor(); @@ -1179,11 +1179,12 @@ constructor(); try { let schema = new ddm.Schema(); schema.root = new ddm.FieldNode(); + const str = schema.constructor(); console.log("constructor: " + str); } catch (e) {} ``` -### toJsonString ### +### toJsonString8+ ### toJsonString():string; @@ -1219,11 +1220,11 @@ toJsonString():string; ``` -## FieldNode ## +## FieldNode8+ ## 表示 Schema 实例的节点，提供定义存储在数据库中的值的方法。 -### constructor ### +### constructor8+ ### constructor\(name: string\); @@ -1257,12 +1258,13 @@ constructor\(name: string\); ``` try { let node = new ddm.FieldNode("name"); + const str = node.constructor(); console.log("constructor: " + str); } catch (e) {} ``` -### appendChild ### +### appendChild8+ ### appendChild\(child: FieldNode\): boolean; @@ -1330,7 +1332,7 @@ appendChild\(child: FieldNode\): boolean; ``` -### toJson ### +### toJson8+ ### toJson(\): string; @@ -1366,11 +1368,11 @@ toJson(\): string; ``` -## KvStoreResultSet ## +## KvStoreResultSet8+ ## 提供获取KvStore数据库结果集的方法，提供查询和移动数据读取位置的方法，在调用KvStoreResultSet的方法前，需要先通过DeviceKvStore 构建一个DeviceKvStore 实例。 -### getCount ### +### getCount8+ ### getCount(\): number; @@ -1398,15 +1400,15 @@ getCount(\): number; ``` let KvStoreResultSet; try { - count = resultSet.getCount(); - console.log("getCount " + count); + const count = resultSet.getCount(); + console.log("GetCount " + count); } catch (e) { - console.log("GetCount001 fail " + e); + console.log("GetCount fail " + e); } ``` -### getPosition ### +### getPosition8+ ### getPosition(\): number; @@ -1442,7 +1444,7 @@ getPosition(\): number; ``` -### moveToFirst ### +### moveToFirst8+ ### moveToFirst(\): boolean; @@ -1478,7 +1480,7 @@ moveToFirst(\): boolean; ``` -### moveToLast ### +### moveToLast8+ ### moveToLast(\): boolean; @@ -1514,7 +1516,7 @@ moveToLast(\): boolean; ``` -### moveToNext ### +### moveToNext8+ ### moveToNext(\): boolean; @@ -1550,7 +1552,7 @@ moveToNext(\): boolean; ``` -### moveToPrevious ### +### moveToPrevious8+ ### moveToPrevious(\): boolean; @@ -1586,7 +1588,7 @@ moveToPrevious(\): boolean; ``` -### move ### +### move8+ ### move\(offset: number\): boolean; @@ -1644,7 +1646,7 @@ move\(offset: number\): boolean; ``` -### moveToPosition ### +### moveToPosition8+ ### moveToPosition\(position: number\): boolean; @@ -1702,7 +1704,7 @@ moveToPosition\(position: number\): boolean; ``` -### isFirst ### +### isFirst8+ ### isFirst(\): boolean; @@ -1738,7 +1740,7 @@ isFirst(\): boolean; ``` -### isLast ### +### isLast8+ ### isLast(\): boolean; @@ -1774,7 +1776,7 @@ isLast(\): boolean; ``` -### isBeforeFirst ### +### isBeforeFirst8+ ### isBeforeFirst(\): boolean; @@ -1810,7 +1812,7 @@ isBeforeFirst(\): boolean; ``` -### isAfterLast ### +### isAfterLast8+ ### isAfterLast(\): boolean; @@ -1846,7 +1848,7 @@ isAfterLast(\): boolean; ``` -### getEntry ### +### getEntry8+ ### getEntry(\): Entry; @@ -1883,11 +1885,11 @@ getEntry(\): Entry; ``` -## Query ## +## Query 8+## 使用谓词表示数据库查询，提供创建Query实例、查询数据库中的数据和添加谓词的方法。 -### constructor ### +### constructor8+ ### constructor(); @@ -1898,11 +1900,12 @@ constructor(); ``` try { let query= new ddm.Query() + const str = query.constructor(); console.log("constructor: " + str); } catch (e) {} ``` -### reset ### +### reset8+ ### reset(\): Query; @@ -1942,7 +1945,7 @@ reset(\): Query; ``` -### equalTo ### +### equalTo8+ ### equalTo\(field: string, value: number|string|boolean\): Query; @@ -2011,7 +2014,7 @@ equalTo\(field: string, value: number|string|boolean\): Query; ``` -### notEqualTo ### +### notEqualTo8+ ### notEqualTo\(field: string, value: number|string|boolean\): Query; @@ -2080,7 +2083,7 @@ notEqualTo\(field: string, value: number|string|boolean\): Query; ``` -### greaterThan ### +### greaterThan8+ ### greaterThan\(field: string, value: number|string|boolean\): Query; @@ -2149,7 +2152,7 @@ greaterThan\(field: string, value: number|string|boolean\): Query; ``` -### lessThan ### +### lessThan8+ ### lessThan\(field: string, value: number|string\): Query; @@ -2218,7 +2221,7 @@ lessThan\(field: string, value: number|string\): Query; ``` -### greaterThanOrEqualTo ### +### greaterThanOrEqualTo8+ ### greaterThanOrEqualTo\(field: string, value: number|string\): Query; @@ -2287,7 +2290,7 @@ greaterThanOrEqualTo\(field: string, value: number|string\): Query; ``` -### lessThanOrEqualTo ### +### lessThanOrEqualTo8+ ### lessThanOrEqualTo\(field: string, value: number|string\): Query; @@ -2356,7 +2359,7 @@ lessThanOrEqualTo\(field: string, value: number|string\): Query; ``` -### isNull ### +### isNull8+ ### isNull\(field: string\): Query; @@ -2417,7 +2420,7 @@ isNull\(field: string\): Query; ``` -### inNumber ### +### inNumber8+ ### inNumber\(field: string, valueList: number[\]\): Query; @@ -2486,7 +2489,7 @@ inNumber\(field: string, valueList: number[\]\): Query; ``` -### inString ### +### inString8+ ### inString\(field: string, valueList: string[\]\): Query; @@ -2555,7 +2558,7 @@ inString\(field: string, valueList: string[\]\): Query; ``` -### notInNumber ### +### notInNumber8+ ### notInNumber\(field: string, valueList: number[\]\): Query; @@ -2624,7 +2627,7 @@ notInNumber\(field: string, valueList: number[\]\): Query; ``` -### notInString ### +### notInString8+ ### notInString\(field: string, valueList: string[\]\): Query; @@ -2693,7 +2696,7 @@ notInString\(field: string, valueList: string[\]\): Query; ``` -### like ### +### like8+ ### like\(field: string, value: string\): Query; @@ -2762,7 +2765,7 @@ like\(field: string, value: string\): Query; ``` -### unlike ### +### unlike8+ ### unlike\(field: string, value: string\): Query; @@ -2831,7 +2834,7 @@ unlike\(field: string, value: string\): Query; ``` -### and ### +### and8+ ### and(\): Query; @@ -2871,7 +2874,7 @@ and(\): Query; ``` -### or ### +### or8+ ### or(\): Query; @@ -2911,7 +2914,7 @@ or(\): Query; ``` -### orderByAsc ### +### orderByAsc8+ ### orderByAsc\(field: string\): Query; @@ -2974,7 +2977,7 @@ orderByAsc\(field: string\): Query; ``` -### orderByDesc ### +### orderByDesc8+ ### orderByDesc\(field: string\): Query; @@ -3036,7 +3039,7 @@ orderByDesc\(field: string\): Query; ``` -### limit ### +### limit8+ ### limit\(total: number, offset: number\): Query; @@ -3106,7 +3109,7 @@ limit\(total: number, offset: number\): Query; ``` -### isNotNull ### +### isNotNull8+ ### isNotNull\(field: string\): Query; @@ -3167,7 +3170,7 @@ isNotNull\(field: string\): Query; ``` -### beginGroup ### +### beginGroup8+ ### beginGroup\(\): Query; @@ -3207,7 +3210,7 @@ beginGroup\(\): Query; ``` -### endGroup ### +### endGroup8+ ### endGroup\(\): Query; @@ -3247,7 +3250,7 @@ endGroup\(\): Query; ``` -### prefixKey ### +### prefixKey8+ ### prefixKey\(prefix: string\): Query; @@ -3308,7 +3311,7 @@ prefixKey\(prefix: string\): Query; ``` -### setSuggestIndex ### +### setSuggestIndex8+ ### setSuggestIndex\(index: string\): Query; @@ -3746,7 +3749,7 @@ on\(event: 'syncComplete', syncCallback: Callback\>\) }); ``` -### off ### +### off8+ ### off\(event:'dataChange', observer: Callback\): void; @@ -3780,7 +3783,7 @@ off\(event:'dataChange', observer: Callback\): void; -### putBatch ### +### putBatch8+ ### putBatch\(entries: Entry[], callback: AsyncCallback\): void; @@ -3817,7 +3820,7 @@ putBatch\(entries: Entry[], callback: AsyncCallback\): void; -### putBatch ### +### putBatch8+ ### putBatch\(entries: Entry[\]\): Promise; @@ -3863,7 +3866,7 @@ putBatch\(entries: Entry[\]\): Promise; -### deleteBatch ### +### deleteBatch8+ ### deleteBatch(keys: string[], callback: AsyncCallback): void; @@ -3900,7 +3903,7 @@ deleteBatch(keys: string[], callback: AsyncCallback): void; -### deleteBatch ### +### deleteBatch8+ ### deleteBatch\(keys: string[\]\): Promise; @@ -3946,7 +3949,7 @@ deleteBatch\(keys: string[\]\): Promise; -### startTransaction ### +### startTransaction8+ ### startTransaction\(callback: AsyncCallback\): void; @@ -3975,7 +3978,7 @@ startTransaction\(callback: AsyncCallback\): void; -### startTransaction ### +### startTransaction8+ ### startTransaction\(\): Promise; @@ -3998,7 +4001,7 @@ startTransaction\(\): Promise; -### commit ### +### commit8+ ### commit\(callback: AsyncCallback\): void; @@ -4027,7 +4030,7 @@ commit\(callback: AsyncCallback\): void; -### commit ### +### commit8+ ### commit(\): Promise; @@ -4050,7 +4053,7 @@ commit(\): Promise; -### rollback ### +### rollback8+ ### rollback\(callback: AsyncCallback\): void; @@ -4079,7 +4082,7 @@ rollback\(callback: AsyncCallback\): void; -### rollback ### +### rollback8+ ### rollback(\): Promise; @@ -4102,7 +4105,7 @@ rollback(\): Promise; -### enableSync ### +### enableSync8+ ### enableSync\(enabled: boolean, callback: AsyncCallback\): void; @@ -4142,7 +4145,7 @@ enableSync\(enabled: boolean, callback: AsyncCallback\): void; -### enableSync ### +### enableSync8+ ### enableSync\(enabled: boolean\): Promise; @@ -4190,7 +4193,7 @@ enableSync\(enabled: boolean\): Promise; -### setSyncRange ### +### setSyncRange8+ ### setSyncRange\(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback\): void; @@ -4239,7 +4242,7 @@ setSyncRange\(localLabels: string[], remoteSupportLabels: string[], callback: As -### setSyncRange ### +### setSyncRange8+ ### setSyncRange\(localLabels: string[], remoteSupportLabels: string[\]\): Promise; @@ -4677,7 +4680,7 @@ get\(key: string\): Promise } ``` -### getEntries ### +### getEntries8+ ### getEntries\(keyPrefix: string, callback: AsyncCallback\): void; @@ -4747,7 +4750,7 @@ getEntries\(keyPrefix: string, callback: AsyncCallback\): void; ``` -### getEntries ### +### getEntries8+ ### getEntries\(keyPrefix: string\): Promise; @@ -4832,7 +4835,7 @@ getEntries\(keyPrefix: string\): Promise; ``` -### getEntries ### +### getEntries8+ ### getEntries\(query: Query, callback: AsyncCallback\): void; @@ -4903,7 +4906,7 @@ getEntries\(query: Query, callback: AsyncCallback\): void; ``` -### getEntries ### +### getEntries8+ ### getEntries\(query: Query\): Promise; @@ -4988,7 +4991,7 @@ getEntries\(query: Query\): Promise; ``` -### getResultSet ### +### getResultSet8+ ### getResultSet\(keyPrefix: string, callback: AsyncCallback\): void; @@ -5061,7 +5064,7 @@ getResultSet\(keyPrefix: string, callback: AsyncCallback\): v ``` -### getResultSet ### +### getResultSet8+ ### getResultSet\(keyPrefix: string\): Promise; @@ -5149,7 +5152,7 @@ getResultSet\(keyPrefix: string\): Promise; ``` -### getResultSet ### +### getResultSet8+ ### getResultSet\(query: Query, callback: AsyncCallback\): void; @@ -5221,7 +5224,7 @@ getResultSet\(query: Query, callback: AsyncCallback\): void; ``` -### getResultSet ### +### getResultSet8+ ### getResultSet\(query: Query\): Promise; @@ -5307,7 +5310,7 @@ getResultSet\(query: Query\): Promise; } ``` -### closeResultSet ### +### closeResultSet8+ ### closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): void; @@ -5366,7 +5369,7 @@ closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): v ``` -### closeResultSet ### +### closeResultSet8+ ### closeResultSet\(resultSet: KvStoreResultSet\): Promise; @@ -5431,7 +5434,7 @@ closeResultSet\(resultSet: KvStoreResultSet\): Promise; ``` -### getResultSize ### +### getResultSize8+ ### getResultSize\(query: Query, callback: AsyncCallback\): void; @@ -5483,7 +5486,7 @@ getResultSize\(query: Query, callback: AsyncCallback\): void; ``` -### getResultSize ### +### getResultSize8+ ### getResultSize\(query: Query\): Promise; @@ -5543,7 +5546,7 @@ getResultSize\(query: Query\): Promise; ``` -### removeDeviceData ### +### removeDeviceData8+ ### removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; @@ -5595,7 +5598,6 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; kvStore.removeDeviceData(deviceid, async function (err,data) { if (err == undefined) { console.log('removeDeviceData success'); - done(); } else { console.log('removeDeviceData fail'); kvStore.get(KEY_TEST_STRING_ELEMENT, async function (err,data) { @@ -5610,7 +5612,7 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; ``` -### removeDeviceData ### +### removeDeviceData8+ ### removeDeviceData\(deviceId: string\): Promise; @@ -5686,7 +5688,7 @@ removeDeviceData\(deviceId: string\): Promise; ``` -### on ### +### on8+ ### on\(event: 'syncComplete', syncCallback: Callback>\): void; @@ -5746,7 +5748,7 @@ on\(event: 'syncComplete', syncCallback: Callback>\): vo ``` -### off ### +### off8+ ### off\(event: 'syncComplete', syncCallback: Callback>\): void; @@ -5853,10 +5855,10 @@ sync\(deviceIdList: string\[\], mode: SyncMode, allowedDelayMs?: number\): void - 示例： ``` - kvStore.sync(deviceIds, 1, 1000); + kvStore.sync('deviceIds', 1, 1000); ``` -### setSyncParam ### +### setSyncParam8+ ### setSyncParam\(defaultAllowedDelayMs: number, callback: AsyncCallback\): void; @@ -5910,7 +5912,7 @@ setSyncParam\(defaultAllowedDelayMs: number, callback: AsyncCallback\): v ``` -### setSyncParam ### +### setSyncParam8+ ### setSyncParam\(defaultAllowedDelayMs: number\): Promise; @@ -5974,7 +5976,7 @@ setSyncParam\(defaultAllowedDelayMs: number\): Promise; ``` -### getSecurityLevel ### +### getSecurityLevel8+ ### getSecurityLevel\(callback: AsyncCallback\): void; @@ -6018,7 +6020,7 @@ getSecurityLevel\(callback: AsyncCallback\): void; ``` -### getSecurityLevel ### +### getSecurityLevel8+ ### getSecurityLevel(\): Promise; @@ -6056,11 +6058,11 @@ getSecurityLevel(\): Promise; ``` -## DeviceKVStore ## +## DeviceKVStore8+ ## 在分布式系统中通过设备管理分布式数据，继承自KvStore，提供查询数据和同步数据的方法。在调用DeviceKVStore的方法前，需要先通过getKVStore构建一个KVStore实例。 -### get ### +### get8+ ### get\(deviceId: string, key: string, callback: AsyncCallback\): void; @@ -6117,7 +6119,7 @@ get\(deviceId: string, key: string, callback: AsyncCallback8+ ### get\(deviceId: string, key: string\): Promise; @@ -6192,7 +6194,7 @@ get\(deviceId: string, key: string\): Promise try { kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then(async (data) => { console.log(' put success'); - kvStore.get(localDeviceId, KEY_TEST_STRING_ELEMENT).then((data) => { + kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT).then((data) => { console.log('get success'); }).catch((err) => { console.log('get fail ' + JSON.stringify(err)); @@ -6206,7 +6208,7 @@ get\(deviceId: string, key: string\): Promise ``` -### getEntries ### +### getEntries8+ ### getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback\): void; @@ -6274,7 +6276,7 @@ getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback8+ ### getEntries\(deviceId: string, keyPrefix: string\): Promise; @@ -6362,7 +6364,7 @@ getEntries\(deviceId: string, keyPrefix: string\): Promise; console.log('entries: ' + entries); kvStore.putBatch(entries).then(async (err) => { console.log('putBatch success'); - kvStore.getEntries(localDeviceId, 'batch_test_string_key').then((entrys) => { + kvStore.getEntries('localDeviceId', 'batch_test_string_key').then((entrys) => { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); console.log('entrys[0]: ' + JSON.stringify(entrys[0])); @@ -6380,7 +6382,7 @@ getEntries\(deviceId: string, keyPrefix: string\): Promise; ``` -### getEntries ### +### getEntries8+ ### getEntries\(query: Query, callback: AsyncCallback\): void; @@ -6440,7 +6442,7 @@ getEntries\(query: Query, callback: AsyncCallback\): void; console.log('entries: ' + entries); kvStore.putBatch(entries, async function (err,data) { console.log('putBatch success'); - kvStore.getEntries(localDeviceId, 'batch_test_bool_key', function (err,entrys) { + kvStore.getEntries('localDeviceId', 'batch_test_bool_key', function (err,entrys) { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); }); @@ -6451,7 +6453,7 @@ getEntries\(query: Query, callback: AsyncCallback\): void; ``` -### getEntries ### +### getEntries8+ ### getEntries\(query: Query\): Promise; @@ -6519,7 +6521,7 @@ getEntries\(query: Query\): Promise; console.log('entries: ' + entries); kvStore.putBatch(entries).then(async (err) => { console.log('putBatch success'); - kvStore.getEntries(localDeviceId, 'batch_test_bool_key').then((entrys) => { + kvStore.getEntries('localDeviceId', 'batch_test_bool_key').then((entrys) => { console.log('getEntries success'); }).catch((err) => { console.log('getEntries fail ' + JSON.stringify(err)); @@ -6533,7 +6535,7 @@ getEntries\(query: Query\): Promise; ``` -### getEntries ### +### getEntries8+ ### getEntries\(deviceId: string, query: Query, callback: AsyncCallback\): void; @@ -6602,7 +6604,7 @@ getEntries\(deviceId: string, query: Query, callback: AsyncCallback\) console.log('entries: ' + entries); kvStore.putBatch(entries, async function (err,data) { console.log('putBatch success'); - kvStore.getEntries(localDeviceId, 'batch_test_bool_key', function (err,entrys) { + kvStore.getEntries('localDeviceId', 'batch_test_bool_key', function (err,entrys) { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); }); @@ -6613,7 +6615,7 @@ getEntries\(deviceId: string, query: Query, callback: AsyncCallback\) ``` -### getEntries ### +### getEntries8+ ### getEntries\(deviceId: string, query: Query\): Promise; @@ -6690,7 +6692,7 @@ getEntries\(deviceId: string, query: Query\): Promise; console.log('entries: ' + entries); kvStore.putBatch(entries).then(async (err) => { console.log('putBatch success'); - kvStore.getEntries(localDeviceId, 'batch_test_bool_key').then((entrys) => { + kvStore.getEntries('localDeviceId', 'batch_test_bool_key').then((entrys) => { console.log('getEntries success'); }).catch((err) => { console.log('getEntries fail ' + JSON.stringify(err)); @@ -6704,7 +6706,7 @@ getEntries\(deviceId: string, query: Query\): Promise; ``` -### getResultSet ### +### getResultSet8+ ### getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback\): void; @@ -6758,7 +6760,7 @@ getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback8+ ### getResultSet\(deviceId: string, keyPrefix: string\): Promise; @@ -6833,7 +6835,7 @@ getResultSet\(deviceId: string, keyPrefix: string\): Promise; ``` try { let resultSet; - kvStore.getResultSet(localDeviceId, 'batch_test_string_key').then((result) => { + kvStore.getResultSet('localDeviceId', 'batch_test_string_key').then((result) => { console.log('getResultSet success'); resultSet = result; }).catch((err) => { @@ -6850,7 +6852,7 @@ getResultSet\(deviceId: string, keyPrefix: string\): Promise; ``` -### getResultSet ### +### getResultSet8+ ### getResultSet\(query: Query, callback: AsyncCallback\): void; @@ -6904,7 +6906,7 @@ getResultSet\(query: Query, callback: AsyncCallback\): void; ``` -### getResultSet ### +### getResultSet8+ ### getResultSet\(query: Query\): Promise; @@ -6975,7 +6977,7 @@ getResultSet\(query: Query\): Promise; console.log('PutBatch putBatch fail ' + JSON.stringify(err)); }); const query = new factory.Query(); - query.deviceId(localDeviceId); + query.deviceId('localDeviceId'); query.prefixKey("batch_test"); console.log("GetResultSet " + query.getSqlLike()); kvStore.getResultSet(query).then((result) => { @@ -6995,7 +6997,7 @@ getResultSet\(query: Query\): Promise; ``` -### getResultSet ### +### getResultSet8+ ### getResultSet\(deviceId: string, query: Query, callback: AsyncCallback\): void; @@ -7058,7 +7060,7 @@ getResultSet\(deviceId: string, query: Query, callback: AsyncCallback8+ ### getResultSet\(deviceId: string, query: Query\): Promise; @@ -7138,14 +7140,14 @@ getResultSet\(deviceId: string, query: Query\): Promise; console.log('PutBatch putBatch fail ' + JSON.stringify(err)); }); const query = new factory.Query(); - prefixKey("batch_test"); - kvStore.getResultSet(localDeviceId, query).then((result) => { + query.prefixKey("batch_test"); + kvStore.getResultSet('localDeviceId', query).then((result) => { console.log('GetResultSet getResultSet success'); resultSet = result; }).catch((err) => { console.log('GetResultSet getResultSet fail ' + JSON.stringify(err)); }); - query.deviceId(localDeviceId); + query.deviceId('localDeviceId'); console.log("GetResultSet " + query.getSqlLike()); kvStore.closeResultSet(resultSet).then((err) => { console.log('GetResultSet closeResultSet success'); @@ -7159,7 +7161,7 @@ getResultSet\(deviceId: string, query: Query\): Promise; ``` -### closeResultSet ### +### closeResultSet8+ ### closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): void; @@ -7218,7 +7220,7 @@ closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): v ``` -### closeResultSet ### +### closeResultSet8+ ### closeResultSet\(resultSet: KvStoreResultSet\): Promise; @@ -7283,7 +7285,7 @@ closeResultSet\(resultSet: KvStoreResultSet\): Promise; ``` -### getResultSize ### +### getResultSize8+ ### getResultSize\(query: Query, callback: AsyncCallback\): void; @@ -7335,7 +7337,7 @@ getResultSize\(query: Query, callback: AsyncCallback\): void; ``` -### getResultSize ### +### getResultSize8+ ### getResultSize\(query: Query\): Promise; @@ -7395,7 +7397,7 @@ getResultSize\(query: Query\): Promise; ``` -### getResultSize ### +### getResultSize8+ ### getResultSize\(deviceId: string, query: Query, callback: AsyncCallback\): void; @@ -7456,7 +7458,7 @@ getResultSize\(deviceId: string, query: Query, callback: AsyncCallback\ ``` -### getResultSize ### +### getResultSize8+ ### getResultSize\(deviceId: string, query: Query\): Promise; @@ -7525,7 +7527,7 @@ getResultSize\(deviceId: string, query: Query\): Promise; ``` -### removeDeviceData ### +### removeDeviceData8+ ### removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; @@ -7579,7 +7581,7 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; console.log('removeDeviceData success'); } else { console.log('testDeviceKvStoreRemoveDeviceData101 removeDeviceData fail'); - kvStore.get(localDeviceId, KEY_TEST_STRING_ELEMENT, async function (err,data) { + kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT, async function (err,data) { console.log('RemoveDeviceData get success'); }); } @@ -7591,7 +7593,7 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; ``` -### removeDeviceData ### +### removeDeviceData8+ ### removeDeviceData\(deviceId: string\): Promise; @@ -7658,7 +7660,7 @@ removeDeviceData\(deviceId: string\): Promise; console.log('RemoveDeviceData removeDeviceData fail ' + JSON.stringify(err)); }); - kvStore.get(localDeviceId, KEY_TEST_STRING_ELEMENT).then((data) => { + kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT).then((data) => { console.log('RemoveDeviceData get success data:' + data); }).catch((err) => { console.log('RemoveDeviceData get fail ' + JSON.stringify(err)); @@ -7670,7 +7672,7 @@ removeDeviceData\(deviceId: string\): Promise; ``` -### sync ### +### sync8+ ### sync\(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number\): void; @@ -7739,7 +7741,7 @@ sync\(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number\): void; } ``` -### on ### +### on8+ ### on\(event: 'syncComplete', syncCallback: Callback\>): void; @@ -7799,7 +7801,7 @@ on\(event: 'syncComplete', syncCallback: Callback\>): vo ``` -### off ### +### off8+ ### off\(event: 'syncComplete', syncCallback: Callback>\): void; -- Gitee From cb7b1a182a2f8a59fc2009839a00ff6c08254eab Mon Sep 17 00:00:00 2001 From: asfasdff Date: Thu, 6 Jan 2022 10:55:17 +0800 Subject: [PATCH 2/6] apis fix up Signed-off-by: asfasdff --- .../apis/js-apis-distributed-data.md | 146 +++++++++--------- 1 file changed, 73 insertions(+), 73 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index a0244de60dd..ab87c422d9f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -15,7 +15,7 @@ import distributedData from '@ohos.data.distributedData'; ## distributedData.createKVManager -createKVManager\(config: KVManagerConfig, callback: AsyncCallback\): void +createKVManager\(config: KVManagerConfig, callback: AsyncCallback\): void 创建一个KVManager对象实例，用于管理数据库对象，并通过callback方式返回，此方法为异步方法。 @@ -81,7 +81,7 @@ createKVManager\(config: KVManagerConfig, callback: AsyncCallback\): ## distributedData.createKVManager -createKVManager\(config: KVManagerConfig\): Promise +createKVManager\(config: KVManagerConfig\): Promise 创建一个KVManager对象实例，用于管理数据库对象，并通过Promise方式返回，此方法为异步方法。 @@ -252,7 +252,7 @@ createKVManager\(config: KVManagerConfig\): Promise ### getKVStore -getKVStore\(storeId: string, options: Options, callback: AsyncCallback\): void +getKVStore\(storeId: string, options: Options, callback: AsyncCallback\): void 通过指定Options和storeId，创建并获取KVStore数据库，并通过callback方式返回，此方法为异步方法。 @@ -329,7 +329,7 @@ getKVStore\(storeId: string, options: Options, callback: Asy ### getKVStore -getKVStore\(storeId: string, options: Options\): Promise +getKVStore\(storeId: string, options: Options\): Promise 通过指定Options和storeId，创建并获取KVStore数据库，并通过Promise方式返回，此方法为异步方法。 @@ -411,7 +411,7 @@ getKVStore\(storeId: string, options: Options\): Promise ### closeKVStore8+ ### -closeKVStore\(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback\): void; +closeKVStore\(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback\): void; 通过storId的值关闭指定的kvStore数据库，并通过callback方式返回，此方法为异步方法。 @@ -485,7 +485,7 @@ closeKVStore\(appId: string, storeId: string, kvStore: KVStore, callback: AsyncC ### closeKVStore8+ ### -closeKVStore\(appId: string, storeId: string, kvStore: KVStore\): Promise; +closeKVStore\(appId: string, storeId: string, kvStore: KVStore\): Promise; 通过kvStore的值关闭指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 @@ -633,7 +633,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback): vo ### deleteKVStore8+ ### -deleteKVStore\(appId: string, storeId: string\): Promise; +deleteKVStore\(appId: string, storeId: string\): Promise; 通过storeId的值删除指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 @@ -760,7 +760,7 @@ getAllKVStoreId(appId: string, callback: AsyncCallback): void; ### getAllKVStoreId8+ ### -getAllKVStoreId\(appId: string\): Promise; +getAllKVStoreId\(appId: string\): Promise; 获取所有通过getKvStore方法创建的且没有调用deleteKvStore方法删除的KvStore数据库的storeId，并通过Promise方式返回，此方法为异步方法。 @@ -830,7 +830,7 @@ getAllKVStoreId\(appId: string\): Promise; ### on8+ ### -on\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; +on\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; 订阅设备状态变更通知，并通过callback方式返回，此方法为异步方法。 @@ -886,7 +886,7 @@ on\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; ### off8+ ### -off\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; +off\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; 取消订阅设备状态变更通知，并通过callback方式返回，此方法为异步方法。 @@ -3378,7 +3378,7 @@ KVStore数据库实例，提供增加数据、删除数据和订阅数据变更 ### put -put\(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback\): void +put\(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback\): void 添加指定类型键值对到数据库，并通过callback方式返回，此方法为异步方法。 @@ -3447,7 +3447,7 @@ put\(key: string, value: Uint8Array | string | number | boolean, callback: Async ### put -put\(key: string, value: Uint8Array | string | number | boolean\): Promise +put\(key: string, value: Uint8Array | string | number | boolean\): Promise 添加指定类型键值对到数据库，并通过Promise方式返回，此方法为异步方法。 @@ -3523,7 +3523,7 @@ put\(key: string, value: Uint8Array | string | number | boolean\): Promise -delete\(key: string, callback: AsyncCallback\): void +delete\(key: string, callback: AsyncCallback\): void 从数据库中删除指定键值的数据，并通过callback方式返回，此方法为异步方法。 @@ -3589,7 +3589,7 @@ delete\(key: string, callback: AsyncCallback\): void ### delete -delete\(key: string\): Promise +delete\(key: string\): Promise 从数据库中删除指定键值的数据，并通过Promise方式返回，此方法为异步方法。 @@ -3659,7 +3659,7 @@ delete\(key: string\): Promise ### on -on\(event: 'dataChange', type: SubscribeType, observer: Callback\): void +on\(event: 'dataChange', type: SubscribeType, observer: Callback\): void 订阅指定类型的数据变更通知，此方法为同步方法。 @@ -3709,7 +3709,7 @@ on\(event: 'dataChange', type: SubscribeType, observer: Callback -on\(event: 'syncComplete', syncCallback: Callback\>\): void +on\(event: 'syncComplete', syncCallback: Callback>\): void 订阅数据同步完成通知，此方法为同步方法。 @@ -3751,7 +3751,7 @@ on\(event: 'syncComplete', syncCallback: Callback\>\) ### off8+ ### -off\(event:'dataChange', observer: Callback\): void; +off\(event:'dataChange', observer: Callback\): void; 取消订阅数据同步完成通知，此方法为同步方法。 @@ -3785,7 +3785,7 @@ off\(event:'dataChange', observer: Callback\): void; ### putBatch8+ ### -putBatch\(entries: Entry[], callback: AsyncCallback\): void; +putBatch\(entries: Entry[], callback: AsyncCallback\): void; 批量插入键值对到KvStore数据库中，并通过callback方式返回，此方法为异步方法。 @@ -3822,7 +3822,7 @@ putBatch\(entries: Entry[], callback: AsyncCallback\): void; ### putBatch8+ ### -putBatch\(entries: Entry[\]\): Promise; +putBatch\(entries: Entry[\]\): Promise; 批量插入键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。 @@ -3905,7 +3905,7 @@ deleteBatch(keys: string[], callback: AsyncCallback): void; ### deleteBatch8+ ### -deleteBatch\(keys: string[\]\): Promise; +deleteBatch\(keys: string[\]\): Promise; 批量删除键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。 @@ -3951,7 +3951,7 @@ deleteBatch\(keys: string[\]\): Promise; ### startTransaction8+ ### -startTransaction\(callback: AsyncCallback\): void; +startTransaction\(callback: AsyncCallback\): void; 启动KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 @@ -3980,7 +3980,7 @@ startTransaction\(callback: AsyncCallback\): void; ### startTransaction8+ ### -startTransaction\(\): Promise; +startTransaction\(\): Promise; 启动KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 @@ -4003,7 +4003,7 @@ startTransaction\(\): Promise; ### commit8+ ### -commit\(callback: AsyncCallback\): void; +commit\(callback: AsyncCallback\): void; 提交KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 @@ -4032,7 +4032,7 @@ commit\(callback: AsyncCallback\): void; ### commit8+ ### -commit(\): Promise; +commit(\): Promise; 提交KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 @@ -4055,7 +4055,7 @@ commit(\): Promise; ### rollback8+ ### -rollback\(callback: AsyncCallback\): void; +rollback\(callback: AsyncCallback\): void; 在KvStore数据库中回滚事务，并通过callback方式返回，此方法为异步方法。 @@ -4084,7 +4084,7 @@ rollback\(callback: AsyncCallback\): void; ### rollback8+ ### -rollback(\): Promise; +rollback(\): Promise; 在KvStore数据库中回滚事务，并通过Promise方式返回，此方法为异步方法。 @@ -4107,7 +4107,7 @@ rollback(\): Promise; ### enableSync8+ ### -enableSync\(enabled: boolean, callback: AsyncCallback\): void; +enableSync\(enabled: boolean, callback: AsyncCallback\): void; 设定是否开启同步，并通过callback方式返回，此方法为异步方法。 @@ -4147,7 +4147,7 @@ enableSync\(enabled: boolean, callback: AsyncCallback\): void; ### enableSync8+ ### -enableSync\(enabled: boolean\): Promise; +enableSync\(enabled: boolean\): Promise; 设定是否开启同步，并通过Promise方式返回，此方法为异步方法。 @@ -4195,7 +4195,7 @@ enableSync\(enabled: boolean\): Promise; ### setSyncRange8+ ### -setSyncRange\(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback\): void; +setSyncRange\(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback\): void; 设置同步范围标签，并通过callback方式返回，此方法为异步方法。 @@ -4244,7 +4244,7 @@ setSyncRange\(localLabels: string[], remoteSupportLabels: string[], callback: As ### setSyncRange8+ ### -setSyncRange\(localLabels: string[], remoteSupportLabels: string[\]\): Promise; +setSyncRange\(localLabels: string[], remoteSupportLabels: string[\]\): Promise; 设置同步范围标签，并通过Promise方式返回，此方法为异步方法。 @@ -4550,7 +4550,7 @@ setSyncRange\(localLabels: string[], remoteSupportLabels: string[\]\): Promise -get\(key: string, callback: AsyncCallback\): void +get\(key: string, callback: AsyncCallback\): void 获取指定键的值，并通过callback方式返回，此方法为异步方法。 @@ -4612,7 +4612,7 @@ get\(key: string, callback: AsyncCallback -get\(key: string\): Promise +get\(key: string\): Promise 获取指定键的值，并通过Promise方式返回，此方法为异步方法。 @@ -4682,7 +4682,7 @@ get\(key: string\): Promise ### getEntries8+ ### -getEntries\(keyPrefix: string, callback: AsyncCallback\): void; +getEntries\(keyPrefix: string, callback: AsyncCallback\): void; 获取匹配指定键前缀的所有键值对，并通过callback方式返回，此方法为异步方法。 @@ -4752,7 +4752,7 @@ getEntries\(keyPrefix: string, callback: AsyncCallback\): void; ### getEntries8+ ### -getEntries\(keyPrefix: string\): Promise; +getEntries\(keyPrefix: string\): Promise; 获取匹配指定键前缀的所有键值对，并通过Promise方式返回，此方法为异步方法。 @@ -4837,7 +4837,7 @@ getEntries\(keyPrefix: string\): Promise; ### getEntries8+ ### -getEntries\(query: Query, callback: AsyncCallback\): void; +getEntries\(query: Query, callback: AsyncCallback\): void; 获取与指定 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。 @@ -4908,7 +4908,7 @@ getEntries\(query: Query, callback: AsyncCallback\): void; ### getEntries8+ ### -getEntries\(query: Query\): Promise; +getEntries\(query: Query\): Promise; 获取匹配指定键前缀的所有键值对，并通过Promise方式返回，此方法为异步方法。 @@ -4993,7 +4993,7 @@ getEntries\(query: Query\): Promise; ### getResultSet8+ ### -getResultSet\(keyPrefix: string, callback: AsyncCallback\): void; +getResultSet\(keyPrefix: string, callback: AsyncCallback\): void; 从 KvStore 数据库中获取具有指定前缀的结果集，并通过callback方式返回，此方法为异步方法。 @@ -5066,7 +5066,7 @@ getResultSet\(keyPrefix: string, callback: AsyncCallback\): v ### getResultSet8+ ### -getResultSet\(keyPrefix: string\): Promise; +getResultSet\(keyPrefix: string\): Promise; 从 KvStore 数据库中获取具有指定前缀的结果集，并通过Promise方式返回，此方法为异步方法。 @@ -5154,7 +5154,7 @@ getResultSet\(keyPrefix: string\): Promise; ### getResultSet8+ ### -getResultSet\(query: Query, callback: AsyncCallback\): void; +getResultSet\(query: Query, callback: AsyncCallback\): void; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -5226,7 +5226,7 @@ getResultSet\(query: Query, callback: AsyncCallback\): void; ### getResultSet8+ ### -getResultSet\(query: Query\): Promise; +getResultSet\(query: Query\): Promise; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -5312,7 +5312,7 @@ getResultSet\(query: Query\): Promise; ### closeResultSet8+ ### -closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): void; +closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): void; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -5371,7 +5371,7 @@ closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): v ### closeResultSet8+ ### -closeResultSet\(resultSet: KvStoreResultSet\): Promise; +closeResultSet\(resultSet: KvStoreResultSet\): Promise; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -5436,7 +5436,7 @@ closeResultSet\(resultSet: KvStoreResultSet\): Promise; ### getResultSize8+ ### -getResultSize\(query: Query, callback: AsyncCallback\): void; +getResultSize\(query: Query, callback: AsyncCallback\): void; 获取与指定 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。 @@ -5488,7 +5488,7 @@ getResultSize\(query: Query, callback: AsyncCallback\): void; ### getResultSize8+ ### -getResultSize\(query: Query\): Promise; +getResultSize\(query: Query\): Promise; 获取与指定 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。 @@ -5548,7 +5548,7 @@ getResultSize\(query: Query\): Promise; ### removeDeviceData8+ ### -removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; +removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; 删除指定设备的数据，并通过callback方式返回，此方法为异步方法。 @@ -5614,7 +5614,7 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; ### removeDeviceData8+ ### -removeDeviceData\(deviceId: string\): Promise; +removeDeviceData\(deviceId: string\): Promise; 删除指定设备的数据，并通过Promise方式返回，此方法为异步方法。 @@ -5690,7 +5690,7 @@ removeDeviceData\(deviceId: string\): Promise; ### on8+ ### -on\(event: 'syncComplete', syncCallback: Callback>\): void; +on\(event: 'syncComplete', syncCallback: Callback\): void; 注册同步 SingleKvStore 数据库回调，并通过异步方式返回。 @@ -5860,7 +5860,7 @@ sync\(deviceIdList: string\[\], mode: SyncMode, allowedDelayMs?: number\): void ### setSyncParam8+ ### -setSyncParam\(defaultAllowedDelayMs: number, callback: AsyncCallback\): void; +setSyncParam\(defaultAllowedDelayMs: number, callback: AsyncCallback\): void; 设置允许数据库同步的默认延迟,并通过callback方式返回，此方法为异步方法。 @@ -5914,7 +5914,7 @@ setSyncParam\(defaultAllowedDelayMs: number, callback: AsyncCallback\): v ### setSyncParam8+ ### -setSyncParam\(defaultAllowedDelayMs: number\): Promise; +setSyncParam\(defaultAllowedDelayMs: number\): Promise; 设置允许数据库同步的默认延迟,并通过Promise方式返回，此方法为异步方法。 @@ -5978,7 +5978,7 @@ setSyncParam\(defaultAllowedDelayMs: number\): Promise; ### getSecurityLevel8+ ### -getSecurityLevel\(callback: AsyncCallback\): void; +getSecurityLevel\(callback: AsyncCallback\): void; 获取数据库的安全级别，并通过callback方式返回，此方法为异步方法。 @@ -6022,7 +6022,7 @@ getSecurityLevel\(callback: AsyncCallback\): void; ### getSecurityLevel8+ ### -getSecurityLevel(\): Promise; +getSecurityLevel(\): Promise; 获取数据库的安全级别，并通过Promise方式返回，此方法为异步方法。 @@ -6064,7 +6064,7 @@ getSecurityLevel(\): Promise; ### get8+ ### -get\(deviceId: string, key: string, callback: AsyncCallback\): void; +get\(deviceId: string, key: string, callback: AsyncCallback\): void; 获取与指定设备 ID 和密钥匹配的 String 值，并通过callback方式返回，此方法为异步方法。 @@ -6131,7 +6131,7 @@ get\(deviceId: string, key: string, callback: AsyncCallback8+ ### -get\(deviceId: string, key: string\): Promise; +get\(deviceId: string, key: string\): Promise; 获取与指定设备 ID 和密钥匹配的 String 值，并通过Promise方式返回，此方法为异步方法。 @@ -6210,7 +6210,7 @@ get\(deviceId: string, key: string\): Promise ### getEntries8+ ### -getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback\): void; +getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback\): void; 获取与指定设备 ID 和密钥前缀匹配的所有键值对，并通过callback方式返回，此方法为异步方法。 @@ -6290,7 +6290,7 @@ getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback8+ ### -getEntries\(deviceId: string, keyPrefix: string\): Promise; +getEntries\(deviceId: string, keyPrefix: string\): Promise; 获取与指定设备 ID 和密钥前缀匹配的所有键值对，并通过Promise方式返回，此方法为异步方法。 @@ -6384,7 +6384,7 @@ getEntries\(deviceId: string, keyPrefix: string\): Promise; ### getEntries8+ ### -getEntries\(query: Query, callback: AsyncCallback\): void; +getEntries\(query: Query, callback: AsyncCallback\): void; 获取与指定 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。 @@ -6455,7 +6455,7 @@ getEntries\(query: Query, callback: AsyncCallback\): void; ### getEntries8+ ### -getEntries\(query: Query\): Promise; +getEntries\(query: Query\): Promise; 获取与指定 Query 对象匹配的键值对列表，并通过Promise方式返回，此方法为异步方法。 @@ -6537,7 +6537,7 @@ getEntries\(query: Query\): Promise; ### getEntries8+ ### -getEntries\(deviceId: string, query: Query, callback: AsyncCallback\): void; +getEntries\(deviceId: string, query: Query, callback: AsyncCallback\): void; 获取与指定设备 ID 和 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。 @@ -6617,7 +6617,7 @@ getEntries\(deviceId: string, query: Query, callback: AsyncCallback\) ### getEntries8+ ### -getEntries\(deviceId: string, query: Query\): Promise; +getEntries\(deviceId: string, query: Query\): Promise; 获取与指定设备 ID 和 Query 对象匹配的键值对列表，并通过Promise方式返回，此方法为异步方法。 @@ -6708,7 +6708,7 @@ getEntries\(deviceId: string, query: Query\): Promise; ### getResultSet8+ ### -getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback\): void; +getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback\): void; 获取与指定设备 ID 和密钥前缀匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -6775,7 +6775,7 @@ getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback8+ ### -getResultSet\(deviceId: string, keyPrefix: string\): Promise; +getResultSet\(deviceId: string, keyPrefix: string\): Promise; 获取与指定设备 ID 和密钥前缀匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -6854,7 +6854,7 @@ getResultSet\(deviceId: string, keyPrefix: string\): Promise; ### getResultSet8+ ### -getResultSet\(query: Query, callback: AsyncCallback\): void; +getResultSet\(query: Query, callback: AsyncCallback\): void; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -6908,7 +6908,7 @@ getResultSet\(query: Query, callback: AsyncCallback\): void; ### getResultSet8+ ### -getResultSet\(query: Query\): Promise; +getResultSet\(query: Query\): Promise; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -6999,7 +6999,7 @@ getResultSet\(query: Query\): Promise; ### getResultSet8+ ### -getResultSet\(deviceId: string, query: Query, callback: AsyncCallback\): void; +getResultSet\(deviceId: string, query: Query, callback: AsyncCallback\): void; 获取与指定设备ID和Query对象匹配的KvStoreResultSet对象，并通过callback方式返回，此方法为异步方法。 @@ -7062,7 +7062,7 @@ getResultSet\(deviceId: string, query: Query, callback: AsyncCallback8+ ### -getResultSet\(deviceId: string, query: Query\): Promise; +getResultSet\(deviceId: string, query: Query\): Promise; 获取与指定设备ID和Query对象匹配的KvStoreResultSet对象，并通过Promise方式返回，此方法为异步方法。 @@ -7163,7 +7163,7 @@ getResultSet\(deviceId: string, query: Query\): Promise; ### closeResultSet8+ ### -closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): void; +closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): void; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -7287,7 +7287,7 @@ closeResultSet\(resultSet: KvStoreResultSet\): Promise; ### getResultSize8+ ### -getResultSize\(query: Query, callback: AsyncCallback\): void; +getResultSize\(query: Query, callback: AsyncCallback\): void; 获取与指定 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。 @@ -7339,7 +7339,7 @@ getResultSize\(query: Query, callback: AsyncCallback\): void; ### getResultSize8+ ### -getResultSize\(query: Query\): Promise; +getResultSize\(query: Query\): Promise; 获取与指定 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。 @@ -7399,7 +7399,7 @@ getResultSize\(query: Query\): Promise; ### getResultSize8+ ### -getResultSize\(deviceId: string, query: Query, callback: AsyncCallback\): void; +getResultSize\(deviceId: string, query: Query, callback: AsyncCallback\): void; 获取与指定设备 ID 和 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。 @@ -7460,7 +7460,7 @@ getResultSize\(deviceId: string, query: Query, callback: AsyncCallback\ ### getResultSize8+ ### -getResultSize\(deviceId: string, query: Query\): Promise; +getResultSize\(deviceId: string, query: Query\): Promise; 获取与指定设备 ID 和 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。 @@ -7529,7 +7529,7 @@ getResultSize\(deviceId: string, query: Query\): Promise; ### removeDeviceData8+ ### -removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; +removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; 从当前数据库中删除指定设备的数据，并通过callback方式返回，此方法为异步方法。 @@ -7595,7 +7595,7 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; ### removeDeviceData8+ ### -removeDeviceData\(deviceId: string\): Promise; +removeDeviceData\(deviceId: string\): Promise; 从当前数据库中删除指定设备的数据，并通过Promise方式返回，此方法为异步方法。 @@ -7743,7 +7743,7 @@ sync\(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number\): void; ### on8+ ### -on\(event: 'syncComplete', syncCallback: Callback\>): void; +on\(event: 'syncComplete', syncCallback: Callback>): void; 注册同步 DeviceKvStore 数据库回调，通过异步回调返回。 -- Gitee From 53315bafe73d38326e546b44f6b727983a9d7dbe Mon Sep 17 00:00:00 2001 From: asfasdff Date: Thu, 6 Jan 2022 11:43:24 +0800 Subject: [PATCH 3/6] apis fix up Signed-off-by: asfasdff --- .../apis/js-apis-distributed-data.md | 246 +++++++++--------- 1 file changed, 123 insertions(+), 123 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index ab87c422d9f..56bcd4a5ef3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -15,7 +15,7 @@ import distributedData from '@ohos.data.distributedData'; ## distributedData.createKVManager -createKVManager\(config: KVManagerConfig, callback: AsyncCallback\): void +createKVManager(config: KVManagerConfig, callback: AsyncCallback): void 创建一个KVManager对象实例，用于管理数据库对象，并通过callback方式返回，此方法为异步方法。 @@ -81,7 +81,7 @@ createKVManager\(config: KVManagerConfig, callback: AsyncCallback\): ## distributedData.createKVManager -createKVManager\(config: KVManagerConfig\): Promise +createKVManager(config: KVManagerConfig): Promise 创建一个KVManager对象实例，用于管理数据库对象，并通过Promise方式返回，此方法为异步方法。 @@ -252,7 +252,7 @@ createKVManager\(config: KVManagerConfig\): Promise ### getKVStore -getKVStore\(storeId: string, options: Options, callback: AsyncCallback\): void +getKVStore(storeId: string, options: Options, callback: AsyncCallback): void 通过指定Options和storeId，创建并获取KVStore数据库，并通过callback方式返回，此方法为异步方法。 @@ -329,7 +329,7 @@ getKVStore\(storeId: string, options: Options, callback: Asyn ### getKVStore -getKVStore\(storeId: string, options: Options\): Promise +getKVStore(storeId: string, options: Options): Promise 通过指定Options和storeId，创建并获取KVStore数据库，并通过Promise方式返回，此方法为异步方法。 @@ -411,7 +411,7 @@ getKVStore\(storeId: string, options: Options\): Promise ### closeKVStore8+ ### -closeKVStore\(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback\): void; +closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback): void; 通过storId的值关闭指定的kvStore数据库，并通过callback方式返回，此方法为异步方法。 @@ -485,7 +485,7 @@ closeKVStore\(appId: string, storeId: string, kvStore: KVStore, callback: AsyncC ### closeKVStore8+ ### -closeKVStore\(appId: string, storeId: string, kvStore: KVStore\): Promise; +closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise; 通过kvStore的值关闭指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 @@ -633,7 +633,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback): vo ### deleteKVStore8+ ### -deleteKVStore\(appId: string, storeId: string\): Promise; +deleteKVStore(appId: string, storeId: string): Promise; 通过storeId的值删除指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 @@ -760,7 +760,7 @@ getAllKVStoreId(appId: string, callback: AsyncCallback): void; ### getAllKVStoreId8+ ### -getAllKVStoreId\(appId: string\): Promise; +getAllKVStoreId(appId: string): Promise; 获取所有通过getKvStore方法创建的且没有调用deleteKvStore方法删除的KvStore数据库的storeId，并通过Promise方式返回，此方法为异步方法。 @@ -830,7 +830,7 @@ getAllKVStoreId\(appId: string\): Promise; ### on8+ ### -on\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; +on(event: 'distributedDataServiceDie', deathCallback: Callback): void; 订阅设备状态变更通知，并通过callback方式返回，此方法为异步方法。 @@ -886,7 +886,7 @@ on\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; ### off8+ ### -off\(event: 'distributedDataServiceDie', deathCallback: Callback\): void; +off(event: 'distributedDataServiceDie', deathCallback: Callback): void; 取消订阅设备状态变更通知，并通过callback方式返回，此方法为异步方法。 @@ -1226,7 +1226,7 @@ toJsonString():string; ### constructor8+ ### -constructor\(name: string\); +constructor(name: string); 用于创建具有指定字段的 FieldNode 实例的构造函数。 @@ -1266,7 +1266,7 @@ constructor\(name: string\); ### appendChild8+ ### -appendChild\(child: FieldNode\): boolean; +appendChild(child: FieldNode): boolean; 向这个 FieldNode 添加一个子节点。 @@ -1334,7 +1334,7 @@ appendChild\(child: FieldNode\): boolean; ### toJson8+ ### -toJson(\): string; +toJson(): string; 获取字段名称。 @@ -1374,7 +1374,7 @@ toJson(\): string; ### getCount8+ ### -getCount(\): number; +getCount(): number; 获取结果集中的行数。 @@ -1410,7 +1410,7 @@ getCount(\): number; ### getPosition8+ ### -getPosition(\): number; +getPosition(): number; 获取结果集中当前的读取位置。 @@ -1446,7 +1446,7 @@ getPosition(\): number; ### moveToFirst8+ ### -moveToFirst(\): boolean; +moveToFirst(): boolean; 将读取位置移动到第一行。 @@ -1482,7 +1482,7 @@ moveToFirst(\): boolean; ### moveToLast8+ ### -moveToLast(\): boolean; +moveToLast(): boolean; 将读取位置移动到最后一行。 @@ -1518,7 +1518,7 @@ moveToLast(\): boolean; ### moveToNext8+ ### -moveToNext(\): boolean; +moveToNext(): boolean; 将读取位置移动到下一行。 @@ -1554,7 +1554,7 @@ moveToNext(\): boolean; ### moveToPrevious8+ ### -moveToPrevious(\): boolean; +moveToPrevious(): boolean; 将读取位置移动到上一行。 @@ -1590,7 +1590,7 @@ moveToPrevious(\): boolean; ### move8+ ### -move\(offset: number\): boolean; +move(offset: number): boolean; 将读取位置移动到当前位置的相对偏移量。 @@ -1648,7 +1648,7 @@ move\(offset: number\): boolean; ### moveToPosition8+ ### -moveToPosition\(position: number\): boolean; +moveToPosition(position: number): boolean; 将读取位置从 0 移动到绝对位置。 @@ -1706,7 +1706,7 @@ moveToPosition\(position: number\): boolean; ### isFirst8+ ### -isFirst(\): boolean; +isFirst(): boolean; 检查读取位置是否为第一行。 @@ -1742,7 +1742,7 @@ isFirst(\): boolean; ### isLast8+ ### -isLast(\): boolean; +isLast(): boolean; 检查读取位置是否为最后一行。 @@ -1778,7 +1778,7 @@ isLast(\): boolean; ### isBeforeFirst8+ ### -isBeforeFirst(\): boolean; +isBeforeFirst(): boolean; 检查读取位置是否在第一行之前。 @@ -1814,7 +1814,7 @@ isBeforeFirst(\): boolean; ### isAfterLast8+ ### -isAfterLast(\): boolean; +isAfterLast(): boolean; 检查读取位置是否在最后一行之后。 @@ -1850,7 +1850,7 @@ isAfterLast(\): boolean; ### getEntry8+ ### -getEntry(\): Entry; +getEntry(): Entry; 获取键值对 @@ -1907,7 +1907,7 @@ constructor(); ### reset8+ ### -reset(\): Query; +reset(): Query; 公共查询重置。 @@ -1947,7 +1947,7 @@ reset(\): Query; ### equalTo8+ ### -equalTo\(field: string, value: number|string|boolean\): Query; +equalTo(field: string, value: number|string|boolean): Query; 构造一个Query对象来查询具有指定字段的条目，其值等于指定的值。 @@ -2016,7 +2016,7 @@ equalTo\(field: string, value: number|string|boolean\): Query; ### notEqualTo8+ ### -notEqualTo\(field: string, value: number|string|boolean\): Query; +notEqualTo(field: string, value: number|string|boolean): Query; 构造一个Query对象以查询具有指定字段且值不等于指定值的条目。 @@ -2085,7 +2085,7 @@ notEqualTo\(field: string, value: number|string|boolean\): Query; ### greaterThan8+ ### -greaterThan\(field: string, value: number|string|boolean\): Query; +greaterThan(field: string, value: number|string|boolean): Query; 构造一个Query对象以查询具有大于指定值的指定字段的条目。 @@ -2154,7 +2154,7 @@ greaterThan\(field: string, value: number|string|boolean\): Query; ### lessThan8+ ### -lessThan\(field: string, value: number|string\): Query; +lessThan(field: string, value: number|string): Query; 构造一个Query对象以查询具有小于指定值的指定字段的条目。 @@ -2223,7 +2223,7 @@ lessThan\(field: string, value: number|string\): Query; ### greaterThanOrEqualTo8+ ### -greaterThanOrEqualTo\(field: string, value: number|string\): Query; +greaterThanOrEqualTo(field: string, value: number|string): Query; 构造一个Query对象以查询具有指定字段且值大于或等于指定值的条目。 @@ -2292,7 +2292,7 @@ greaterThanOrEqualTo\(field: string, value: number|string\): Query; ### lessThanOrEqualTo8+ ### -lessThanOrEqualTo\(field: string, value: number|string\): Query; +lessThanOrEqualTo(field: string, value: number|string): Query; 构造一个Query对象以查询具有指定字段且值小于或等于指定值的条目。 @@ -2361,7 +2361,7 @@ lessThanOrEqualTo\(field: string, value: number|string\): Query; ### isNull8+ ### -isNull\(field: string\): Query; +isNull(field: string): Query; 构造一个Query对象以查询具有值为null的指定字段的条目。 @@ -2422,7 +2422,7 @@ isNull\(field: string\): Query; ### inNumber8+ ### -inNumber\(field: string, valueList: number[\]\): Query; +inNumber(field: string, valueList: number[]): Query; 构造一个Query对象以查询具有指定字段的条目，其值在指定的值列表中。 @@ -2491,7 +2491,7 @@ inNumber\(field: string, valueList: number[\]\): Query; ### inString8+ ### -inString\(field: string, valueList: string[\]\): Query; +inString(field: string, valueList: string[]): Query; 构造一个Query对象以查询具有指定字段的条目，其值在指定的字符串值列表中。 @@ -2560,7 +2560,7 @@ inString\(field: string, valueList: string[\]\): Query; ### notInNumber8+ ### -notInNumber\(field: string, valueList: number[\]\): Query; +notInNumber(field: string, valueList: number[]): Query; 构造一个Query对象以查询具有指定字段的条目，该字段的值不在指定的值列表中。 @@ -2629,7 +2629,7 @@ notInNumber\(field: string, valueList: number[\]\): Query; ### notInString8+ ### -notInString\(field: string, valueList: string[\]\): Query; +notInString(field: string, valueList: string[]): Query; 构造一个Query对象以查询具有指定字段且值不在指定字符串值列表中的条目。 @@ -2698,7 +2698,7 @@ notInString\(field: string, valueList: string[\]\): Query; ### like8+ ### -like\(field: string, value: string\): Query; +like(field: string, value: string): Query; 构造一个Query对象以查询具有与指定字符串值相似的指定字段的条目。 @@ -2767,7 +2767,7 @@ like\(field: string, value: string\): Query; ### unlike8+ ### -unlike\(field: string, value: string\): Query; +unlike(field: string, value: string): Query; 构造一个Query对象以查询具有与指定字符串值不相似的指定字段的条目。 @@ -2836,7 +2836,7 @@ unlike\(field: string, value: string\): Query; ### and8+ ### -and(\): Query; +and(): Query; 构造一个带有与条件的查询对象。 @@ -2876,7 +2876,7 @@ and(\): Query; ### or8+ ### -or(\): Query; +or(): Query; 构造一个带有或条件的Query对象。 @@ -2916,7 +2916,7 @@ or(\): Query; ### orderByAsc8+ ### -orderByAsc\(field: string\): Query; +orderByAsc(field: string): Query; 构造一个Query对象，将查询结果按升序排序。 @@ -2979,7 +2979,7 @@ orderByAsc\(field: string\): Query; ### orderByDesc8+ ### -orderByDesc\(field: string\): Query; +orderByDesc(field: string): Query; 构造一个Query对象，将查询结果按降序排序。 @@ -3041,7 +3041,7 @@ orderByDesc\(field: string\): Query; ### limit8+ ### -limit\(total: number, offset: number\): Query; +limit(total: number, offset: number): Query; 构造一个Query对象来指定结果的数量和开始位置。 @@ -3111,7 +3111,7 @@ limit\(total: number, offset: number\): Query; ### isNotNull8+ ### -isNotNull\(field: string\): Query; +isNotNull(field: string): Query; 使用不为空的指定字段创建查询条件。 @@ -3172,7 +3172,7 @@ isNotNull\(field: string\): Query; ### beginGroup8+ ### -beginGroup\(\): Query; +beginGroup(): Query; 创建一个带有左括号的查询条件组。 @@ -3212,7 +3212,7 @@ beginGroup\(\): Query; ### endGroup8+ ### -endGroup\(\): Query; +endGroup(): Query; 创建一个带有右括号的查询条件组。 @@ -3252,7 +3252,7 @@ endGroup\(\): Query; ### prefixKey8+ ### -prefixKey\(prefix: string\): Query; +prefixKey(prefix: string): Query; 创建具有指定键前缀的查询条件。 @@ -3313,7 +3313,7 @@ prefixKey\(prefix: string\): Query; ### setSuggestIndex8+ ### -setSuggestIndex\(index: string\): Query; +setSuggestIndex(index: string): Query; 设置一个指定的索引，将优先用于查询。 @@ -3378,7 +3378,7 @@ KVStore数据库实例，提供增加数据、删除数据和订阅数据变更 ### put -put\(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback\): void +put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback): void 添加指定类型键值对到数据库，并通过callback方式返回，此方法为异步方法。 @@ -3447,7 +3447,7 @@ put\(key: string, value: Uint8Array | string | number | boolean, callback: Async ### put -put\(key: string, value: Uint8Array | string | number | boolean\): Promise +put(key: string, value: Uint8Array | string | number | boolean): Promise 添加指定类型键值对到数据库，并通过Promise方式返回，此方法为异步方法。 @@ -3523,7 +3523,7 @@ put\(key: string, value: Uint8Array | string | number | boolean\): Promise ### delete -delete\(key: string, callback: AsyncCallback\): void +delete(key: string, callback: AsyncCallback): void 从数据库中删除指定键值的数据，并通过callback方式返回，此方法为异步方法。 @@ -3589,7 +3589,7 @@ delete\(key: string, callback: AsyncCallback\): void ### delete -delete\(key: string\): Promise +delete(key: string): Promise 从数据库中删除指定键值的数据，并通过Promise方式返回，此方法为异步方法。 @@ -3659,7 +3659,7 @@ delete\(key: string\): Promise ### on -on\(event: 'dataChange', type: SubscribeType, observer: Callback\): void +on(event: 'dataChange', type: SubscribeType, observer: Callback): void 订阅指定类型的数据变更通知，此方法为同步方法。 @@ -3709,7 +3709,7 @@ on\(event: 'dataChange', type: SubscribeType, observer: Callback -on\(event: 'syncComplete', syncCallback: Callback>\): void +on(event: 'syncComplete', syncCallback: Callback): void 订阅数据同步完成通知，此方法为同步方法。 @@ -3733,7 +3733,7 @@ on\(event: 'syncComplete', syncCallback: Callback>\):

syncCallback

-

Callback<Array<[string, number]>>

+

Callback<Array<[string, number]>

回调函数。

@@ -3751,7 +3751,7 @@ on\(event: 'syncComplete', syncCallback: Callback>\): ### off8+ ### -off\(event:'dataChange', observer: Callback\): void; +off(event:'dataChange', observer: Callback): void; 取消订阅数据同步完成通知，此方法为同步方法。 @@ -3785,7 +3785,7 @@ off\(event:'dataChange', observer: Callback\): void; ### putBatch8+ ### -putBatch\(entries: Entry[], callback: AsyncCallback\): void; +putBatch(entries: Entry[], callback: AsyncCallback): void; 批量插入键值对到KvStore数据库中，并通过callback方式返回，此方法为异步方法。 @@ -3822,7 +3822,7 @@ putBatch\(entries: Entry[], callback: AsyncCallback\): void; ### putBatch8+ ### -putBatch\(entries: Entry[\]\): Promise; +putBatch(entries: Entry[]): Promise; 批量插入键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。 @@ -3905,7 +3905,7 @@ deleteBatch(keys: string[], callback: AsyncCallback): void; ### deleteBatch8+ ### -deleteBatch\(keys: string[\]\): Promise; +deleteBatch(keys: string[]): Promise; 批量删除键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。 @@ -3951,7 +3951,7 @@ deleteBatch\(keys: string[\]\): Promise; ### startTransaction8+ ### -startTransaction\(callback: AsyncCallback\): void; +startTransaction(callback: AsyncCallback): void; 启动KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 @@ -3980,7 +3980,7 @@ startTransaction\(callback: AsyncCallback\): void; ### startTransaction8+ ### -startTransaction\(\): Promise; +startTransaction(): Promise; 启动KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 @@ -4003,7 +4003,7 @@ startTransaction\(\): Promise; ### commit8+ ### -commit\(callback: AsyncCallback\): void; +commit(callback: AsyncCallback): void; 提交KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 @@ -4032,7 +4032,7 @@ commit\(callback: AsyncCallback\): void; ### commit8+ ### -commit(\): Promise; +commit(): Promise; 提交KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 @@ -4055,7 +4055,7 @@ commit(\): Promise; ### rollback8+ ### -rollback\(callback: AsyncCallback\): void; +rollback(callback: AsyncCallback): void; 在KvStore数据库中回滚事务，并通过callback方式返回，此方法为异步方法。 @@ -4084,7 +4084,7 @@ rollback\(callback: AsyncCallback\): void; ### rollback8+ ### -rollback(\): Promise; +rollback(): Promise; 在KvStore数据库中回滚事务，并通过Promise方式返回，此方法为异步方法。 @@ -4107,7 +4107,7 @@ rollback(\): Promise; ### enableSync8+ ### -enableSync\(enabled: boolean, callback: AsyncCallback\): void; +enableSync(enabled: boolean, callback: AsyncCallback): void; 设定是否开启同步，并通过callback方式返回，此方法为异步方法。 @@ -4147,7 +4147,7 @@ enableSync\(enabled: boolean, callback: AsyncCallback\): void; ### enableSync8+ ### -enableSync\(enabled: boolean\): Promise; +enableSync(enabled: boolean): Promise; 设定是否开启同步，并通过Promise方式返回，此方法为异步方法。 @@ -4195,7 +4195,7 @@ enableSync\(enabled: boolean\): Promise; ### setSyncRange8+ ### -setSyncRange\(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback\): void; +setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback): void; 设置同步范围标签，并通过callback方式返回，此方法为异步方法。 @@ -4244,7 +4244,7 @@ setSyncRange\(localLabels: string[], remoteSupportLabels: string[], callback: As ### setSyncRange8+ ### -setSyncRange\(localLabels: string[], remoteSupportLabels: string[\]\): Promise; +setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise; 设置同步范围标签，并通过Promise方式返回，此方法为异步方法。 @@ -4550,7 +4550,7 @@ setSyncRange\(localLabels: string[], remoteSupportLabels: string[\]\): Promise -get\(key: string, callback: AsyncCallback\): void +get(key: string, callback: AsyncCallback): void 获取指定键的值，并通过callback方式返回，此方法为异步方法。 @@ -4612,7 +4612,7 @@ get\(key: string, callback: AsyncCallback -get\(key: string\): Promise +get(key: string): Promise 获取指定键的值，并通过Promise方式返回，此方法为异步方法。 @@ -4682,7 +4682,7 @@ get\(key: string\): Promise ### getEntries8+ ### -getEntries\(keyPrefix: string, callback: AsyncCallback\): void; +getEntries(keyPrefix: string, callback: AsyncCallback): void; 获取匹配指定键前缀的所有键值对，并通过callback方式返回，此方法为异步方法。 @@ -4752,7 +4752,7 @@ getEntries\(keyPrefix: string, callback: AsyncCallback\): void; ### getEntries8+ ### -getEntries\(keyPrefix: string\): Promise; +getEntries(keyPrefix: string): Promise; 获取匹配指定键前缀的所有键值对，并通过Promise方式返回，此方法为异步方法。 @@ -4837,7 +4837,7 @@ getEntries\(keyPrefix: string\): Promise; ### getEntries8+ ### -getEntries\(query: Query, callback: AsyncCallback\): void; +getEntries(query: Query, callback: AsyncCallback): void; 获取与指定 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。 @@ -4908,7 +4908,7 @@ getEntries\(query: Query, callback: AsyncCallback\): void; ### getEntries8+ ### -getEntries\(query: Query\): Promise; +getEntries(query: Query): Promise; 获取匹配指定键前缀的所有键值对，并通过Promise方式返回，此方法为异步方法。 @@ -4993,7 +4993,7 @@ getEntries\(query: Query\): Promise; ### getResultSet8+ ### -getResultSet\(keyPrefix: string, callback: AsyncCallback\): void; +getResultSet(keyPrefix: string, callback: AsyncCallback): void; 从 KvStore 数据库中获取具有指定前缀的结果集，并通过callback方式返回，此方法为异步方法。 @@ -5066,7 +5066,7 @@ getResultSet\(keyPrefix: string, callback: AsyncCallback\): vo ### getResultSet8+ ### -getResultSet\(keyPrefix: string\): Promise; +getResultSet(keyPrefix: string): Promise; 从 KvStore 数据库中获取具有指定前缀的结果集，并通过Promise方式返回，此方法为异步方法。 @@ -5154,7 +5154,7 @@ getResultSet\(keyPrefix: string\): Promise; ### getResultSet8+ ### -getResultSet\(query: Query, callback: AsyncCallback\): void; +getResultSet(query: Query, callback: AsyncCallback): void; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -5226,7 +5226,7 @@ getResultSet\(query: Query, callback: AsyncCallback\): void; ### getResultSet8+ ### -getResultSet\(query: Query\): Promise; +getResultSet(query: Query): Promise; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -5312,7 +5312,7 @@ getResultSet\(query: Query\): Promise; ### closeResultSet8+ ### -closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): void; +closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback): void; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -5371,7 +5371,7 @@ closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): vo ### closeResultSet8+ ### -closeResultSet\(resultSet: KvStoreResultSet\): Promise; +closeResultSet(resultSet: KvStoreResultSet): Promise; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -5436,7 +5436,7 @@ closeResultSet\(resultSet: KvStoreResultSet\): Promise; ### getResultSize8+ ### -getResultSize\(query: Query, callback: AsyncCallback\): void; +getResultSize(query: Query, callback: AsyncCallback): void; 获取与指定 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。 @@ -5488,7 +5488,7 @@ getResultSize\(query: Query, callback: AsyncCallback\): void; ### getResultSize8+ ### -getResultSize\(query: Query\): Promise; +getResultSize(query: Query): Promise; 获取与指定 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。 @@ -5548,7 +5548,7 @@ getResultSize\(query: Query\): Promise; ### removeDeviceData8+ ### -removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; +removeDeviceData(deviceId: string, callback: AsyncCallback): void; 删除指定设备的数据，并通过callback方式返回，此方法为异步方法。 @@ -5614,7 +5614,7 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; ### removeDeviceData8+ ### -removeDeviceData\(deviceId: string\): Promise; +removeDeviceData(deviceId: string): Promise; 删除指定设备的数据，并通过Promise方式返回，此方法为异步方法。 @@ -5690,7 +5690,7 @@ removeDeviceData\(deviceId: string\): Promise; ### on8+ ### -on\(event: 'syncComplete', syncCallback: Callback\): void; +on(event: 'syncComplete', syncCallback: Callback): void; 注册同步 SingleKvStore 数据库回调，并通过异步方式返回。 @@ -5718,7 +5718,7 @@ on\(event: 'syncComplete', syncCallback: Callback\): voi

syncCallback

-

Callback<Array<[string, number]>>>

+

Callback<Array<[string, number]>

是

@@ -5750,7 +5750,7 @@ on\(event: 'syncComplete', syncCallback: Callback\): voi ### off8+ ### -off\(event: 'syncComplete', syncCallback: Callback>\): void; +off(event: 'syncComplete', syncCallback: Callback): void; 取消注册同步 SingleKvStore 数据库回调，并通过异步方式返回。 @@ -5778,7 +5778,7 @@ off\(event: 'syncComplete', syncCallback: Callback>\): v

syncCallback

-

Callback<Array<[string, number]>>>

+

Callback<Array<[string, number]>

是

@@ -5805,7 +5805,7 @@ off\(event: 'syncComplete', syncCallback: Callback>\): v ### sync -sync\(deviceIdList: string\[\], mode: SyncMode, allowedDelayMs?: number\): void +sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void 在手动同步模式下，触发数据库同步，此方法为同步方法。 @@ -5860,7 +5860,7 @@ sync\(deviceIdList: string\[\], mode: SyncMode, allowedDelayMs?: number\): void ### setSyncParam8+ ### -setSyncParam\(defaultAllowedDelayMs: number, callback: AsyncCallback\): void; +setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback): void; 设置允许数据库同步的默认延迟,并通过callback方式返回，此方法为异步方法。 @@ -5914,7 +5914,7 @@ setSyncParam\(defaultAllowedDelayMs: number, callback: AsyncCallback\): vo ### setSyncParam8+ ### -setSyncParam\(defaultAllowedDelayMs: number\): Promise; +setSyncParam(defaultAllowedDelayMs: number): Promise; 设置允许数据库同步的默认延迟,并通过Promise方式返回，此方法为异步方法。 @@ -5978,7 +5978,7 @@ setSyncParam\(defaultAllowedDelayMs: number\): Promise; ### getSecurityLevel8+ ### -getSecurityLevel\(callback: AsyncCallback\): void; +getSecurityLevel(callback: AsyncCallback): void; 获取数据库的安全级别，并通过callback方式返回，此方法为异步方法。 @@ -6022,7 +6022,7 @@ getSecurityLevel\(callback: AsyncCallback\): void; ### getSecurityLevel8+ ### -getSecurityLevel(\): Promise; +getSecurityLevel(): Promise; 获取数据库的安全级别，并通过Promise方式返回，此方法为异步方法。 @@ -6064,7 +6064,7 @@ getSecurityLevel(\): Promise; ### get8+ ### -get\(deviceId: string, key: string, callback: AsyncCallback\): void; +get(deviceId: string, key: string, callback: AsyncCallback): void; 获取与指定设备 ID 和密钥匹配的 String 值，并通过callback方式返回，此方法为异步方法。 @@ -6131,7 +6131,7 @@ get\(deviceId: string, key: string, callback: AsyncCallback8+ ### -get\(deviceId: string, key: string\): Promise; +get(deviceId: string, key: string): Promise; 获取与指定设备 ID 和密钥匹配的 String 值，并通过Promise方式返回，此方法为异步方法。 @@ -6210,7 +6210,7 @@ get\(deviceId: string, key: string\): Promise; ### getEntries8+ ### -getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback\): void; +getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback): void; 获取与指定设备 ID 和密钥前缀匹配的所有键值对，并通过callback方式返回，此方法为异步方法。 @@ -6290,7 +6290,7 @@ getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback8+ ### -getEntries\(deviceId: string, keyPrefix: string\): Promise; +getEntries(deviceId: string, keyPrefix: string): Promise; 获取与指定设备 ID 和密钥前缀匹配的所有键值对，并通过Promise方式返回，此方法为异步方法。 @@ -6384,7 +6384,7 @@ getEntries\(deviceId: string, keyPrefix: string\): Promise; ### getEntries8+ ### -getEntries\(query: Query, callback: AsyncCallback\): void; +getEntries(query: Query, callback: AsyncCallback): void; 获取与指定 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。 @@ -6455,7 +6455,7 @@ getEntries\(query: Query, callback: AsyncCallback\): void; ### getEntries8+ ### -getEntries\(query: Query\): Promise; +getEntries(query: Query): Promise; 获取与指定 Query 对象匹配的键值对列表，并通过Promise方式返回，此方法为异步方法。 @@ -6537,7 +6537,7 @@ getEntries\(query: Query\): Promise; ### getEntries8+ ### -getEntries\(deviceId: string, query: Query, callback: AsyncCallback\): void; +getEntries(deviceId: string, query: Query, callback: AsyncCallback): void; 获取与指定设备 ID 和 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。 @@ -6617,7 +6617,7 @@ getEntries\(deviceId: string, query: Query, callback: AsyncCallback\): ### getEntries8+ ### -getEntries\(deviceId: string, query: Query\): Promise; +getEntries(deviceId: string, query: Query): Promise; 获取与指定设备 ID 和 Query 对象匹配的键值对列表，并通过Promise方式返回，此方法为异步方法。 @@ -6708,7 +6708,7 @@ getEntries\(deviceId: string, query: Query\): Promise; ### getResultSet8+ ### -getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback\): void; +getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback): void; 获取与指定设备 ID 和密钥前缀匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -6775,7 +6775,7 @@ getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback8+ ### -getResultSet\(deviceId: string, keyPrefix: string\): Promise; +getResultSet(deviceId: string, keyPrefix: string): Promise; 获取与指定设备 ID 和密钥前缀匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -6854,7 +6854,7 @@ getResultSet\(deviceId: string, keyPrefix: string\): Promise; ### getResultSet8+ ### -getResultSet\(query: Query, callback: AsyncCallback\): void; +getResultSet(query: Query, callback: AsyncCallback): void; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -6908,7 +6908,7 @@ getResultSet\(query: Query, callback: AsyncCallback\): void; ### getResultSet8+ ### -getResultSet\(query: Query\): Promise; +getResultSet(query: Query): Promise; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -6999,7 +6999,7 @@ getResultSet\(query: Query\): Promise; ### getResultSet8+ ### -getResultSet\(deviceId: string, query: Query, callback: AsyncCallback\): void; +getResultSet(deviceId: string, query: Query, callback: AsyncCallback): void; 获取与指定设备ID和Query对象匹配的KvStoreResultSet对象，并通过callback方式返回，此方法为异步方法。 @@ -7062,7 +7062,7 @@ getResultSet\(deviceId: string, query: Query, callback: AsyncCallback8+ ### -getResultSet\(deviceId: string, query: Query\): Promise; +getResultSet(deviceId: string, query: Query): Promise; 获取与指定设备ID和Query对象匹配的KvStoreResultSet对象，并通过Promise方式返回，此方法为异步方法。 @@ -7163,7 +7163,7 @@ getResultSet\(deviceId: string, query: Query\): Promise; ### closeResultSet8+ ### -closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): void; +closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback): void; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -7222,7 +7222,7 @@ closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback\): vo ### closeResultSet8+ ### -closeResultSet\(resultSet: KvStoreResultSet\): Promise; +closeResultSet(resultSet: KvStoreResultSet): Promise; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -7287,7 +7287,7 @@ closeResultSet\(resultSet: KvStoreResultSet\): Promise; ### getResultSize8+ ### -getResultSize\(query: Query, callback: AsyncCallback\): void; +getResultSize(query: Query, callback: AsyncCallback): void; 获取与指定 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。 @@ -7339,7 +7339,7 @@ getResultSize\(query: Query, callback: AsyncCallback\): void; ### getResultSize8+ ### -getResultSize\(query: Query\): Promise; +getResultSize(query: Query): Promise; 获取与指定 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。 @@ -7399,7 +7399,7 @@ getResultSize\(query: Query\): Promise; ### getResultSize8+ ### -getResultSize\(deviceId: string, query: Query, callback: AsyncCallback\): void; +getResultSize(deviceId: string, query: Query, callback: AsyncCallback): void; 获取与指定设备 ID 和 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。 @@ -7460,7 +7460,7 @@ getResultSize\(deviceId: string, query: Query, callback: AsyncCallback\) ### getResultSize8+ ### -getResultSize\(deviceId: string, query: Query\): Promise; +getResultSize(deviceId: string, query: Query): Promise; 获取与指定设备 ID 和 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。 @@ -7529,7 +7529,7 @@ getResultSize\(deviceId: string, query: Query\): Promise; ### removeDeviceData8+ ### -removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; +removeDeviceData(deviceId: string, callback: AsyncCallback): void; 从当前数据库中删除指定设备的数据，并通过callback方式返回，此方法为异步方法。 @@ -7595,7 +7595,7 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback\): void; ### removeDeviceData8+ ### -removeDeviceData\(deviceId: string\): Promise; +removeDeviceData(deviceId: string): Promise; 从当前数据库中删除指定设备的数据，并通过Promise方式返回，此方法为异步方法。 @@ -7674,7 +7674,7 @@ removeDeviceData\(deviceId: string\): Promise; ### sync8+ ### -sync\(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number\): void; +sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void; 同步 DeviceKvStore 数据库，该方法为异步方法。 @@ -7743,7 +7743,7 @@ sync\(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number\): void; ### on8+ ### -on\(event: 'syncComplete', syncCallback: Callback>): void; +on(event: 'syncComplete', syncCallback: Callback): void; 注册同步 DeviceKvStore 数据库回调，通过异步回调返回。 @@ -7771,7 +7771,7 @@ on\(event: 'syncComplete', syncCallback: Callback>): voi

syncCallback

-

Callback<Array<[string, number]>>>

+

Callback<Array<[string, number]>

是

@@ -7803,7 +7803,7 @@ on\(event: 'syncComplete', syncCallback: Callback>): voi ### off8+ ### -off\(event: 'syncComplete', syncCallback: Callback>\): void; +off(event: 'syncComplete', syncCallback: Callback): void; 取消注册同步 DeviceKvStore 数据库回调，通过异步回调返回。 @@ -7831,7 +7831,7 @@ off\(event: 'syncComplete', syncCallback: Callback>\): v

syncCallback

-

Callback<Array<[string, number]>>>

+

Callback<Array<[string, number]>

是

-- Gitee From 1af41329a3e3d0d4afafd23ea02db4e00968d760 Mon Sep 17 00:00:00 2001 From: asfasdff Date: Fri, 7 Jan 2022 15:26:28 +0800 Subject: [PATCH 4/6] apis fix up Signed-off-by: asfasdff --- .../apis/js-apis-distributed-data.md | 1568 ++++++++++++----- 1 file changed, 1104 insertions(+), 464 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index 56bcd4a5ef3..51115b9e23b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -15,7 +15,7 @@ import distributedData from '@ohos.data.distributedData'; ## distributedData.createKVManager -createKVManager(config: KVManagerConfig, callback: AsyncCallback): void +createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void 创建一个KVManager对象实例，用于管理数据库对象，并通过callback方式返回，此方法为异步方法。 @@ -62,7 +62,7 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback): vo bundleName : 'com.example.datamanagertest', userInfo : { userId : '0', - userType : 0 + userType : distributedData.UserType.SAME_USER_ID } } distributedData.createKVManager(kvManagerConfig, function (err, manager) { @@ -81,7 +81,7 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback): vo ## distributedData.createKVManager -createKVManager(config: KVManagerConfig): Promise +createKVManager(config: KVManagerConfig): Promise<KVManager> 创建一个KVManager对象实例，用于管理数据库对象，并通过Promise方式返回，此方法为异步方法。 @@ -136,7 +136,7 @@ createKVManager(config: KVManagerConfig): Promise bundleName : 'com.example.datamanagertest', userInfo : { userId : '0', - userType : 0 + userType : distributedData.UserType.SAME_USER_ID } } distributedData.createKVManager(kvManagerConfig).then((manager) => { @@ -252,7 +252,7 @@ createKVManager(config: KVManagerConfig): Promise ### getKVStore -getKVStore(storeId: string, options: Options, callback: AsyncCallback): void +getKVStore(storeId: string, options: Options, callback: AsyncCallback<T>): void 通过指定Options和storeId，创建并获取KVStore数据库，并通过callback方式返回，此方法为异步方法。 @@ -304,14 +304,15 @@ getKVStore(storeId: string, options: Options, callback: Async ``` let kvStore; + let kvManager; try { const options = { createIfMissing : true, encrypt : false, backup : false, autoSync : true, - kvStoreType : 1, - securityLevel : 3, + kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, + securityLevel : distributedData.SecurityLevel.S2, }; kvManager.getKVStore('storeId', options, function (err, store) { if (err) { @@ -329,7 +330,7 @@ getKVStore(storeId: string, options: Options, callback: Async ### getKVStore -getKVStore(storeId: string, options: Options): Promise +getKVStore<T extends KVStore>(storeId: string, options: Options): Promise<T> 通过指定Options和storeId，创建并获取KVStore数据库，并通过Promise方式返回，此方法为异步方法。 @@ -389,14 +390,15 @@ getKVStore(storeId: string, options: Options): Promise ``` let kvStore; + let kvManager; try { const options = { createIfMissing : true, encrypt : false, backup : false, autoSync : true, - kvStoreType : 1, - securityLevel : 3, + kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, + securityLevel : distributedData.SecurityLevel.S2, }; kvManager.getKVStore('storeId', options).then((store) => { console.log("getKVStore success"); @@ -411,7 +413,7 @@ getKVStore(storeId: string, options: Options): Promise ### closeKVStore8+ ### -closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback): void; +closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback<void>): void; 通过storId的值关闭指定的kvStore数据库，并通过callback方式返回，此方法为异步方法。 @@ -470,22 +472,33 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa - 示例： ``` + let kvStore; + let kvManager; + const options = { + createIfMissing : true, + encrypt : false, + backup : false, + autoSync : true, + kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, + schema : '', + securityLevel : distributedData.SecurityLevel.S2, + } try { kvManager.getKVStore('storeId', options, async function (err, store) { console.log('getKVStore success'); kvStore = store; - kvManager.closeKVStore('appId', 'storeId', kvStore, function (err, data) { + await kvManager.closeKVStore('appId', 'storeId', kvStore, function (err, data) { console.log('closeKVStore success'); }); }); } catch (e) { - console.log('CloseKVStore e ' + e); + console.log('closeKVStore e ' + e); } ``` ### closeKVStore8+ ### -closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise; +closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void>; 通过kvStore的值关闭指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 @@ -552,22 +565,38 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise; - 示例： ``` - let KvStore; + let kvManager; + let kvStore; + const options = { + createIfMissing : true, + encrypt : false, + backup : false, + autoSync : true, + kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, + schema : '', + securityLevel : distributedData.SecurityLevel.S2, + } try { - kvManager.closeKVStore('appId', 'storId', kvStore).then(() => { - console.log('CloseKVStore success'); + kvManager.getKVStore('storeId', options).then(async (store) => { + console.log('getKVStore success'); + kvStore = store; + await kvManager.closeKVStore('appId', 'storeId', kvStore).then(() => { + console.log('closeKVStore success'); + }).catch((err) => { + console.log('closeKVStore err ' + JSON.stringify(err)); + }); }).catch((err) => { - console.log('CloseKVStore err ' + JSON.stringify(err)); + console.log('CloseKVStore getKVStore err ' + JSON.stringify(err)); }); } catch (e) { - console.log("An unexpected error occurred. Error:" + e); + console.log('closeKVStore e ' + e); } ``` ### deleteKVStore8+ ### -deleteKVStore(appId: string, storeId: string, callback: AsyncCallback): void; +deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): void; 通过storeId的值删除指定的kvStore数据库，并通过callback方式返回，此方法为异步方法。 @@ -617,23 +646,33 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback): vo - 示例： ``` - let KvStore; + let kvManager; + let kvStore; + const options = { + createIfMissing : true, + encrypt : false, + backup : false, + autoSync : true, + kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, + schema : '', + securityLevel : distributedData.SecurityLevel.S2, + } try { - kvManager.deleteKVStore('appId', 'storeId', function (err, data) { - if (err){ + kvManager.getKVStore('store', options, async function (err, store) { + console.log('getKVStore success'); + kvStore = store; + await kvManager.deleteKVStore('appId', 'storeId', function (err, data) { console.log('deleteKVStore success'); - return; - } - console.log("deleteKVStore success"); + }); }); } catch (e) { - console.log("An unexpected error occurred. Error:" + e); + console.log('DeleteKVStore e ' + e); } ``` ### deleteKVStore8+ ### -deleteKVStore(appId: string, storeId: string): Promise; +deleteKVStore(appId: string, storeId: string): Promise<void>; 通过storeId的值删除指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 @@ -691,22 +730,38 @@ deleteKVStore(appId: string, storeId: string): Promise; - 示例： ``` - let KvStore; + let kvManager; + let kvStore; + const options = { + createIfMissing : true, + encrypt : false, + backup : false, + autoSync : true, + kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, + schema : '', + securityLevel : distributedData.SecurityLevel.S2, + } try { - kvManager.deleteKVStore('appId', 'storId', kvStore).then(() => { - console.log('deleteKVStore success'); + kvManager.getKVStore('storId', options).then(async (store) => { + console.log('getKVStore success'); + kvStore = store; + await kvManager.deleteKVStore('appId', 'storeId').then(() => { + console.log('deleteKVStore success'); + }).catch((err) => { + console.log('deleteKVStore err ' + JSON.stringify(err)); + }); }).catch((err) => { - console.log('deleteKVStore err ' + JSON.stringify(err)); + console.log('getKVStore err ' + JSON.stringify(err)); }); } catch (e) { - console.log("An unexpected error occurred. Error:" + e); + console.log('deleteKVStore e ' + e); } ``` ### getAllKVStoreId8+ ### -getAllKVStoreId(appId: string, callback: AsyncCallback): void; +getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void; 获取所有通过getKvStore方法创建的且没有调用deleteKvStore方法删除的KvStore数据库的storeId，并通过callback方式返回，此方法为异步方法。 @@ -747,9 +802,10 @@ getAllKVStoreId(appId: string, callback: AsyncCallback): void; - 示例： ``` + let kvManager; try { kvManager.getAllKVStoreId('appId', function (err, data) { - console.log('GetAllKVStoreId getAllKVStoreId success'); + console.log('GetAllKVStoreId success'); console.log('GetAllKVStoreId size = ' + data.length); }); } catch (e) { @@ -760,7 +816,7 @@ getAllKVStoreId(appId: string, callback: AsyncCallback): void; ### getAllKVStoreId8+ ### -getAllKVStoreId(appId: string): Promise; +getAllKVStoreId(appId: string): Promise<string[]>; 获取所有通过getKvStore方法创建的且没有调用deleteKvStore方法删除的KvStore数据库的storeId，并通过Promise方式返回，此方法为异步方法。 @@ -809,30 +865,26 @@ getAllKVStoreId(appId: string): Promise; - 示例： ``` - let KvStore; + let kvManager; try { - kvManager.getKVStore('storId', options).then(async (store) => { - console.log('getKVStore success'); - kvStore = store; - kvManager.getAllKVStoreId('appId').then((data) => { - console.log('getAllKVStoreId success'); - console.log('GetAllKVStoreId size = ' + data.length); - console.log('GetAllKVStoreId data[0] = ' + data[0]); - }); + console.log('GetAllKVStoreId'); + kvManager.getAllKVStoreId('apppId').then((data) => { + console.log('getAllKVStoreId success'); + console.log('size = ' + data.length); }).catch((err) => { - console.log('getKVStore err ' + JSON.stringify(err)); + console.log('getAllKVStoreId err ' + JSON.stringify(err)); }); - } catch (e) { - console.log("An unexpected error occurred. Error:" + e); + } catch(e) { + console.log('getAllKVStoreId e ' + e); } ``` ### on8+ ### -on(event: 'distributedDataServiceDie', deathCallback: Callback): void; +on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): void; -订阅设备状态变更通知，并通过callback方式返回，此方法为异步方法。 +订阅服务状态变更通知，并通过callback方式返回，此方法为同步方法。 - 参数： @@ -851,7 +903,7 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback): void;

'distributedDataServiceDie'

是

-

设备状态改变时触发的事件名。

+

服务状态改变时触发的事件名。

deathCallback

@@ -868,16 +920,14 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback): void; - 示例 ``` - let KvStore; + let kvManager; try { - it('KVManagerOn', 0, function (done) { - console.log('KVManagerOn'); - const deathCallback = function () { - console.log('death callback call'); - } - kvManager.on('distributedDataServiceDie', deathCallback); - kvManager.off('distributedDataServiceDie', deathCallback); - }); + + console.log('KVManagerOn'); + const deathCallback = function () { + console.log('death callback call'); + } + kvManager.on('distributedDataServiceDie', deathCallback); } catch (e) { console.log("An unexpected error occurred. Error:" + e); } @@ -886,9 +936,9 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback): void; ### off8+ ### -off(event: 'distributedDataServiceDie', deathCallback: Callback): void; +off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): void; -取消订阅设备状态变更通知，并通过callback方式返回，此方法为异步方法。 +取消订阅服务状态变更通知，并通过callback方式返回，此方法为同步方法。 - 参数： @@ -907,14 +957,14 @@ off(event: 'distributedDataServiceDie', deathCallback: Callback): void;

'distributedDataServiceDie'

是

-

设备状态改变时触发的事件名。

+

服务状态改变时触发的事件名。

deathCallback

Callback<void>

-

是

+

否

回调函数，取消设备状态改变时获取通知。

@@ -924,18 +974,17 @@ off(event: 'distributedDataServiceDie', deathCallback: Callback): void; - 示例 ``` - let KvStore; + let kvManager; try { - it('KVManagerOff', 0, function (done) { - console.log('KVManagerOff'); - const deathCallback = function () { - console.log('death callback call'); - } - kvManager.off('distributedDataServiceDie', deathCallback); - }); + console.log('KVManagerOff'); + const deathCallback = function () { + console.log('death callback call'); + } + kvManager.off('distributedDataServiceDie', deathCallback); } catch (e) { console.log("An unexpected error occurred. Error:" + e); } + ``` ## Options @@ -1165,24 +1214,7 @@ KVStore常量。 ## Schema8+ ## -表示数据库架构，可以创建 Schema 对象，并在创建或打开数据库时将其放置在 Option 中。 - -### constructor ###8+ - -constructor(); - -用于创建架构实例的构造函数。 - -- 示例 - - ``` - try { - let schema = new ddm.Schema(); - schema.root = new ddm.FieldNode(); - const str = schema.constructor(); - console.log("constructor: " + str); - } catch (e) {} - ``` +表示数据库模式，可以在创建或打开数据库时创建 Schema 对象并将它们放入 Options 中。 ### toJsonString8+ ### @@ -1210,11 +1242,10 @@ toJsonString():string; - 示例 ``` + import ddm from '@ohos.data.distributedData'; try { let schema = new ddm.Schema(); const str = schema.toJsonString(); - schema.root = new ddm.FieldNode(); - const node = schema.root; console.log("schema: " + str); } catch (e) {} ``` @@ -1224,46 +1255,6 @@ toJsonString():string; 表示 Schema 实例的节点，提供定义存储在数据库中的值的方法。 -### constructor8+ ### - -constructor(name: string); - -用于创建具有指定字段的 FieldNode 实例的构造函数。 - -- 参数： - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

child

-

string

-

是

-

指定字段。

-
- -- 示例 - - ``` - try { - let node = new ddm.FieldNode("name"); - const str = node.constructor(); - console.log("constructor: " + str); - } catch (e) {} - ``` - - ### appendChild8+ ### appendChild(child: FieldNode): boolean; @@ -1313,6 +1304,7 @@ appendChild(child: FieldNode): boolean; - 示例 ``` + import ddm from '@ohos.data.distributedData'; try { let node = new ddm.FieldNode("root"); let child1 = new ddm.FieldNode("child1"); @@ -1358,10 +1350,12 @@ toJson(): string; - 示例 ``` + import ddm from '@ohos.data.distributedData'; try { let node = new ddm.FieldNode("root"); let child = new ddm.FieldNode("child"); node.appendChild(child); + console.log("appendNode " + node.toJson()); } catch (e) { console.log("ToJson " + e); } @@ -1370,7 +1364,7 @@ toJson(): string; ## KvStoreResultSet8+ ## -提供获取KvStore数据库结果集的方法，提供查询和移动数据读取位置的方法，在调用KvStoreResultSet的方法前，需要先通过DeviceKvStore 构建一个DeviceKvStore 实例。 +提供获取KvStore数据库结果集的方法，提供查询和移动数据读取位置的方法，在调用KvStoreResultSet的方法前，需要先通过KvStore 构建一个KvStore 实例。 ### getCount8+ ### @@ -1398,8 +1392,15 @@ getCount(): number; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const count = resultSet.getCount(); console.log("GetCount " + count); } catch (e) { @@ -1434,12 +1435,19 @@ getPosition(): number; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const positon = resultSet.getPosition(); console.log("getPosition " + positon); } catch (e) { - console.log("GetPosition001 fail " + e); + console.log("GetPosition fail " + e); } ``` @@ -1470,8 +1478,15 @@ moveToFirst(): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.moveToFirst(); console.log("moveToFirst " + moved); } catch (e) { @@ -1506,8 +1521,15 @@ moveToLast(): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.moveToLast(); console.log("moveToLast " + moved); } catch (e) { @@ -1542,8 +1564,15 @@ moveToNext(): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.moveToNext(); console.log("moveToNext " + moved); } catch (e) { @@ -1578,8 +1607,15 @@ moveToPrevious(): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.moveToPrevious(); console.log("moveToPrevious " + moved); } catch (e) { @@ -1636,8 +1672,15 @@ move(offset: number): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.move(); console.log("move " + moved); } catch (e) { @@ -1694,8 +1737,15 @@ moveToPosition(position: number): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.moveToPosition(); console.log("moveToPosition " + moved); } catch (e) { @@ -1730,8 +1780,15 @@ isFirst(): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.isFirst(); console.log("isFirst " + moved); } catch (e) { @@ -1766,8 +1823,15 @@ isLast(): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.isLast(); console.log("isLast " + moved); } catch (e) { @@ -1802,8 +1866,15 @@ isBeforeFirst(): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.isBeforeFirst(); console.log("isBeforeFirst " + moved); } catch (e) { @@ -1838,8 +1909,15 @@ isAfterLast(): boolean; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.isAfterLast(); console.log("isAfterLast " + moved); } catch (e) { @@ -1874,11 +1952,18 @@ getEntry(): Entry; - 示例 ``` - let KvStoreResultSet; + let kvStore; try { + let resultSet; + kvStore.getResultSet('batch_test_string_key').then((result) => { + console.log('getResultSet success'); + resultSet = result; + }).catch((err) => { + console.log('getResultSet fail ' + err); + }); const moved = resultSet.moveToNext(); const entry = resultSet.getEntry(); - console.log("getEntry " + entry); + console.log("getEntry " + JSON.stringify(entry)); } catch (e) { console.log("getEntry fail " + e); } @@ -1889,22 +1974,6 @@ getEntry(): Entry; 使用谓词表示数据库查询，提供创建Query实例、查询数据库中的数据和添加谓词的方法。 -### constructor8+ ### - -constructor(); - -用于创建查询实例的构造函数。 - -- 示例 - - ``` - try { - let query= new ddm.Query() - const str = query.constructor(); - console.log("constructor: " + str); - } catch (e) {} - ``` - ### reset8+ ### reset(): Query; @@ -1931,9 +2000,8 @@ reset(): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.equalTo("key", "value"); console.log("query is " + query.getSqlLike()); query.reset(); @@ -2002,9 +2070,8 @@ equalTo(field: string, value: number|string|boolean): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.equalTo("field", "value"); console.log("query is " + query.getSqlLike()); query = null; @@ -2071,9 +2138,8 @@ notEqualTo(field: string, value: number|string|boolean): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.notEqualTo("field", "value"); console.log("query is " + query.getSqlLike()); query = null; @@ -2140,9 +2206,8 @@ greaterThan(field: string, value: number|string|boolean): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.greaterThan("field", "value"); console.log("query is " + query.getSqlLike()); query = null; @@ -2209,9 +2274,8 @@ lessThan(field: string, value: number|string): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.lessThan("field", "value"); console.log("query is " + query.getSqlLike()); query = null; @@ -2278,9 +2342,8 @@ greaterThanOrEqualTo(field: string, value: number|string): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.greaterThanOrEqualTo("field", "value"); console.log("query is " + query.getSqlLike()); query = null; @@ -2347,9 +2410,8 @@ lessThanOrEqualTo(field: string, value: number|string): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.lessThanOrEqualTo("field", "value"); console.log("query is " + query.getSqlLike()); query = null; @@ -2408,9 +2470,8 @@ isNull(field: string): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.isNull("field"); console.log("query is " + query.getSqlLike()); query = null; @@ -2477,10 +2538,9 @@ inNumber(field: string, valueList: number[]): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); - query.inNumber("field", "valueList"); + let query = new distributedData.Query(); + query.inNumber("field", [0, 1]); console.log("query is " + query.getSqlLike()); query = null; } catch (e) { @@ -2546,10 +2606,9 @@ inString(field: string, valueList: string[]): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); - query.inString("field", "valueList"); + let query = new distributedData.Query(); + query.inString("field", ['test1', 'test2']); console.log("query is " + query.getSqlLike()); query = null; } catch (e) { @@ -2615,10 +2674,9 @@ notInNumber(field: string, valueList: number[]): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); - query.notInNumber("field", "valueList"); + let query = new distributedData.Query(); + query.notInNumber("field", [0, 1]); console.log("query is " + query.getSqlLike()); query = null; } catch (e) { @@ -2684,10 +2742,9 @@ notInString(field: string, valueList: string[]): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); - query.notInString("field", "valueList"); + let query = new distributedData.Query(); + query.notInString("field", ['test1', 'test2']); console.log("query is " + query.getSqlLike()); query = null; } catch (e) { @@ -2753,9 +2810,8 @@ like(field: string, value: string): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.like("field", "value"); console.log("query is " + query.getSqlLike()); query = null; @@ -2822,9 +2878,8 @@ unlike(field: string, value: string): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.unlike("field", "value"); console.log("query is " + query.getSqlLike()); query = null; @@ -2860,9 +2915,8 @@ and(): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.notEqualTo("field", "value1"); query.and(); query.notEqualTo("field", "value2"); @@ -2900,9 +2954,8 @@ or(): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.notEqualTo("field", "value1"); query.or(); query.notEqualTo("field", "value2"); @@ -2964,9 +3017,8 @@ orderByAsc(field: string): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.notEqualTo("field", "value"); query.orderByAsc("field"); console.log("query is " + query.getSqlLike()); @@ -3026,9 +3078,8 @@ orderByDesc(field: string): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.notEqualTo("field", "value"); query.orderByDesc("field"); console.log("query is " + query.getSqlLike()); @@ -3096,9 +3147,8 @@ limit(total: number, offset: number): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.notEqualTo("field", "value"); query.limit("total", "offset"); console.log("query is " + query.getSqlLike()); @@ -3158,9 +3208,8 @@ isNotNull(field: string): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.isNotNull("field"); console.log("query is " + query.getSqlLike()); query = null; @@ -3196,9 +3245,8 @@ beginGroup(): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.beginGroup(); query.isNotNull("field"); query.endGroup(); @@ -3236,9 +3284,8 @@ endGroup(): Query; - 示例 ``` - let Query; try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.beginGroup(); query.isNotNull("field"); query.endGroup(); @@ -3300,7 +3347,7 @@ prefixKey(prefix: string): Query; ``` try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.prefixKey("$.name"); query.prefixKey("0"); console.log("query is " + query.getSqlLike()); @@ -3361,7 +3408,7 @@ setSuggestIndex(index: string): Query; ``` try { - let query = new ddm.Query(); + let query = new distributedData.Query(); query.setSuggestIndex("$.name"); query.setSuggestIndex("0"); console.log("query is " + query.getSqlLike()); @@ -3378,7 +3425,7 @@ KVStore数据库实例，提供增加数据、删除数据和订阅数据变更 ### put -put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback): void +put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback<void>): void 添加指定类型键值对到数据库，并通过callback方式返回，此方法为异步方法。 @@ -3429,6 +3476,7 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; try { @@ -3447,7 +3495,7 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC ### put -put(key: string, value: Uint8Array | string | number | boolean): Promise +put(key: string, value: Uint8Array | string | number | boolean): Promise<void> 添加指定类型键值对到数据库，并通过Promise方式返回，此方法为异步方法。 @@ -3507,6 +3555,7 @@ put(key: string, value: Uint8Array | string | number | boolean): Promise - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; try { @@ -3523,7 +3572,7 @@ put(key: string, value: Uint8Array | string | number | boolean): Promise ### delete -delete(key: string, callback: AsyncCallback): void +delete(key: string, callback: AsyncCallback<void>): void 从数据库中删除指定键值的数据，并通过callback方式返回，此方法为异步方法。 @@ -3564,6 +3613,7 @@ delete(key: string, callback: AsyncCallback): void - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; try { @@ -3589,7 +3639,7 @@ delete(key: string, callback: AsyncCallback): void ### delete -delete(key: string): Promise +delete(key: string): Promise<void> 从数据库中删除指定键值的数据，并通过Promise方式返回，此方法为异步方法。 @@ -3638,6 +3688,7 @@ delete(key: string): Promise - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; try { @@ -3659,7 +3710,7 @@ delete(key: string): Promise ### on -on(event: 'dataChange', type: SubscribeType, observer: Callback): void +on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification>): void 订阅指定类型的数据变更通知，此方法为同步方法。 @@ -3670,6 +3721,8 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback

类型

+

必填

+

说明

@@ -3678,6 +3731,8 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback

'dataChange'

+

是

+

回调函数名称。

@@ -3685,6 +3740,8 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback

SubscribeType

+

是

+

表示订阅的类型。

@@ -3692,6 +3749,8 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback

Callback<ChangeNotification>

+

是

+

回调函数。

@@ -3701,7 +3760,8 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback -on(event: 'syncComplete', syncCallback: Callback): void +on(event: 'syncComplete', syncCallback: Callback): void

类型

+

必填

+

说明

@@ -3728,6 +3790,8 @@ on(event: 'syncComplete', syncCallback: Callback): void

'syncComplete'

+

是

+

回调函数名称。

@@ -3735,6 +3799,8 @@ on(event: 'syncComplete', syncCallback: Callback): void

Callback<Array<[string, number]>

+

是

+

回调函数。

@@ -3744,6 +3810,7 @@ on(event: 'syncComplete', syncCallback: Callback): void - 示例 ``` + let kvStore; kvStore.on('syncComplete', function (data) { console.log("syncComplete callback call data: " + data); }); @@ -3751,9 +3818,9 @@ on(event: 'syncComplete', syncCallback: Callback): void ### off8+ ### -off(event:'dataChange', observer: Callback): void; +off(event:'dataChange', observer?: Callback<ChangeNotification>): void; -取消订阅数据同步完成通知，此方法为同步方法。 +取消订阅数据变更通知，此方法为同步方法。 - 参数： @@ -3762,6 +3829,8 @@ off(event:'dataChange', observer: Callback): void;

类型

+

必填

+

说明

@@ -3770,22 +3839,38 @@ off(event:'dataChange', observer: Callback): void;

'datachange'

-

回调函数名称。

+

是

+

回调函数名称。

observer

Callback<ChangeNotification>

+

否

+

回调函数。

+- 示例 + + ``` + let kvStore; + kvStore.on('dataChange', function (data) { + console.log("syncComplete callback call data: " + data); + }); + kvStore.off('dataChange', function (data) { + console.log("syncComplete callback call data: " + data); + }); + ``` + + ### putBatch8+ ### -putBatch(entries: Entry[], callback: AsyncCallback): void; +putBatch(entries: Entry[], callback: AsyncCallback<void>): void; 批量插入键值对到KvStore数据库中，并通过callback方式返回，此方法为异步方法。 @@ -3820,28 +3905,61 @@ putBatch(entries: Entry[], callback: AsyncCallback): void; -### putBatch8+ ### - -putBatch(entries: Entry[]): Promise; - -批量插入键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。 - -- 参数： +- 示例 - - - - - - - - + ``` + let kvStore; + try { + let entries = []; + for (var i = 0; i < 10; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + console.log('entries: ' + JSON.stringify(entries)); + kvStore.putBatch(entries, async function (err,data) { + console.log('putBatch success'); + await kvStore.getEntries('batch_test_string_key', function (err,entrys) { + console.log('getEntries success'); + console.log('entrys.length: ' + entrys.length); + console.log('entrys[0]: ' + JSON.stringify(entrys[0])); + }); + }); + }catch(e) { + console.log('PutBatch e ' + e); + } + + ``` + + +### putBatch8+ ### + +putBatch(entries: Entry[]): Promise<void>; + +批量插入键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。 + +- 参数： + + +

参数名

-

类型

-

必填

-

说明

-

entries

-

Entry[]

-
+ + + + + + @@ -3866,9 +3984,44 @@ putBatch(entries: Entry[]): Promise;

参数名

+

类型

+

必填

+

说明

+

entries

+

Entry[]

+

是

表示要批量插入的键值对。
+- 示例 + + ``` + let kvStore; + try { + let entries = []; + for (var i = 0; i < 10; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + console.log('entries: ' + JSON.stringify(entries)); + kvStore.putBatch(entries).then(async (err) => { + console.log('putBatch success'); + await kvStore.getEntries('batch_test_string_key').then((entrys) => { + console.log('getEntries success'); + console.log('PutBatch ' + JSON.stringify(entries)); + }).catch((err) => { + console.log('getEntries fail ' + JSON.stringify(err)); + }); + }).catch((err) => { + console.log('putBatch fail ' + JSON.stringify(err)); + }); + }catch(e) { + console.log('PutBatch e ' + e); + } + ``` + + ### deleteBatch8+ ### -deleteBatch(keys: string[], callback: AsyncCallback): void; +deleteBatch(keys: string[], callback: AsyncCallback<void>): void; 批量删除KvStore数据库中的键值对，并通过callback方式返回，此方法为异步方法。 @@ -3903,9 +4056,41 @@ deleteBatch(keys: string[], callback: AsyncCallback): void; +- 示例 + + ``` + let kvStore; + try { + let entries = []; + let keys = []; + for (var i = 0; i < 5; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + keys.push(key + i); + } + console.log('entries: ' + JSON.stringify(entries)); + kvStore.putBatch(entries, async function (err,data) { + console.log('putBatch success'); + await kvStore.deleteBatch(keys, async function (err,data) { + console.log('deleteBatch success'); + }); + }); + }catch(e) { + console.log('DeleteBatch e ' + e); + } + ``` + + ### deleteBatch8+ ### -deleteBatch(keys: string[]): Promise; +deleteBatch(keys: string[]): Promise<void>; 批量删除键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。 @@ -3949,9 +4134,45 @@ deleteBatch(keys: string[]): Promise; +- 示例 + + ``` + let kvStore; + try { + let entries = []; + let keys = []; + for (var i = 0; i < 5; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + keys.push(key + i); + } + console.log('entries: ' + JSON.stringify(entries)); + kvStore.putBatch(entries).then(async (err) => { + console.log('putBatch success'); + await kvStore.deleteBatch(keys).then((err) => { + console.log('deleteBatch success'); + }).catch((err) => { + console.log('deleteBatch fail ' + JSON.stringify(err)); + }); + }).catch((err) => { + console.log('putBatch fail ' + JSON.stringify(err));; + }); + }catch(e) { + console.log('DeleteBatch e ' + e); + } + ``` + + ### startTransaction8+ ### -startTransaction(callback: AsyncCallback): void; +startTransaction(callback: AsyncCallback<void>): void; 启动KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 @@ -3978,9 +4199,47 @@ startTransaction(callback: AsyncCallback): void; +- 示例 + + ``` + let kvStore; + function putBatchString(len, prefix) { + let entries = []; + for (var i = 0; i < len; i++) { + var entry = { + key : prefix + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + return entries; + } + try { + var count = 0; + kvStore.on('dataChange', 0, function (data) { + console.log('startTransaction 0' + data) + count++; + }); + kvStore.startTransaction(async function (err,data) { + console.log('startTransaction success'); + let entries = putBatchString(10, 'batch_test_string_key'); + console.log('entries: ' + JSON.stringify(entries)); + await kvStore.putBatch(entries, async function (err,data) { + console.log('putBatch success'); + }); + }); + }catch(e) { + console.log('startTransaction e ' + e); + } + ``` + + ### startTransaction8+ ### -startTransaction(): Promise; +startTransaction(): Promise<void>; 启动KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 @@ -4001,9 +4260,30 @@ startTransaction(): Promise; +- 示例 + + ``` + let kvStore; + try { + var count = 0; + kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_ALL, function (data) { + console.log('startTransaction ' + JSON.stringify(data)); + count++; + }); + kvStore.startTransaction().then(async (err) => { + console.log('startTransaction success'); + }).catch((err) => { + console.log('startTransaction fail ' + JSON.stringify(err)); + }); + }catch(e) { + console.log('startTransaction e ' + e); + } + ``` + + ### commit8+ ### -commit(callback: AsyncCallback): void; +commit(callback: AsyncCallback<void>): void; 提交KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 @@ -4030,9 +4310,27 @@ commit(callback: AsyncCallback): void; +- 示例 + + ``` + let kvStore; + try { + kvStore.commit(function (err,data) { + if (err == undefined) { + console.log('commit success'); + } else { + console.log('commit fail'); + } + }); + }catch(e) { + console.log('Commit e ' + e); + } + ``` + + ### commit8+ ### -commit(): Promise; +commit(): Promise<void>; 提交KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 @@ -4053,9 +4351,25 @@ commit(): Promise; +- 示例 + + ``` + let kvStore; + try { + kvStore.commit().then(async (err) => { + console.log('commit success'); + }).catch((err) => { + console.log('commit fail ' + JSON.stringify(err)); + }); + }catch(e) { + console.log('Commit e ' + e); + } + ``` + + ### rollback8+ ### -rollback(callback: AsyncCallback): void; +rollback(callback: AsyncCallback<void>): void; 在KvStore数据库中回滚事务，并通过callback方式返回，此方法为异步方法。 @@ -4082,9 +4396,27 @@ rollback(callback: AsyncCallback): void; +- 示例 + + ``` + let kvStore; + try { + kvStore.rollback(function (err,data) { + if (err == undefined) { + console.log('commit success'); + } else { + console.log('commit fail'); + } + }); + }catch(e) { + console.log('Rollback e ' + e); + } + ``` + + ### rollback8+ ### -rollback(): Promise; +rollback(): Promise<void>; 在KvStore数据库中回滚事务，并通过Promise方式返回，此方法为异步方法。 @@ -4105,9 +4437,25 @@ rollback(): Promise; +- 示例 + + ``` + let kvStore; + try { + kvStore.rollback().then(async (err) => { + console.log('rollback success'); + }).catch((err) => { + console.log('rollback fail ' + JSON.stringify(err)); + }); + }catch(e) { + console.log('Rollback e ' + e); + } + ``` + + ### enableSync8+ ### -enableSync(enabled: boolean, callback: AsyncCallback): void; +enableSync(enabled: boolean, callback: AsyncCallback<void>): void; 设定是否开启同步，并通过callback方式返回，此方法为异步方法。 @@ -4145,9 +4493,27 @@ enableSync(enabled: boolean, callback: AsyncCallback): void; +- 示例 + + ``` + let kvStore; + try { + kvStore.enableSync(true, function (err,data) { + if (err == undefined) { + console.log('enableSync success');; + } else { + console.log('enableSync fail'); + } + }); + }catch(e) { + console.log('EnableSync e ' + e); + } + ``` + + ### enableSync8+ ### -enableSync(enabled: boolean): Promise; +enableSync(enabled: boolean): Promise<void>; 设定是否开启同步，并通过Promise方式返回，此方法为异步方法。 @@ -4193,9 +4559,25 @@ enableSync(enabled: boolean): Promise; +- 示例 + + ``` + let kvStore; + try { + kvStore.enableSync(true).then((err) => { + console.log('enableSync success'); + }).catch((err) => { + console.log('enableSync fail ' + JSON.stringify(err)); + }); + }catch(e) { + console.log('EnableSync e ' + e); + } + ``` + + ### setSyncRange8+ ### -setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback): void; +setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback<void>): void; 设置同步范围标签，并通过callback方式返回，此方法为异步方法。 @@ -4242,9 +4624,25 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: Asy +- 示例 + + ``` + let kvStore; + try { + const localLabels = ['A', 'B']; + const remoteSupportLabels = ['C', 'D']; + kvStore.setSyncRange(localLabels, remoteSupportLabels, function (err,data) { + console.log('SetSyncRange put success'); + }); + }catch(e) { + console.log('SetSyncRange e ' + e); + } + ``` + + ### setSyncRange8+ ### -setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise; +setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise<void>; 设置同步范围标签，并通过Promise方式返回，此方法为异步方法。 @@ -4299,6 +4697,24 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise +- 示例 + + ``` + let kvStore; + try { + const localLabels = ['A', 'B']; + const remoteSupportLabels = ['C', 'D']; + kvStore.setSyncRange(localLabels, remoteSupportLabels).then((err) => { + console.log('setSyncRange success'); + }).catch((err) => { + console.log('delete fail ' + err); + }); + }catch(e) { + console.log('SetSyncRange e ' + e); + } + ``` + + ## SubscribeType 描述订阅类型。 @@ -4546,11 +4962,11 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise -单版本分布式数据库，继承自KVStore，提供查询数据和同步数据的方法。在调用SingleKVStore的方法前，需要先通过getKVStore构建一个KVStore实例。 +单版本分布式数据库，继承自KVStore，提供查询数据和同步数据的方法。在调用 SingleKVStore 的方法前，需要先通过 getKVStore 构建一个 SingleKVStore 实例。 ### get -get(key: string, callback: AsyncCallback): void +get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | number>): void 获取指定键的值，并通过callback方式返回，此方法为异步方法。 @@ -4591,6 +5007,7 @@ get(key: string, callback: AsyncCallback - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; try { @@ -4612,7 +5029,7 @@ get(key: string, callback: AsyncCallback ### get -get(key: string): Promise +get(key: string): Promise<Uint8Array | string | boolean | number> 获取指定键的值，并通过Promise方式返回，此方法为异步方法。 @@ -4662,6 +5079,7 @@ get(key: string): Promise - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; try { @@ -4682,7 +5100,7 @@ get(key: string): Promise ### getEntries8+ ### -getEntries(keyPrefix: string, callback: AsyncCallback): void; +getEntries(keyPrefix: string, callback: AsyncCallback<Entry[]>): void; 获取匹配指定键前缀的所有键值对，并通过callback方式返回，此方法为异步方法。 @@ -4723,6 +5141,7 @@ getEntries(keyPrefix: string, callback: AsyncCallback): void; - 示例 ``` + let kvStore; try { let entries = []; for (var i = 0; i < 10; i++) { @@ -4730,7 +5149,7 @@ getEntries(keyPrefix: string, callback: AsyncCallback): void; var entry = { key : key + i, value : { - type : factory.ValueType.INTEGER, + type : distributedData.ValueType.INTEGER, value : 222 } } @@ -4738,11 +5157,11 @@ getEntries(keyPrefix: string, callback: AsyncCallback): void; } kvStore.putBatch(entries, async function (err,data) { console.log('putBatch success'); - kvStore.getEntries('batch_test_number_key', function (err,entrys) { + await kvStore.getEntries('batch_test_number_key', function (err,entrys) { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); console.log('entrys[0]: ' + JSON.stringify(entrys[0])); - }); + }); }); }catch(e) { console.log('PutBatch e ' + e); @@ -4752,7 +5171,7 @@ getEntries(keyPrefix: string, callback: AsyncCallback): void; ### getEntries8+ ### -getEntries(keyPrefix: string): Promise; +getEntries(keyPrefix: string): Promise<Entry[]>; 获取匹配指定键前缀的所有键值对，并通过Promise方式返回，此方法为异步方法。 @@ -4801,6 +5220,7 @@ getEntries(keyPrefix: string): Promise; - 示例 ``` + let kvStore; try { let entries = []; for (var i = 0; i < 10; i++) { @@ -4808,7 +5228,7 @@ getEntries(keyPrefix: string): Promise; var entry = { key : key + i, value : { - type : factory.ValueType.STRING, + type : distributedData.ValueType.STRING, value : 'batch_test_string_value' } } @@ -4817,7 +5237,7 @@ getEntries(keyPrefix: string): Promise; console.log('entries: ' + entries); kvStore.putBatch(entries).then(async (err) => { console.log('putBatch success'); - kvStore.getEntries('batch_test_string_key').then((entrys) => { + await kvStore.getEntries('batch_test_string_key').then((entrys) => { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); console.log('entrys[0]: ' + JSON.stringify(entrys[0])); @@ -4830,14 +5250,14 @@ getEntries(keyPrefix: string): Promise; console.log('putBatch fail ' + JSON.stringify(err)); }); }catch(e) { - console.log('PutBatch001 e ' + e); + console.log('PutBatch e ' + e); } ``` ### getEntries8+ ### -getEntries(query: Query, callback: AsyncCallback): void; +getEntries(query: Query, callback: AsyncCallback<Entry[]>): void; 获取与指定 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。 @@ -4878,6 +5298,7 @@ getEntries(query: Query, callback: AsyncCallback): void; - 示例 ``` + let kvStore; try { var arr = new Uint8Array([21,31]); let entries = []; @@ -4886,29 +5307,33 @@ getEntries(query: Query, callback: AsyncCallback): void; var entry = { key : key + i, value : { - type : factory.ValueType.BYTE_ARRAY, + type : distributedData.ValueType.BYTE_ARRAY, value : arr } } entries.push(entry); } - console.log('entries: ' + entries); + console.log('entries: ' + JSON.stringify(entries)); kvStore.putBatch(entries, async function (err,data) { console.log('putBatch success'); - kvStore.getEntries('batch_test_bool_key', function (err,entrys) { + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + await kvStore.getEntries(query, function (err,entrys) { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); + console.log('entrys[0]: ' + JSON.stringify(entrys[0])); }); }); + console.log('GetEntries success'); }catch(e) { - console.log('PutBatch e ' + e); + console.log('GetEntries e ' + e); } ``` ### getEntries8+ ### -getEntries(query: Query): Promise; +getEntries(query: Query): Promise<Entry[]>; 获取匹配指定键前缀的所有键值对，并通过Promise方式返回，此方法为异步方法。 @@ -4965,24 +5390,24 @@ getEntries(query: Query): Promise; var entry = { key : key + i, value : { - type : factory.ValueType.BYTE_ARRAY, + type : distributedData.ValueType.BYTE_ARRAY, value : arr } } entries.push(entry); } - console.log('GetEntries entries: ' + entries); + console.log('entries: ' + JSON.stringify(entries)); kvStore.putBatch(entries).then(async (err) => { - console.log('GetEntries putBatch success'); - const query = new factory.Query(); + console.log('putBatch success'); + const query = new distributedData.Query(); query.prefixKey("batch_test"); - kvStore.getEntries(query).then((entrys) => { - console.log('GetEntries getEntries success'); + await kvStore.getEntries(query).then((entrys) => { + console.log('getEntries success'); }).catch((err) => { - console.log('GetEntries getEntries fail ' + JSON.stringify(err)); + console.log('getEntries fail ' + JSON.stringify(err)); }); }).catch((err) => { - console.log('GetEntries putBatch fail ' + JSON.stringify(err)); + console.log('GetEntries putBatch fail ' + JSON.stringify(err)) }); console.log('GetEntries success'); }catch(e) { @@ -4993,7 +5418,7 @@ getEntries(query: Query): Promise; ### getResultSet8+ ### -getResultSet(keyPrefix: string, callback: AsyncCallback): void; +getResultSet(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>): void; 从 KvStore 数据库中获取具有指定前缀的结果集，并通过callback方式返回，此方法为异步方法。 @@ -5034,6 +5459,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback): void - 示例 ``` + let kvStore; try { let resultSet; let entries = []; @@ -5042,7 +5468,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback): void var entry = { key : key + i, value : { - type : factory.ValueType.STRING, + type : distributedData.ValueType.STRING, value : 'batch_test_string_value' } } @@ -5050,7 +5476,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback): void } kvStore.putBatch(entries, async function (err, data) { console.log('GetResultSet putBatch success'); - kvStore.getResultSet('batch_test_string_key', async function (err, result) { + await kvStore.getResultSet('batch_test_string_key', async function (err, result) { console.log('GetResultSet getResultSet success'); resultSet = result; kvStore.closeResultSet(resultSet, function (err, data) { @@ -5066,7 +5492,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback): void ### getResultSet8+ ### -getResultSet(keyPrefix: string): Promise; +getResultSet(keyPrefix: string): Promise<KvStoreResultSet>; 从 KvStore 数据库中获取具有指定前缀的结果集，并通过Promise方式返回，此方法为异步方法。 @@ -5115,6 +5541,7 @@ getResultSet(keyPrefix: string): Promise; - 示例 ``` + let kvStore; try { let resultSet; let entries = []; @@ -5123,14 +5550,14 @@ getResultSet(keyPrefix: string): Promise; var entry = { key : key + i, value : { - type : factory.ValueType.STRING, + type : distributedData.ValueType.STRING, value : 'batch_test_string_value' } } entries.push(entry); } kvStore.putBatch(entries).then(async (err) => { - console.log('GetResult putBatch success'); + console.log('putBatch success'); }).catch((err) => { console.log('PutBatch putBatch fail ' + JSON.stringify(err)); }); @@ -5138,14 +5565,13 @@ getResultSet(keyPrefix: string): Promise; console.log('GetResult getResultSet success'); resultSet = result; }).catch((err) => { - console.log('GetResult getResultSet fail ' + JSON.stringify(err)); + console.log('getResultSet fail ' + JSON.stringify(err)); }); kvStore.closeResultSet(resultSet).then((err) => { console.log('GetResult closeResultSet success'); }).catch((err) => { - console.log('GetResult closeResultSet fail ' + JSON.stringify(err)); + console.log('closeResultSet fail ' + JSON.stringify(err)); }); - }catch(e) { console.log('GetResult e ' + e); } @@ -5154,7 +5580,7 @@ getResultSet(keyPrefix: string): Promise; ### getResultSet8+ ### -getResultSet(query: Query, callback: AsyncCallback): void; +getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): void; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -5195,6 +5621,7 @@ getResultSet(query: Query, callback: AsyncCallback): void; - 示例 ``` + let kvStore; try { let resultSet; let entries = []; @@ -5203,7 +5630,7 @@ getResultSet(query: Query, callback: AsyncCallback): void; var entry = { key : key + i, value : { - type : factory.ValueType.STRING, + type : distributedData.ValueType.STRING, value : 'batch_test_string_value' } } @@ -5211,14 +5638,14 @@ getResultSet(query: Query, callback: AsyncCallback): void; } kvStore.putBatch(entries, async function (err, data) { console.log('putBatch success'); - kvStore.getResultSet('batch_test_string_key', async function (err, result) { + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + await kvStore.getResultSet(query, async function (err, result) { console.log('getResultSet success'); resultSet = result; - kvStore.closeResultSet(resultSet, function (err, data) { - }) }); }); - }catch(e) { + } catch(e) { console.log('GetResultSet e ' + e); } ``` @@ -5226,7 +5653,7 @@ getResultSet(query: Query, callback: AsyncCallback): void; ### getResultSet8+ ### -getResultSet(query: Query): Promise; +getResultSet(query: Query): Promise<KvStoreResultSet>; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -5275,6 +5702,7 @@ getResultSet(query: Query): Promise; - 示例 ``` + let kvStore; try { let resultSet; let entries = []; @@ -5283,7 +5711,7 @@ getResultSet(query: Query): Promise; var entry = { key : key + i, value : { - type : factory.ValueType.STRING, + type : distributedData.ValueType.STRING, value : 'batch_test_string_value' } } @@ -5292,27 +5720,24 @@ getResultSet(query: Query): Promise; kvStore.putBatch(entries).then(async (err) => { console.log('putBatch success'); }).catch((err) => { - console.log('putBatch fail ' + err); - }); - kvStore.getResultSet('batch_test_string_key').then((result) => { - console.log('getResultSet success'); - resultSet = result; - }).catch((err) => { - console.log('getResultSet fail ' + err); + console.log('putBatch fail ' + JSON.stringify(err)); }); - kvStore.closeResultSet(resultSet).then((err) => { - console.log('closeResultSet success'); + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + kvStore.getResultSet(query).then((result) => { + console.log(' getResultSet success'); + resultSet = result; }).catch((err) => { - console.log('closeResultSet fail ' + err); + console.log('getResultSet fail ' + JSON.stringify(err)); }); }catch(e) { - console.log('ResultSet e ' + e); + console.log('GetResultSet e ' + e); } ``` ### closeResultSet8+ ### -closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback): void; +closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>): void; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -5353,8 +5778,8 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback): void - 示例 ``` + let kvStore; try { - console.log('CloseResultSet success'); let resultSet = null; kvStore.closeResultSet(resultSet, function (err, data) { if (err == undefined) { @@ -5371,7 +5796,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback): void ### closeResultSet8+ ### -closeResultSet(resultSet: KvStoreResultSet): Promise; +closeResultSet(resultSet: KvStoreResultSet): Promise<void>; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -5420,8 +5845,8 @@ closeResultSet(resultSet: KvStoreResultSet): Promise; - 示例 ``` + let kvStore; try { - console.log('CloseResultSet success'); let resultSet = null; kvStore.closeResultSet(resultSet).then(() => { console.log('closeResultSet success'); @@ -5436,7 +5861,7 @@ closeResultSet(resultSet: KvStoreResultSet): Promise; ### getResultSize8+ ### -getResultSize(query: Query, callback: AsyncCallback): void; +getResultSize(query: Query, callback: AsyncCallback<number>): void; 获取与指定 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。 @@ -5477,10 +5902,29 @@ getResultSize(query: Query, callback: AsyncCallback): void; - 示例 ``` + let kvStore; try { - // pass query - console.log('GetResultSize success'); - }catch(e) { + let entries = []; + for (var i = 0; i < 10; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + kvStore.putBatch(entries, async function (err, data) { + console.log('putBatch success'); + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + await kvStore.getResultSize(query, async function (err, resultSize) { + console.log('getResultSet success'); + }); + }); + } catch(e) { console.log('GetResultSize e ' + e); } ``` @@ -5488,7 +5932,7 @@ getResultSize(query: Query, callback: AsyncCallback): void; ### getResultSize8+ ### -getResultSize(query: Query): Promise; +getResultSize(query: Query): Promise<number>; 获取与指定 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。 @@ -5537,9 +5981,32 @@ getResultSize(query: Query): Promise; - 示例 ``` + let kvStore; try { - // pass query - console.log('GetResultSize success'); + let entries = []; + for (var i = 0; i < 10; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + kvStore.putBatch(entries).then(async (err) => { + console.log('putBatch success'); + }).catch((err) => { + console.log('putBatch fail ' + JSON.stringify(err)); + }); + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + kvStore.getResultSize(query).then((resultSize) => { + console.log('getResultSet success'); + }).catch((err) => { + console.log('getResultSet fail ' + JSON.stringify(err)); + }); }catch(e) { console.log('GetResultSize e ' + e); } @@ -5548,7 +6015,7 @@ getResultSize(query: Query): Promise; ### removeDeviceData8+ ### -removeDeviceData(deviceId: string, callback: AsyncCallback): void; +removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void; 删除指定设备的数据，并通过callback方式返回，此方法为异步方法。 @@ -5589,18 +6056,19 @@ removeDeviceData(deviceId: string, callback: AsyncCallback): void; - 示例 ``` - const KEY_TEST_FLOAT_ELEMENT = 'key_test_float_2'; + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string_2'; + const VALUE_TEST_STRING_ELEMENT = 'value-string-002'; try { kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, async function (err,data) { console.log('put success'); const deviceid = 'no_exist_device_id'; - kvStore.removeDeviceData(deviceid, async function (err,data) { + await kvStore.removeDeviceData(deviceid, async function (err,data) { if (err == undefined) { console.log('removeDeviceData success'); } else { console.log('removeDeviceData fail'); - kvStore.get(KEY_TEST_STRING_ELEMENT, async function (err,data) { + await kvStore.get(KEY_TEST_STRING_ELEMENT, async function (err,data) { console.log('RemoveDeviceData get success'); }); } @@ -5614,7 +6082,7 @@ removeDeviceData(deviceId: string, callback: AsyncCallback): void; ### removeDeviceData8+ ### -removeDeviceData(deviceId: string): Promise; +removeDeviceData(deviceId: string): Promise<void>; 删除指定设备的数据，并通过Promise方式返回，此方法为异步方法。 @@ -5663,6 +6131,7 @@ removeDeviceData(deviceId: string): Promise; - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string_2'; const VALUE_TEST_STRING_ELEMENT = 'value-string-001'; try { @@ -5690,9 +6159,9 @@ removeDeviceData(deviceId: string): Promise; ### on8+ ### -on(event: 'syncComplete', syncCallback: Callback): void; +on(event: 'syncComplete', syncCallback: Callback): void;

是

-

设备状态改变时触发的事件名。

+

同步完成时触发的事件名。

syncCallback

@@ -5731,28 +6200,29 @@ on(event: 'syncComplete', syncCallback: Callback): void; - 示例 ``` + let kvStore; const KEY_TEST_FLOAT_ELEMENT = 'key_test_float'; const VALUE_TEST_FLOAT_ELEMENT = 321.12; try { - kvStore.on('dataChange', 0, function (data) { - console.log('OnChange 0' + data) + kvStore.on('syncComplete', function (data) { + console.log('syncComplete ' + data) }); kvStore.put(KEY_TEST_FLOAT_ELEMENT, VALUE_TEST_FLOAT_ELEMENT).then((data) => { - console.log('OnChange put success'); + console.log('syncComplete put success'); }).catch((error) => { - console.log('OnChange put fail ' + error); + console.log('syncComplete put fail ' + error); }); }catch(e) { - console.log('OnChange put e ' + e); + console.log('syncComplete put e ' + e); } ``` ### off8+ ### -off(event: 'syncComplete', syncCallback: Callback): void; +off(event: 'syncComplete', syncCallback?: Callback): void

是

-

设备状态改变时触发的事件名。

+

同步完成时触发的事件名。

syncCallback

Callback<Array<[string, number]>

-

是

+

否

用于向调用方发送同步结果的回调。

@@ -5791,14 +6261,15 @@ off(event: 'syncComplete', syncCallback: Callback): void - 示例 ``` + let kvStore; try { const func = function (data) { - console.log('OffChange 0' + data) + console.log('syncComplete ' + data) }; - kvStore.on('dataChange', 0, func); - kvStore.off('dataChange', func); + kvStore.on('syncComplete', func); + kvStore.off('syncComplete', func); }catch(e) { - console.log('OffChange e ' + e); + console.log('syncComplete e ' + e); } ``` @@ -5807,7 +6278,7 @@ off(event: 'syncComplete', syncCallback: Callback): void sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void -在手动同步模式下，触发数据库同步，此方法为同步方法。 +在手动模式下，触发数据库同步，此方法为同步方法。 - 参数： @@ -5855,14 +6326,15 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void - 示例： ``` - kvStore.sync('deviceIds', 1, 1000); + let kvStore; + kvStore.sync('deviceIds', distributedData.SyncMode.PULL_ONLY, 1000); ``` ### setSyncParam8+ ### -setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback): void; +setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback<void>): void; -设置允许数据库同步的默认延迟,并通过callback方式返回，此方法为异步方法。 +设置允许数据库同步的默认延迟，并通过callback方式返回，此方法为异步方法。 - 参数： @@ -5901,22 +6373,23 @@ setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback): void - 示例 ``` + let kvStore; try { const defaultAllowedDelayMs = 500; kvStore.setSyncParam(defaultAllowedDelayMs, function (err,data) { console.log('SetSyncParam put success'); }); }catch(e) { - console.log('testSingleKvStoreSetSyncParam101 e ' + e); + console.log('testSingleKvStoreSetSyncParam e ' + e); } ``` ### setSyncParam8+ ### -setSyncParam(defaultAllowedDelayMs: number): Promise; +setSyncParam(defaultAllowedDelayMs: number): Promise<void>; -设置允许数据库同步的默认延迟,并通过Promise方式返回，此方法为异步方法。 +设置允许数据库同步的默认延迟，并通过Promise方式返回，此方法为异步方法。 - 参数： @@ -5963,6 +6436,7 @@ setSyncParam(defaultAllowedDelayMs: number): Promise; - 示例 ``` + let kvStore; try { const defaultAllowedDelayMs = 500; kvStore.setSyncParam(defaultAllowedDelayMs).then((err) => { @@ -5978,7 +6452,7 @@ setSyncParam(defaultAllowedDelayMs: number): Promise; ### getSecurityLevel8+ ### -getSecurityLevel(callback: AsyncCallback): void; +getSecurityLevel(callback: AsyncCallback<SecurityLevel>): void; 获取数据库的安全级别，并通过callback方式返回，此方法为异步方法。 @@ -6010,6 +6484,7 @@ getSecurityLevel(callback: AsyncCallback): void; - 示例 ``` + let kvStore; try { kvStore.getSecurityLevel(function (err,data) { console.log('getSecurityLevel success'); @@ -6022,7 +6497,7 @@ getSecurityLevel(callback: AsyncCallback): void; ### getSecurityLevel8+ ### -getSecurityLevel(): Promise; +getSecurityLevel(): Promise<SecurityLevel>; 获取数据库的安全级别，并通过Promise方式返回，此方法为异步方法。 @@ -6046,6 +6521,7 @@ getSecurityLevel(): Promise; - 示例 ``` + let kvStore; try { kvStore.getSecurityLevel().then((data) => { console.log(' getSecurityLevel success'); @@ -6060,13 +6536,13 @@ getSecurityLevel(): Promise; ## DeviceKVStore8+ ## -在分布式系统中通过设备管理分布式数据，继承自KvStore，提供查询数据和同步数据的方法。在调用DeviceKVStore的方法前，需要先通过getKVStore构建一个KVStore实例。 +在分布式系统中按设备管理分布式数据，继承自KvStore，提供查询数据和同步数据的方法。在调用DeviceKVStore的方法前，需要先通过getKVStore构建一个DeviceKVStore实例。 ### get8+ ### -get(deviceId: string, key: string, callback: AsyncCallback): void; +get(deviceId: string, key: string, callback: AsyncCallback<boolean|string|number|Uint8Array>): void; -获取与指定设备 ID 和密钥匹配的 String 值，并通过callback方式返回，此方法为异步方法。 +获取与指定设备 ID 和 key 匹配的 String 值，并通过callback方式返回，此方法为异步方法。 - 参数： @@ -6096,7 +6572,7 @@ get(deviceId: string, key: string, callback: AsyncCallback

是

-

表示要查询的String值的键。

+

表示要查询 key 值的键。

callback

@@ -6114,6 +6590,7 @@ get(deviceId: string, key: string, callback: AsyncCallback8+ ### -get(deviceId: string, key: string): Promise; +get(deviceId: string, key: string): Promise<boolean|string|number|Uint8Array>; -获取与指定设备 ID 和密钥匹配的 String 值，并通过Promise方式返回，此方法为异步方法。 +获取与指定设备 ID 和 key 匹配的 String 值，并通过Promise方式返回，此方法为异步方法。 - 参数： @@ -6163,7 +6640,7 @@ get(deviceId: string, key: string): Promise;

是

-

表示要查询的String值的键。

+

表示要查询的 key 值的键。

@@ -6189,6 +6666,7 @@ get(deviceId: string, key: string): Promise; - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string_2'; const VALUE_TEST_STRING_ELEMENT = 'value-string-002'; try { @@ -6210,9 +6688,9 @@ get(deviceId: string, key: string): Promise; ### getEntries8+ ### -getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback): void; +getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry[]>): void; -获取与指定设备 ID 和密钥前缀匹配的所有键值对，并通过callback方式返回，此方法为异步方法。 +获取与指定设备 ID 和 key 前缀匹配的所有键值对，并通过callback方式返回，此方法为异步方法。 - 参数： @@ -6260,6 +6738,7 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback - 示例 ``` + let kvStore; try { let entries = []; for (var i = 0; i < 10; i++) { @@ -6267,7 +6746,7 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback var entry = { key : key + i, value : { - type : factory.ValueType.STRING, + type : distributedData.ValueType.STRING, value : 'batch_test_string_value' } } @@ -6276,7 +6755,7 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback console.log('entries: ' + entries); kvStore.putBatch(entries, async function (err,data) { console.log('putBatch success'); - kvStore.getEntries('localDeviceId', 'batch_test_string_key', function (err,entrys) { + await kvStore.getEntries('localDeviceId', 'batch_test_string_key', function (err,entrys) { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); console.log('entrys[0]: ' + JSON.stringify(entrys[0])); @@ -6290,9 +6769,9 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback ### getEntries8+ ### -getEntries(deviceId: string, keyPrefix: string): Promise; +getEntries(deviceId: string, keyPrefix: string): Promise<Entry[]>; -获取与指定设备 ID 和密钥前缀匹配的所有键值对，并通过Promise方式返回，此方法为异步方法。 +获取与指定设备 ID 和 key 前缀匹配的所有键值对，并通过Promise方式返回，此方法为异步方法。 - 参数： @@ -6348,6 +6827,7 @@ getEntries(deviceId: string, keyPrefix: string): Promise; - 示例 ``` + let kvStore; try { let entries = []; for (var i = 0; i < 10; i++) { @@ -6355,16 +6835,16 @@ getEntries(deviceId: string, keyPrefix: string): Promise; var entry = { key : key + i, value : { - type : factory.ValueType.STRING, + type : distributedData.ValueType.STRING, value : 'batch_test_string_value' } } entries.push(entry); } console.log('entries: ' + entries); - kvStore.putBatch(entries).then(async (err) => { + kvStore.putBatch(entries).then(async (err) => { console.log('putBatch success'); - kvStore.getEntries('localDeviceId', 'batch_test_string_key').then((entrys) => { + await kvStore.getEntries('localDeviceId', 'batch_test_string_key').then((entrys) => { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); console.log('entrys[0]: ' + JSON.stringify(entrys[0])); @@ -6384,7 +6864,7 @@ getEntries(deviceId: string, keyPrefix: string): Promise; ### getEntries8+ ### -getEntries(query: Query, callback: AsyncCallback): void; +getEntries(query: Query, callback: AsyncCallback<Entry[]>): void; 获取与指定 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。 @@ -6425,6 +6905,7 @@ getEntries(query: Query, callback: AsyncCallback): void; - 示例 ``` + let kvStore; try { var arr = new Uint8Array([21,31]); let entries = []; @@ -6433,29 +6914,35 @@ getEntries(query: Query, callback: AsyncCallback): void; var entry = { key : key + i, value : { - type : factory.ValueType.BYTE_ARRAY, + type : distributedData.ValueType.BYTE_ARRAY, value : arr } } entries.push(entry); } - console.log('entries: ' + entries); + console.log('entries: ' + JSON.stringify(entries)); kvStore.putBatch(entries, async function (err,data) { console.log('putBatch success'); - kvStore.getEntries('localDeviceId', 'batch_test_bool_key', function (err,entrys) { + expect(err == undefined).assertTrue(); + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + query.deviceId('localDeviceId'); + await kvStore.getEntries(query, function (err,entrys) { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); + console.log('entrys[0]: ' + JSON.stringify(entrys[0])); }); }); + console.log('GetEntries success'); }catch(e) { - console.log('PutBatch e ' + e); + console.log('GetEntries e ' + e); } ``` ### getEntries8+ ### -getEntries(query: Query): Promise; +getEntries(query: Query): Promise<Entry[]>; 获取与指定 Query 对象匹配的键值对列表，并通过Promise方式返回，此方法为异步方法。 @@ -6504,6 +6991,7 @@ getEntries(query: Query): Promise; - 示例 ``` + let kvStore; try { var arr = new Uint8Array([21,31]); let entries = []; @@ -6512,32 +7000,35 @@ getEntries(query: Query): Promise; var entry = { key : key + i, value : { - type : factory.ValueType.BYTE_ARRAY, + type : distributedData.ValueType.BYTE_ARRAY, value : arr } } entries.push(entry); } - console.log('entries: ' + entries); + console.log('entries: ' + JSON.stringify(entries)); kvStore.putBatch(entries).then(async (err) => { console.log('putBatch success'); - kvStore.getEntries('localDeviceId', 'batch_test_bool_key').then((entrys) => { + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + await kvStore.getEntries(query).then((entrys) => { console.log('getEntries success'); }).catch((err) => { console.log('getEntries fail ' + JSON.stringify(err)); }); }).catch((err) => { - console.log('putBatch fail ' + JSON.stringify(err)); + console.log('GetEntries putBatch fail ' + JSON.stringify(err)) }); + console.log('GetEntries success'); }catch(e) { - console.log('PutBatch e ' + e); + console.log('GetEntries e ' + e); } ``` ### getEntries8+ ### -getEntries(deviceId: string, query: Query, callback: AsyncCallback): void; +getEntries(deviceId: string, query: Query, callback: AsyncCallback<Entry[]>): void; 获取与指定设备 ID 和 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。 @@ -6587,6 +7078,7 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback): vo - 示例 ``` + let kvStore; try { var arr = new Uint8Array([21,31]); let entries = []; @@ -6595,29 +7087,35 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback): vo var entry = { key : key + i, value : { - type : factory.ValueType.BYTE_ARRAY, + type : distributedData.ValueType.BYTE_ARRAY, value : arr } } entries.push(entry); } - console.log('entries: ' + entries); + console.log('entries: ' + JSON.stringify(entries)); kvStore.putBatch(entries, async function (err,data) { console.log('putBatch success'); - kvStore.getEntries('localDeviceId', 'batch_test_bool_key', function (err,entrys) { + expect(err == undefined).assertTrue(); + var query = new distributedData.Query(); + query.deviceId('localDeviceId'); + query.prefixKey("batch_test"); + await kvStore.getEntries('localDeviceId', query, function (err,entrys) { console.log('getEntries success'); console.log('entrys.length: ' + entrys.length); - }); + console.log('entrys[0]: ' + JSON.stringify(entrys[0])); + }) }); + console.log('GetEntries success'); }catch(e) { - console.log('PutBatch e ' + e); + console.log('GetEntries e ' + e); } ``` ### getEntries8+ ### -getEntries(deviceId: string, query: Query): Promise; +getEntries(deviceId: string, query: Query): Promise<Entry[]>; 获取与指定设备 ID 和 Query 对象匹配的键值对列表，并通过Promise方式返回，此方法为异步方法。 @@ -6675,6 +7173,7 @@ getEntries(deviceId: string, query: Query): Promise; - 示例 ``` + let kvStore; try { var arr = new Uint8Array([21,31]); let entries = []; @@ -6683,16 +7182,19 @@ getEntries(deviceId: string, query: Query): Promise; var entry = { key : key + i, value : { - type : factory.ValueType.BYTE_ARRAY, + type : distributedData.ValueType.BYTE_ARRAY, value : arr } } entries.push(entry); } - console.log('entries: ' + entries); + console.log('entries: ' + JSON.stringify(entries)); kvStore.putBatch(entries).then(async (err) => { console.log('putBatch success'); - kvStore.getEntries('localDeviceId', 'batch_test_bool_key').then((entrys) => { + var query = new distributedData.Query(); + query.deviceId('localDeviceId'); + query.prefixKey("batch_test"); + await kvStore.getEntries('localDeviceId', query).then((entrys) => { console.log('getEntries success'); }).catch((err) => { console.log('getEntries fail ' + JSON.stringify(err)); @@ -6700,17 +7202,18 @@ getEntries(deviceId: string, query: Query): Promise; }).catch((err) => { console.log('putBatch fail ' + JSON.stringify(err)); }); + console.log('GetEntries success'); }catch(e) { - console.log('PutBatch e ' + e); + console.log('GetEntries e ' + e); } ``` ### getResultSet8+ ### -getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback): void; +getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>): void; -获取与指定设备 ID 和密钥前缀匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 +获取与指定设备 ID 和　key 前缀匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 - 参数： @@ -6758,12 +7261,13 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback8+ ### -getResultSet(deviceId: string, keyPrefix: string): Promise; +getResultSet(deviceId: string, keyPrefix: string): Promise<KvStoreResultSet>; -获取与指定设备 ID 和密钥前缀匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 +获取与指定设备 ID 和 key 前缀匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 - 参数： @@ -6833,6 +7337,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise; - 示例 ``` + let kvStore; try { let resultSet; kvStore.getResultSet('localDeviceId', 'batch_test_string_key').then((result) => { @@ -6854,7 +7359,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise; ### getResultSet8+ ### -getResultSet(query: Query, callback: AsyncCallback): void; +getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): void; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -6895,12 +7400,35 @@ getResultSet(query: Query, callback: AsyncCallback): void; - 示例 ``` + let kvStore; try { let resultSet; - kvStore.getResultSet(function (err, result) { - console.log('getResultSet success'); + let entries = []; + for (var i = 0; i < 10; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + kvStore.putBatch(entries, async function (err, data) { + console.log('putBatch success'); + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + query.deviceId('localDeviceId'); + await kvStore.getResultSet(query, async function (err, result) { + console.log('getResultSet success'); + resultSet = result; + await kvStore.closeResultSet(resultSet, function (err, data) { + console.log('closeResultSet success'); + }) + }); }); - }catch(e) { + } catch(e) { console.log('GetResultSet e ' + e); } ``` @@ -6908,7 +7436,7 @@ getResultSet(query: Query, callback: AsyncCallback): void; ### getResultSet8+ ### -getResultSet(query: Query): Promise; +getResultSet(query: Query): Promise<KvStoreResultSet>; 获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -6957,6 +7485,7 @@ getResultSet(query: Query): Promise; - 示例 ``` + let kvStore; try { let resultSet; let entries = []; @@ -6965,31 +7494,31 @@ getResultSet(query: Query): Promise; var entry = { key : key + i, value : { - type : factory.ValueType.STRING, + type : distributedData.ValueType.STRING, value : 'batch_test_string_value' } } entries.push(entry); } kvStore.putBatch(entries).then(async (err) => { - console.log('GetResultSet putBatch success'); + console.log('putBatch success'); }).catch((err) => { - console.log('PutBatch putBatch fail ' + JSON.stringify(err)); + console.log('putBatch fail ' + err); }); - const query = new factory.Query(); + const query = new distributedData.Query(); query.deviceId('localDeviceId'); query.prefixKey("batch_test"); console.log("GetResultSet " + query.getSqlLike()); kvStore.getResultSet(query).then((result) => { - console.log('GetResultSet getResultSet success'); + console.log('getResultSet success'); resultSet = result; }).catch((err) => { - console.log('GetResultSet getResultSet fail ' + JSON.stringify(err)); + console.log('getResultSet fail ' + JSON.stringify(err)); }); kvStore.closeResultSet(resultSet).then((err) => { - console.log('GetResultSet closeResultSet success'); + console.log('closeResultSet success'); }).catch((err) => { - console.log('GetResultSet closeResultSet fail ' + JSON.stringify(err)); + console.log('closeResultSet fail ' + JSON.stringify(err)); }); }catch(e) { console.log('GetResultSet e ' + e); @@ -6999,7 +7528,7 @@ getResultSet(query: Query): Promise; ### getResultSet8+ ### -getResultSet(deviceId: string, query: Query, callback: AsyncCallback): void; +getResultSet(deviceId: string, query: Query, callback: AsyncCallback<KvStoreResultSet>): void; 获取与指定设备ID和Query对象匹配的KvStoreResultSet对象，并通过callback方式返回，此方法为异步方法。 @@ -7049,12 +7578,34 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback8+ ### -getResultSet(deviceId: string, query: Query): Promise; +getResultSet(deviceId: string, query: Query): Promise<KvStoreResultSet>; 获取与指定设备ID和Query对象匹配的KvStoreResultSet对象，并通过Promise方式返回，此方法为异步方法。 @@ -7120,6 +7671,7 @@ getResultSet(deviceId: string, query: Query): Promise; - 示例 ``` + let kvStore; try { let resultSet; let entries = []; @@ -7128,7 +7680,7 @@ getResultSet(deviceId: string, query: Query): Promise; var entry = { key : key + i, value : { - type : factory.ValueType.STRING, + type : distributedData.ValueType.STRING, value : 'batch_test_string_value' } } @@ -7139,7 +7691,7 @@ getResultSet(deviceId: string, query: Query): Promise; }).catch((err) => { console.log('PutBatch putBatch fail ' + JSON.stringify(err)); }); - const query = new factory.Query(); + const query = new distributedData.Query(); query.prefixKey("batch_test"); kvStore.getResultSet('localDeviceId', query).then((result) => { console.log('GetResultSet getResultSet success'); @@ -7163,7 +7715,7 @@ getResultSet(deviceId: string, query: Query): Promise; ### closeResultSet8+ ### -closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback): void; +closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>): void; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。 @@ -7204,6 +7756,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback): void - 示例 ``` + let kvStore; try { console.log('CloseResultSet success'); let resultSet = null; @@ -7222,7 +7775,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback): void ### closeResultSet8+ ### -closeResultSet(resultSet: KvStoreResultSet): Promise; +closeResultSet(resultSet: KvStoreResultSet): Promise<void>; 关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。 @@ -7271,6 +7824,7 @@ closeResultSet(resultSet: KvStoreResultSet): Promise; - 示例 ``` + let kvStore; try { console.log('CloseResultSet success'); let resultSet = null; @@ -7287,7 +7841,7 @@ closeResultSet(resultSet: KvStoreResultSet): Promise; ### getResultSize8+ ### -getResultSize(query: Query, callback: AsyncCallback): void; +getResultSize(query: Query, callback: AsyncCallback<number>): void; 获取与指定 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。 @@ -7328,10 +7882,30 @@ getResultSize(query: Query, callback: AsyncCallback): void; - 示例 ``` + let kvStore; try { - // pass query - console.log('GetResultSize success'); - }catch(e) { + let entries = []; + for (var i = 0; i < 10; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + kvStore.putBatch(entries, async function (err, data) { + console.log('putBatch success'); + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + query.deviceId('localDeviceId'); + await kvStore.getResultSize(query, async function (err, resultSize) { + console.log('getResultSet success'); + }); + }); + } catch(e) { console.log('GetResultSize e ' + e); } ``` @@ -7339,7 +7913,7 @@ getResultSize(query: Query, callback: AsyncCallback): void; ### getResultSize8+ ### -getResultSize(query: Query): Promise; +getResultSize(query: Query): Promise<number>; 获取与指定 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。 @@ -7388,9 +7962,33 @@ getResultSize(query: Query): Promise; - 示例 ``` + let kvStore; try { - // pass query - console.log('GetResultSize success'); + let entries = []; + for (var i = 0; i < 10; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + kvStore.putBatch(entries).then(async (err) => { + console.log('putBatch success'); + }).catch((err) => { + console.log('putBatch fail ' + JSON.stringify(err)); + }); + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + query.deviceId('localDeviceId'); + kvStore.getResultSize(query).then((resultSize) => { + console.log('getResultSet success'); + }).catch((err) => { + console.log('getResultSet fail ' + JSON.stringify(err)); + }); }catch(e) { console.log('GetResultSize e ' + e); } @@ -7399,7 +7997,7 @@ getResultSize(query: Query): Promise; ### getResultSize8+ ### -getResultSize(deviceId: string, query: Query, callback: AsyncCallback): void; +getResultSize(deviceId: string, query: Query, callback: AsyncCallback<number>): void; 获取与指定设备 ID 和 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。 @@ -7449,10 +8047,29 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback): - 示例 ``` + let kvStore; try { - // pass query - console.log('GetResultSize success'); - }catch(e) { + let entries = []; + for (var i = 0; i < 10; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + kvStore.putBatch(entries, async function (err, data) { + console.log('putBatch success'); + const query = new distributedData.Query(); + query.prefixKey("batch_test"); + await kvStore.getResultSize('localDeviceId', query, async function (err, resultSize) { + console.log('getResultSet success'); + }); + }); + } catch(e) { console.log('GetResultSize e ' + e); } ``` @@ -7460,7 +8077,7 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback): ### getResultSize8+ ### -getResultSize(deviceId: string, query: Query): Promise; +getResultSize(deviceId: string, query: Query): Promise<number>; 获取与指定设备 ID 和 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。 @@ -7518,9 +8135,32 @@ getResultSize(deviceId: string, query: Query): Promise; - 示例 ``` + let kvStore; try { - // pass query - console.log('GetResultSize success'); + let entries = []; + for (var i = 0; i < 10; i++) { + var key = 'batch_test_string_key'; + var entry = { + key : key + i, + value : { + type : distributedData.ValueType.STRING, + value : 'batch_test_string_value' + } + } + entries.push(entry); + } + kvStore.putBatch(entries).then(async (err) => { + console.log('putBatch success'); + }).catch((err) => { + console.log('putBatch fail ' + JSON.stringify(err)); + }); + var query = new distributedData.Query(); + query.prefixKey("batch_test"); + kvStore.getResultSize('localDeviceId', query).then((resultSize) => { + console.log('getResultSet success'); + }).catch((err) => { + console.log('getResultSet fail ' + JSON.stringify(err)); + }); }catch(e) { console.log('GetResultSize e ' + e); } @@ -7529,7 +8169,7 @@ getResultSize(deviceId: string, query: Query): Promise; ### removeDeviceData8+ ### -removeDeviceData(deviceId: string, callback: AsyncCallback): void; +removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void; 从当前数据库中删除指定设备的数据，并通过callback方式返回，此方法为异步方法。 @@ -7570,32 +8210,33 @@ removeDeviceData(deviceId: string, callback: AsyncCallback): void; - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-string-001'; try { kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, async function (err,data) { console.log('RemoveDeviceData put success'); const deviceid = 'no_exist_device_id'; - kvStore.removeDeviceData(deviceid, async function (err,data) { + await kvStore.removeDeviceData(deviceid, async function (err,data) { if (err == undefined) { console.log('removeDeviceData success'); } else { - console.log('testDeviceKvStoreRemoveDeviceData101 removeDeviceData fail'); - kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT, async function (err,data) { + console.log('removeDeviceData fail'); + await kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT, async function (err,data) { console.log('RemoveDeviceData get success'); }); } }); }); }catch(e) { - console.log('testDeviceKvStoreRemoveDeviceData101 e ' + e); + console.log('RemoveDeviceData e ' + e); } ``` ### removeDeviceData8+ ### -removeDeviceData(deviceId: string): Promise; +removeDeviceData(deviceId: string): Promise<void>; 从当前数据库中删除指定设备的数据，并通过Promise方式返回，此方法为异步方法。 @@ -7644,6 +8285,7 @@ removeDeviceData(deviceId: string): Promise; - 示例 ``` + let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-string-001'; try { @@ -7652,20 +8294,17 @@ removeDeviceData(deviceId: string): Promise; }).catch((err) => { console.log('RemoveDeviceData put fail ' + JSON.stringify(err)); }); - const deviceid = 'no_exist_device_id'; kvStore.removeDeviceData(deviceid).then((err) => { - console.log('RemoveDeviceData removeDeviceData success'); + console.log('removeDeviceData success'); }).catch((err) => { - console.log('RemoveDeviceData removeDeviceData fail ' + JSON.stringify(err)); + console.log('removeDeviceData fail ' + JSON.stringify(err)); }); - kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT).then((data) => { console.log('RemoveDeviceData get success data:' + data); }).catch((err) => { console.log('RemoveDeviceData get fail ' + JSON.stringify(err)); }); - }catch(e) { console.log('RemoveDeviceData e ' + e); } @@ -7676,7 +8315,7 @@ removeDeviceData(deviceId: string): Promise; sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void; -同步 DeviceKvStore 数据库，该方法为异步方法。 +在手动模式下，触发数据库同步，此方法为同步方法。 - 参数： @@ -7724,6 +8363,7 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void; - 示例 ``` + let kvStore; const KEY_TEST_SYNC_ELEMENT = 'key_test_sync'; const VALUE_TEST_SYNC_ELEMENT = 'value-string-001'; try { @@ -7732,8 +8372,8 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void; }); kvStore.put(KEY_TEST_SYNC_ELEMENT + 'testSync101', VALUE_TEST_SYNC_ELEMENT, function (err,data) { console.log('Sync put success'); - const devices = ['A12C1F9261528B21F95778D2FDC0B2E33943E6251AC5487F4473D005758905DB']; - const mode = factory.SyncMode.PULL_ONLY; + const devices = ['deviceList']; + const mode = distributedData.SyncMode.PULL_ONLY; kvStore.sync(devices, mode); }); }catch(e) { @@ -7743,9 +8383,9 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void; ### on8+ ### -on(event: 'syncComplete', syncCallback: Callback): void; +on(event: 'syncComplete', syncCallback: Callback): void;

是

-

设备状态改变时触发的事件名。

+

同步完成时触发的事件名。

syncCallback

@@ -7782,30 +8422,29 @@ on(event: 'syncComplete', syncCallback: Callback): void; - 示例 - ``` const KEY_TEST_FLOAT_ELEMENT = 'key_test_float'; const VALUE_TEST_FLOAT_ELEMENT = 321.12; try { - kvStore.on('dataChange', 0, function (data) { - console.log('OnChange 0' + data) + kvStore.on('syncComplete', function (data) { + console.log('syncComplete ' + data) }); kvStore.put(KEY_TEST_FLOAT_ELEMENT, VALUE_TEST_FLOAT_ELEMENT).then((data) => { - console.log('OnChange put success'); + console.log('syncComplete put success'); }).catch((error) => { - console.log('OnChange put fail ' + error); + console.log('syncComplete put fail ' + error); }); }catch(e) { - console.log('OnChange put e ' + e); + console.log('syncComplete put e ' + e); } ``` ### off8+ ### -off(event: 'syncComplete', syncCallback: Callback): void; +off(event: 'syncComplete', syncCallback?: Callback): void

是

-

设备状态改变时触发的事件名。

+

同步完成时触发的事件名。

syncCallback

Callback<Array<[string, number]>

-

是

+

否

用于向调用方发送同步结果的回调。

@@ -7844,14 +8483,15 @@ off(event: 'syncComplete', syncCallback: Callback): void - 示例 ``` + let kvStore; try { const func = function (data) { - console.log('OffChange 0' + data) + console.log('syncComplete ' + data) }; - kvStore.on('dataChange', 0, func); - kvStore.off('dataChange', func); + kvStore.on('syncComplete', func); + kvStore.off('syncComplete', func); }catch(e) { - console.log('OffChange001 e ' + e); + console.log('syncComplete e ' + e); } ``` @@ -7891,4 +8531,4 @@ off(event: 'syncComplete', syncCallback: Callback): void - + \ No newline at end of file -- Gitee From 47058c87037faa053d8604faf1b3197a08844ebc Mon Sep 17 00:00:00 2001 From: asfasdff Date: Fri, 7 Jan 2022 18:01:39 +0800 Subject: [PATCH 5/6] api fix ip Signed-off-by: asfasdff --- .../reference/apis/js-apis-distributed-data.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index 51115b9e23b..50a15f3ccef 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -1247,7 +1247,9 @@ toJsonString():string; let schema = new ddm.Schema(); const str = schema.toJsonString(); console.log("schema: " + str); - } catch (e) {} + } catch (e) { + console.log("toJsonString " + e); + } ``` @@ -4162,7 +4164,7 @@ deleteBatch(keys: string[]): Promise<void>; console.log('deleteBatch fail ' + JSON.stringify(err)); }); }).catch((err) => { - console.log('putBatch fail ' + JSON.stringify(err));; + console.log('putBatch fail ' + JSON.stringify(err)); }); }catch(e) { console.log('DeleteBatch e ' + e); @@ -4500,7 +4502,7 @@ enableSync(enabled: boolean, callback: AsyncCallback<void>): void; try { kvStore.enableSync(true, function (err,data) { if (err == undefined) { - console.log('enableSync success');; + console.log('enableSync success'); } else { console.log('enableSync fail'); } -- Gitee From acf8579e1d896225d5d2079dc60bcfd906df7ff1 Mon Sep 17 00:00:00 2001 From: asfasdff Date: Fri, 7 Jan 2022 22:10:37 +0800 Subject: [PATCH 6/6] fix up Signed-off-by: asfasdff --- .../apis/js-apis-distributed-data.md | 95 +++++++++++++++++++ 1 file changed, 95 insertions(+) diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index 50a15f3ccef..51e13dd2a06 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -3421,6 +3421,101 @@ setSuggestIndex(index: string): Query; ``` +### deviceId8+ ### + +deviceId(deviceId:string):Query; + +添加设备ID作为key的前缀。 + +- 参数： + + + + + + + + + + + + +

参数名

+

类型

+

必填

+

说明

+

deviceId

+

string

+

是

+

指示查询的设备 ID。

+
+ +- 返回值： + + + + + + + + + + +

类型

+

说明

+

Query

+

返回查询对象。

+
+ +- 示例 + + ``` + try { + let query = new distributedData.Query(); + query.deviceId("deviceId"); + console.log("query is " + query.getSqlLike()); + } catch (e) { + console.log("should be ok on Method Chaining : " + e); + } + ``` + + +### getSqlLike8+ ### + +getSqlLike():string; + +获取指定Query对象的查询语句。 + +- 返回值： + + + + + + + + + + +

类型

+

说明

+

string

+

返回指定Query对象的查询语句。

+
+ +- 示例 + + ``` + try { + let query = new distributedData.Query(); + let sql1 = query.getSqlLike(); + console.log("GetSqlLike sql=" + sql1); + } catch (e) { + console.log("dumplicated calls should be ok : " + e); + } + ``` + + ## KVStore KVStore数据库实例，提供增加数据、删除数据和订阅数据变更、订阅同步完成的方法。在调用KVStore的方法前，需要先通过getKVStore构建一个KVStore实例。 -- Gitee