分布式鍵值數(shù)據(jù)庫

導入模塊

import distributedKVStore from '@ohos.data.distributedKVStore';

KVManagerConfig

提供KVManager實例的配置信息，包括調用方的包名和應用的上下文。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

Constants

分布式鍵值數(shù)據(jù)庫常量。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

ValueType

數(shù)據(jù)類型枚舉。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

Value

存儲在數(shù)據(jù)庫中的值對象。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

Entry

存儲在數(shù)據(jù)庫中的鍵值對。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

ChangeNotification

數(shù)據(jù)變更時通知的對象，包括數(shù)據(jù)插入的數(shù)據(jù)、更新的數(shù)據(jù)、刪除的數(shù)據(jù)和設備ID。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

SyncMode

同步模式枚舉。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

SubscribeType

訂閱類型枚舉。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

KVStoreType

分布式鍵值數(shù)據(jù)庫類型枚舉。

SecurityLevel

數(shù)據(jù)庫的安全級別枚舉。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

Options

用于提供創(chuàng)建數(shù)據(jù)庫的配置信息。

Schema

表示數(shù)據(jù)庫模式，可以在創(chuàng)建或打開數(shù)據(jù)庫時創(chuàng)建Schema對象并將它們放入Options中。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore

constructor

constructor()

用于創(chuàng)建Schema實例的構造函數(shù)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore

FieldNode

表示 Schema 實例的節(jié)點，提供定義存儲在數(shù)據(jù)庫中的值的方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore

constructor

constructor(name: string)

用于創(chuàng)建帶有string字段FieldNode實例的構造函數(shù)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore

參數(shù)：

appendChild

appendChild(child: FieldNode): boolean

在當前 FieldNode 中添加一個子節(jié)點。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore

參數(shù)：

返回值：

示例：

try {
    let node = new distributedKVStore.FieldNode("root");
    let child1 = new distributedKVStore.FieldNode("child1");
    let child2 = new distributedKVStore.FieldNode("child2");
    let child3 = new distributedKVStore.FieldNode("child3");
    node.appendChild(child1);
    node.appendChild(child2);
    node.appendChild(child3);
    console.info("appendNode " + JSON.stringify(node));
    child1 = null;
    child2 = null;
    child3 = null;
    node = null;
} catch (e) {
    console.error("AppendChild " + e);
}

distributedKVStore.createKVManager

createKVManager(config: KVManagerConfig): KVManager

創(chuàng)建一個KVManager對象實例，用于管理數(shù)據(jù)庫對象。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

Stage模型下的示例：

import UIAbility from '@ohos.app.ability.UIAbility';

let kvManager;
export default class EntryAbility extends UIAbility {
    onCreate() {
        console.info("MyAbilityStage onCreate")
        let context = this.context
        const kvManagerConfig = {
            context: context,
            bundleName: 'com.example.datamanagertest',
        }
        try {
            kvManager = distributedKVStore.createKVManager(kvManagerConfig);
            console.info("Succeeded in creating KVManager");
        } catch (e) {
            console.error(`Failed to create KVManager.code is ${e.code},message is ${e.message}`);
        }
    }
}

FA模型下的示例：

import featureAbility from '@ohos.ability.featureAbility';
let kvManager;
let context = featureAbility.getContext()
const kvManagerConfig = {
    context: context,
    bundleName: 'com.example.datamanagertest',
}
try {
    kvManager = distributedKVStore.createKVManager(kvManagerConfig);
    console.info("Succeeded in creating KVManager");
} catch (e) {
    console.error(`Failed to create KVManager.code is ${e.code},message is ${e.message}`);
}

KVManager

分布式鍵值數(shù)據(jù)庫管理實例，用于獲取分布式鍵值數(shù)據(jù)庫的相關信息。在調用KVManager的方法前，需要先通過createKVManager構建一個KVManager實例。

getKVStore

getKVStore<T>(storeId: string, options: Options, callback: AsyncCallback<T>): void

通過指定Options和storeId，創(chuàng)建并獲取分布式鍵值數(shù)據(jù)庫，使用callback異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見分布式鍵值數(shù)據(jù)庫錯誤碼。

示例：

let kvStore;
try {
    const options = {
        createIfMissing: true,
        encrypt: false,
        backup: false,
        autoSync: true,
        kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION,
        securityLevel: distributedKVStore.SecurityLevel.S2,
    };
    kvManager.getKVStore('storeId', options, function (err, store) {
        if (err) {
            console.error(`Failed to get KVStore.code is ${err.code},message is ${err.message}`);
            return;
        }
        console.info("Succeeded in getting KVStore");
        kvStore = store;
    });
} catch (e) {
    console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}

getKVStore

getKVStore<T>(storeId: string, options: Options): Promise<T>

通過指定Options和storeId，創(chuàng)建并獲取分布式鍵值數(shù)據(jù)庫，使用Promise異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見分布式鍵值數(shù)據(jù)庫錯誤碼。

示例：

let kvStore;
try {
    const options = {
        createIfMissing: true,
        encrypt: false,
        backup: false,
        autoSync: true,
        kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION,
        securityLevel: distributedKVStore.SecurityLevel.S2,
    };
    kvManager.getKVStore('storeId', options).then((store) => {
        console.info("Succeeded in getting KVStore");
        kvStore = store;
    }).catch((err) => {
        console.error(`Failed to get KVStore.code is ${err.code},message is ${err.message}`);
    });
} catch (e) {
    console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}

closeKVStore

closeKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): void

通過storeId的值關閉指定的分布式鍵值數(shù)據(jù)庫，使用callback異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

示例：

const options = {
    createIfMissing: true,
    encrypt: false,
    backup: false,
    autoSync: true,
    kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION,
    schema: undefined,
    securityLevel: distributedKVStore.SecurityLevel.S2,
}
try {
    kvManager.getKVStore('storeId', options, async function (err, store) {
        if (err != undefined) {
            console.error(`Failed to get KVStore.code is ${err.code},message is ${err.message}`);
            return;
        }
        console.info('Succeeded in getting KVStore');
        kvStore = store;
        kvStore = null;
        store = null;
        kvManager.closeKVStore('appId', 'storeId', function (err) {
            if (err != undefined) {
                console.error(`Failed to close KVStore.code is ${err.code},message is ${err.message}`);
                return;
            }
            console.info('Succeeded in closing KVStore');
        });
    });
} catch (e) {
    console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}

closeKVStore

closeKVStore(appId: string, storeId: string): Promise<void>

通過storeId的值關閉指定的分布式鍵值數(shù)據(jù)庫，使用Promise異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

const options = {
    createIfMissing: true,
    encrypt: false,
    backup: false,
    autoSync: true,
    kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION,
    schema: undefined,
    securityLevel: distributedKVStore.SecurityLevel.S2,
}
try {
    kvManager.getKVStore('storeId', options).then(async (store) => {
        console.info('Succeeded in getting KVStore');
        kvStore = store;
        kvStore = null;
        store = null;
        kvManager.closeKVStore('appId', 'storeId').then(() => {
            console.info('Succeeded in closing KVStore');
        }).catch((err) => {
            console.error(`Failed to close KVStore.code is ${err.code},message is ${err.message}`);
        });
    }).catch((err) => {
        console.error(`Failed to get KVStore.code is ${err.code},message is ${err.message}`);
    });
} catch (e) {
    console.error(`Failed to close KVStore.code is ${e.code},message is ${e.message}`);
}

deleteKVStore

deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): void

通過storeId的值刪除指定的分布式鍵值數(shù)據(jù)庫，使用callback異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見分布式鍵值數(shù)據(jù)庫錯誤碼。

示例：

const options = {
    createIfMissing: true,
    encrypt: false,
    backup: false,
    autoSync: true,
    kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION,
    schema: undefined,
    securityLevel: distributedKVStore.SecurityLevel.S2,
}
try {
    kvManager.getKVStore('store', options, async function (err, store) {
        if (err != undefined) {
            console.error(`Failed to get KVStore.code is ${err.code},message is ${err.message}`);
            return;
        }
        console.info('Succeeded in getting KVStore');
        kvStore = store;
        kvStore = null;
        store = null;
        kvManager.deleteKVStore('appId', 'storeId', function (err) {
            if (err != undefined) {
                console.error(`Failed to delete KVStore.code is ${err.code},message is ${err.message}`);
                return;
            }
            console.info(`Succeeded in deleting KVStore`);
        });
    });
} catch (e) {
    console.error(`Failed to delete KVStore.code is ${e.code},message is ${e.message}`);
}

deleteKVStore

deleteKVStore(appId: string, storeId: string): Promise<void>

通過storeId的值刪除指定的分布式鍵值數(shù)據(jù)庫，使用Promise異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見分布式鍵值數(shù)據(jù)庫錯誤碼。

示例：

const options = {
    createIfMissing: true,
    encrypt: false,
    backup: false,
    autoSync: true,
    kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION,
    schema: undefined,
    securityLevel: distributedKVStore.SecurityLevel.S2,
}
try {
    kvManager.getKVStore('storeId', options).then(async (store) => {
        console.info('Succeeded in getting KVStore');
        kvStore = store;
        kvStore = null;
        store = null;
        kvManager.deleteKVStore('appId', 'storeId').then(() => {
            console.info('Succeeded in deleting KVStore');
        }).catch((err) => {
            console.error(`Failed to delete KVStore.code is ${err.code},message is ${err.message}`);
        });
    }).catch((err) => {
        console.error(`Failed to get KVStore.code is ${err.code},message is ${err.message}`);
    });
} catch (e) {
    console.error(`Failed to delete KVStore.code is ${e.code},message is ${e.message}`);
}

getAllKVStoreId

getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void

獲取所有通過getKVStore方法創(chuàng)建的且沒有調用deleteKVStore方法刪除的分布式鍵值數(shù)據(jù)庫的storeId，使用callback異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

示例：

try {
    kvManager.getAllKVStoreId('appId', function (err, data) {
        if (err != undefined) {
            console.error(`Failed to get AllKVStoreId.code is ${err.code},message is ${err.message}`);
            return;
        }
        console.info('Succeeded in getting AllKVStoreId');
        console.info(`GetAllKVStoreId size = ${data.length}`);
    });
} catch (e) {
    console.error(`Failed to get AllKVStoreId.code is ${e.code},message is ${e.message}`);
}

getAllKVStoreId

getAllKVStoreId(appId: string): Promise<string[]>

獲取所有通過getKVStore方法創(chuàng)建的且沒有調用deleteKVStore方法刪除的分布式鍵值數(shù)據(jù)庫的storeId，使用Promise異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    console.info('GetAllKVStoreId');
    kvManager.getAllKVStoreId('appId').then((data) => {
        console.info('Succeeded in getting AllKVStoreId');
        console.info(`GetAllKVStoreId size = ${data.length}`);
    }).catch((err) => {
        console.error(`Failed to get AllKVStoreId.code is ${err.code},message is ${err.message}`);
    });
} catch (e) {
    console.error(`Failed to get AllKVStoreId.code is ${e.code},message is ${e.message}`);
}

on('distributedDataServiceDie')

on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): void

訂閱服務狀態(tài)變更通知。如果服務終止，需要重新注冊數(shù)據(jù)變更通知和同步完成事件回調通知，并且同步操作會返回失敗。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore

參數(shù)：

示例：

try {
    console.info('KVManagerOn');
    const deathCallback = function () {
        console.info('death callback call');
    }
    kvManager.on('distributedDataServiceDie', deathCallback);
} catch (e) {
    console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}

off('distributedDataServiceDie')

off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): void

取消訂閱服務狀態(tài)變更通知。參數(shù)中的deathCallback必須是已經(jīng)訂閱過的deathCallback，否則會取消訂閱失敗。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore

參數(shù)：

示例：

try {
    console.info('KVManagerOff');
    const deathCallback = function () {
        console.info('death callback call');
    }
    kvManager.off('distributedDataServiceDie', deathCallback);
} catch (e) {
    console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}

KVStoreResultSet

提供獲取數(shù)據(jù)庫結果集的相關方法，包括查詢和移動數(shù)據(jù)讀取位置等。同時允許打開的結果集的最大數(shù)量為8個。

在調用KVStoreResultSet的方法前，需要先通過getKVStore構建一個SingleKVStore或者DeviceKVStore實例。

getCount

getCount(): number

獲取結果集中的總行數(shù)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    let count;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        count = resultSet.getCount();
        console.info("getCount succeed:" + count);
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("getCount failed: " + e);
}

getPosition

getPosition(): number

獲取結果集中當前的讀取位置。讀取位置會因moveToFirst、moveToLast等操作而發(fā)生變化。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    let position;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeeded.');
        resultSet = result;
        position = resultSet.getPosition();
        console.info("getPosition succeed:" + position);
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("getPosition failed: " + e);
}

moveToFirst

moveToFirst(): boolean

將讀取位置移動到第一行。如果結果集為空，則返回false。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    let moved;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        moved = resultSet.moveToFirst();
        console.info("moveToFirst succeed: " + moved);
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("moveToFirst failed " + e);
}

moveToLast

moveToLast(): boolean

將讀取位置移動到最后一行。如果結果集為空，則返回false。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    let moved;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        moved = resultSet.moveToLast();
        console.info("moveToLast succeed:" + moved);
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("moveToLast failed: " + e);
}

moveToNext

moveToNext(): boolean

將讀取位置移動到下一行。如果結果集為空，則返回false。適用于全量獲取數(shù)據(jù)庫結果集的場景。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    let moved;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        do {
          moved = resultSet.moveToNext();
          console.info("moveToNext succeed: " + moved);
        } while (moved)
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("moveToNext failed: " + e);
}

moveToPrevious

moveToPrevious(): boolean

將讀取位置移動到上一行。如果結果集為空，則返回false。適用于全量獲取數(shù)據(jù)庫結果集的場景。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    let moved;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        moved = resultSet.moveToLast();
        moved = resultSet.moveToPrevious();
        console.info("moveToPrevious succeed:" + moved);
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("moveToPrevious failed: " + e);
}

move

move(offset: number): boolean

將讀取位置移動到當前位置的相對偏移量。即當前游標位置向下偏移 offset 行。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let resultSet;
    let moved;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('Succeeded in getting resultSet');
        resultSet = result;
        moved = resultSet.move(2); //若當前位置為0，將讀取位置從絕對位置為0的位置移動2行，即移動到絕對位置為2，行數(shù)為3的位置
        console.info(`Succeeded in moving.moved = ${moved}`);
    }).catch((err) => {
        console.error(`Failed to get resultSet.code is ${err.code},message is ${err.message}`);
    });
} catch (e) {
    console.error(`Failed to move.code is ${e.code},message is ${e.message}`);
}

moveToPosition

moveToPosition(position: number): boolean

將讀取位置從 0 移動到絕對位置。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let resultSet;
    let moved;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('Succeeded in getting resultSet');
        resultSet = result;
        moved = resultSet.moveToPosition(1);
        console.info(`Succeeded in moving to position.moved=${moved}`);
    }).catch((err) => {
        console.error(`Failed to get resultSet.code is ${err.code},message is ${err.message}`);
    });
} catch (e) {
    console.error(`Failed to move to position.code is ${e.code},message is ${e.message}`);
}

isFirst

isFirst(): boolean

檢查讀取位置是否為第一行。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    let isfirst;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        isfirst = resultSet.isFirst();
        console.info("Check isFirst succeed:" + isfirst);
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("Check isFirst failed: " + e);
}

isLast

isLast(): boolean

檢查讀取位置是否為最后一行。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    let islast;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        islast = resultSet.isLast();
        console.info("Check isLast succeed: " + islast);
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("Check isLast failed: " + e);
}

isBeforeFirst

isBeforeFirst(): boolean

檢查讀取位置是否在第一行之前。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        const isbeforefirst = resultSet.isBeforeFirst();
        console.info("Check isBeforeFirst succeed: " + isbeforefirst);
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("Check isBeforeFirst failed: " + e);
}

isAfterLast

isAfterLast(): boolean

檢查讀取位置是否在最后一行之后。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        const isafterlast = resultSet.isAfterLast();
        console.info("Check isAfterLast succeed:" + isafterlast);
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("Check isAfterLast failed: " + e);
}

getEntry

getEntry(): Entry

從當前位置獲取對應的鍵值對。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
        console.info('getResultSet succeed.');
        resultSet = result;
        const entry  = resultSet.getEntry();
        console.info("getEntry succeed:" + JSON.stringify(entry));
    }).catch((err) => {
        console.error('getResultSet failed: ' + err);
    });
} catch (e) {
    console.error("getEntry failed: " + e);
}

Query

使用謂詞表示數(shù)據(jù)庫查詢，提供創(chuàng)建Query實例、查詢數(shù)據(jù)庫中的數(shù)據(jù)和添加謂詞的方法。一個Query對象中謂詞數(shù)量上限為256個。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

constructor

constructor()

用于創(chuàng)建Schema實例的構造函數(shù)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

reset

reset(): Query

重置Query對象。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.equalTo("key", "value");
    console.info("query is " + query.getSqlLike());
    query.reset();
    console.info("query is " + query.getSqlLike());
    query = null;
} catch (e) {
    console.error("simply calls should be ok :" + e);
}

equalTo

equalTo(field: string, value: number|string|boolean): Query

構造一個Query對象來查詢具有指定字段的條目，其值等于指定的值。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.equalTo("field", "value");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

notEqualTo

notEqualTo(field: string, value: number|string|boolean): Query

構造一個Query對象以查詢具有指定字段且值不等于指定值的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.notEqualTo("field", "value");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

greaterThan

greaterThan(field: string, value: number|string|boolean): Query

構造一個Query對象以查詢具有大于指定值的指定字段的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.greaterThan("field", "value");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

lessThan

lessThan(field: string, value: number|string): Query

構造一個Query對象以查詢具有小于指定值的指定字段的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.lessThan("field", "value");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

greaterThanOrEqualTo

greaterThanOrEqualTo(field: string, value: number|string): Query

構造一個Query對象以查詢具有指定字段且值大于或等于指定值的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.greaterThanOrEqualTo("field", "value");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

lessThanOrEqualTo

lessThanOrEqualTo(field: string, value: number|string): Query

構造一個Query對象以查詢具有指定字段且值小于或等于指定值的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.lessThanOrEqualTo("field", "value");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

isNull

isNull(field: string): Query

構造一個Query對象以查詢具有值為null的指定字段的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.isNull("field");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

inNumber

inNumber(field: string, valueList: number[]): Query

構造一個Query對象以查詢具有指定字段的條目，其值在指定的值列表中。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.inNumber("field", [0, 1]);
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

inString

inString(field: string, valueList: string[]): Query

構造一個Query對象以查詢具有指定字段的條目，其值在指定的字符串值列表中。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.inString("field", ['test1', 'test2']);
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

notInNumber

notInNumber(field: string, valueList: number[]): Query

構造一個Query對象以查詢具有指定字段的條目，該字段的值不在指定的值列表中。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.notInNumber("field", [0, 1]);
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

notInString

notInString(field: string, valueList: string[]): Query

構造一個Query對象以查詢具有指定字段且值不在指定字符串值列表中的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.notInString("field", ['test1', 'test2']);
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

like

like(field: string, value: string): Query

構造一個Query對象以查詢具有與指定字符串值相似的指定字段的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.like("field", "value");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

unlike

unlike(field: string, value: string): Query

構造一個Query對象以查詢具有與指定字符串值不相似的指定字段的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.unlike("field", "value");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

and

and(): Query

構造一個帶有與條件的查詢對象。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.notEqualTo("field", "value1");
    query.and();
    query.notEqualTo("field", "value2");
    console.info("query is " + query.getSqlLike());
    query = null;
} catch (e) {
    console.error("duplicated calls should be ok :" + e);
}

or

or(): Query

構造一個帶有或條件的Query對象。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.notEqualTo("field", "value1");
    query.or();
    query.notEqualTo("field", "value2");
    console.info("query is " + query.getSqlLike());
    query = null;
} catch (e) {
    console.error("duplicated calls should be ok :" + e);
}

orderByAsc

orderByAsc(field: string): Query

構造一個Query對象，將查詢結果按升序排序。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.notEqualTo("field", "value");
    query.orderByAsc("field");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

orderByDesc

orderByDesc(field: string): Query

構造一個Query對象，將查詢結果按降序排序。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.notEqualTo("field", "value");
    query.orderByDesc("field");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

limit

limit(total: number, offset: number): Query

構造一個Query對象來指定結果的數(shù)量和開始位置。該接口必須要在Query對象查詢和升降序等操作之后調用，調用limit接口后，不可再對Query對象進行查詢和升降序等操作。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

let total = 10;
let offset = 1;
try {
    let query = new distributedKVStore.Query();
    query.notEqualTo("field", "value");
    query.limit(total, offset);
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
     console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

isNotNull

isNotNull(field: string): Query

構造一個Query對象以查詢具有值不為null的指定字段的條目。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.isNotNull("field");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

beginGroup

beginGroup(): Query

創(chuàng)建一個帶有左括號的查詢條件組。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.beginGroup();
    query.isNotNull("field");
    query.endGroup();
    console.info("query is " + query.getSqlLike());
    query = null;
} catch (e) {
    console.error("duplicated calls should be ok :" + e);
}

endGroup

endGroup(): Query

創(chuàng)建一個帶有右括號的查詢條件組。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.beginGroup();
    query.isNotNull("field");
    query.endGroup();
    console.info("query is " + query.getSqlLike());
    query = null;
} catch (e) {
    console.error("duplicated calls should be ok :" + e);
}

prefixKey

prefixKey(prefix: string): Query

創(chuàng)建具有指定鍵前綴的查詢條件。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.prefixKey("$.name");
    query.prefixKey("0");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

setSuggestIndex

setSuggestIndex(index: string): Query

設置一個指定的索引，將優(yōu)先用于查詢。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.setSuggestIndex("$.name");
    query.setSuggestIndex("0");
    console.info(`query is ${query.getSqlLike()}`);
    query = null;
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

deviceId

deviceId(deviceId:string):Query

添加設備ID作為key的前綴。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    query.deviceId("deviceId");
    console.info(`query is ${query.getSqlLike()}`);
} catch (e) {
    console.error(`duplicated calls should be ok.code is ${e.code},message is ${e.message}`);
}

getSqlLike

getSqlLike():string

獲取Query對象的查詢語句。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

返回值：

示例：

try {
    let query = new distributedKVStore.Query();
    let sql1 = query.getSqlLike();
    console.info(`GetSqlLike sql= ${sql1}`);
} catch (e) {
    console.error("duplicated calls should be ok : " + e);
}

SingleKVStore

SingleKVStore數(shù)據(jù)庫實例，提供增加數(shù)據(jù)、刪除數(shù)據(jù)和訂閱數(shù)據(jù)變更、訂閱數(shù)據(jù)同步完成的方法。

在調用SingleKVStore的方法前，需要先通過getKVStore構建一個SingleKVStore實例。

put

put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback<void>): void

添加指定類型鍵值對到數(shù)據(jù)庫，使用callback異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見分布式鍵值數(shù)據(jù)庫錯誤碼。

示例：

const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
    kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err) {
        if (err != undefined) {
            console.error(`Failed to put.code is ${err.code},message is ${err.message}`);
            return;
        }
        console.info("Succeeded in putting");
    });
} catch (e) {
    console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}

put

put(key: string, value: Uint8Array | string | number | boolean): Promise<void>

添加指定類型鍵值對到數(shù)據(jù)庫，使用Promise異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見分布式鍵值數(shù)據(jù)庫錯誤碼。

示例：

const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
    kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then(() => {
        console.info(`Succeeded in putting data.`);
    }).catch((err) => {
        console.error(`Failed to put.code is ${err.code},message is ${err.message}`);
    });
} catch (e) {
    console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}

putBatch

putBatch(entries: Entry[], callback: AsyncCallback<void>): void

批量插入鍵值對到SingleKVStore數(shù)據(jù)庫中，使用callback異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見分布式鍵值數(shù)據(jù)庫錯誤碼。

示例：

try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key: key + i,
            value: {
                type: distributedKVStore.ValueType.STRING,
                value: 'batch_test_string_value'
            }
        }
        entries.push(entry);
    }
    console.info(`entries: ${entries}`);
    kvStore.putBatch(entries, async function (err) {
        if (err != undefined) {
            console.error(`Failed to put Batch.code is ${err.code},message is ${err.message}`);
            return;
        }
        console.info('Succeeded in putting Batch');
        kvStore.getEntries('batch_test_string_key', function (err, entries) {
            if (err != undefined) {
                console.error(`Failed to get Entries.code is ${err.code},message is ${err.message}`);
            }
            console.info('Succeeded in getting Entries');
            console.info(`entries.length: ${entries.length}`);
            console.info(`entries[0]: ${entries[0]}`);
        });
    });
} catch (e) {
    console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message} `);
}

putBatch

putBatch(entries: Entry[]): Promise<void>

批量插入鍵值對到SingleKVStore數(shù)據(jù)庫中，使用Promise異步回調。

系統(tǒng)能力： SystemCapability.DistributedDataManager.KVStore.Core

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見分布式鍵值數(shù)據(jù)庫錯誤碼。

示例：

try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key: key + i,
            value: {
                type: distributedKVStore.ValueType.STRING,
                value: 'batch_test_string_value'
            }
        }
        entries.push(entry);
    }
    console.info(`entries: ${entries}`);
    kvStore.putBatch(entries).then(async () => {
        console.info('Succeeded in putting Batch');
        kvStore.getEntries('batch_test_string_key').then((entries) => {
            console.info('Succeeded in getting Entries');
            console.info(`PutBatch ${entries}`);
        }).catch((err) => {
            console.error(`Failed to get Entries.code is ${err.code},message is ${err.message}`);
        });
    }).catch((err) => {
        console.error(`Failed to put Batch.code is ${err.code},message is ${err.message}`);
    });
} catch (e) {
    console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message} `);
}

delete

delete(key: string, callback: AsyncCallback<void>): void