轻量级存储

轻量级存储为应用提供key-value键值型的文件数据处理能力，支持应用对数据进行轻量级存储及查询。数据存储形式为键值对，键的类型为字符串型，值的存储数据类型包括数字型、字符型、布尔型。

说明：

本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import dataStorage from '@ohos.data.storage';

常量

系统能力： 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core

dataStorage.getStorageSync

getStorageSync(path: string): Storage

读取指定文件，将数据加载到Storage实例，用于数据操作。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'

var context = featureAbility.getContext()
context.getFilesDir((err, path) => {
    if (err) {
        console.error('getFilesDir failed. err: ' + JSON.stringify(err));
        return;
    }
    console.info('getFilesDir successful. path:' + JSON.stringify(path));
    let storage = dataStorage.getStorageSync(path + '/mystore')
    storage.putSync('startup', 'auto')
    storage.flushSync()
});

dataStorage.getStorage

getStorage(path: string, callback: AsyncCallback<Storage>): void

读取指定文件，将数据加载到Storage实例，用于数据操作，使用callback方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'

var context = featureAbility.getContext()
context.getFilesDir((err, path) => {
    if (err) {
        console.error('getFilesDir failed. err: ' + JSON.stringify(err));
        return;
    }
    console.info('getFilesDir successful. path:' + JSON.stringify(path));
    dataStorage.getStorage(path + '/mystore', function (err, storage) {
        if (err) {
            console.info("Get the storage failed, path: " + path + '/mystore')
            return;
        }
        storage.putSync('startup', 'auto')
        storage.flushSync()
    })
});

dataStorage.getStorage

getStorage(path: string): Promise<Storage>

读取指定文件，将数据加载到Storage实例，用于数据操作，使用Promise方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'

var context = featureAbility.getContext()
context.getFilesDir((err, path) => {
    if (err) {
        console.info("Get the storage failed, path: " + path + '/mystore')
        return;
    }
    console.info('getFilesDir successful. path:' + JSON.stringify(path));
    let promisegetSt = dataStorage.getStorage(path + '/mystore')
    promisegetSt.then((storage) => {
        storage.putSync('startup', 'auto')
        storage.flushSync()
    }).catch((err) => {
        console.info("Get the storage failed, path: " + path + '/mystore')
    })
});

dataStorage.deleteStorageSync

deleteStorageSync(path: string): void

从内存中移除指定文件对应的Storage单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

dataStorage.deleteStorageSync(path + '/mystore')

dataStorage.deleteStorage

deleteStorage(path: string, callback: AsyncCallback<void>): void

从内存中移除指定文件对应的Storage单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用callback方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

dataStorage.deleteStorage(path + '/mystore', function (err) {
    if (err) {
        console.info("Deleted failed with err: " + err)
        return
    }
    console.info("Deleted successfully.")
})

dataStorage.deleteStorage

deleteStorage(path: string): Promise<void>

从内存中移除指定文件对应的Storage单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用promise方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

let promisedelSt = dataStorage.deleteStorage(path + '/mystore')
promisedelSt.then(() => {
    console.info("Deleted successfully.")
}).catch((err) => {
    console.info("Deleted failed with err: " + err)
})

dataStorage.removeStorageFromCacheSync

removeStorageFromCacheSync(path: string): void

从内存中移除指定文件对应的Storage单实例。移除Storage单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

dataStorage.removeStorageFromCacheSync(path + '/mystore')

dataStorage.removeStorageFromCache

removeStorageFromCache(path: string, callback: AsyncCallback<void>): void

从内存中移除指定文件对应的Storage单实例。移除Storage单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。使用callback方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

dataStorage.removeStorageFromCache(path + '/mystore', function (err) {
    if (err) {
        console.info("Removed storage from cache failed with err: " + err)
        return
    }
    console.info("Removed storage from cache successfully.")
})

dataStorage.removeStorageFromCache

removeStorageFromCache(path: string): Promise<void>

从内存中移除指定文件对应的Storage单实例。移除Storage单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。使用Promise方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

let promiserevSt = dataStorage.removeStorageFromCache(path + '/mystore')
promiserevSt.then(() => {
    console.info("Removed storage from cache successfully.")
}).catch((err) => {
    console.info("Removed storage from cache failed with err: " + err)
})

Storage

提供获取和修改存储数据的接口。

getSync

getSync(key: string, defValue: ValueType): ValueType

获取键对应的值，如果值为null或者非默认值类型，返回默认数据。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

let value = storage.getSync('startup', 'default')
console.info("The value of startup is " + value)

get

get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): void

获取键对应的值，如果值为null或者非默认值类型，返回默认数据。使用callback方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

storage.get('startup', 'default', function(err, value) {
    if (err) {
        console.info("Get the value of startup failed with err: " + err)
        return
    }
    console.info("The value of startup is " + value)
})

get

get(key: string, defValue: ValueType): Promise<ValueType>

获取键对应的值，如果值为null或者非默认值类型，返默认数据。使用Promise方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

let promiseget = storage.get('startup', 'default')
promiseget.then((value) => {
    console.info("The value of startup is " + value)
}).catch((err) => {
    console.info("Get the value of startup failed with err: " + err)
})

putSync

putSync(key: string, value: ValueType): void

首先获取指定文件对应的Storage实例，然后借助Storage API将数据写入Storage实例，通过flush或者flushSync将Storage实例持久化。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

storage.putSync('startup', 'auto')

put

put(key: string, value: ValueType, callback: AsyncCallback<void>): void

首先获取指定文件对应的Storage实例，然后借助Storage API将数据写入Storage实例，通过flush或者flushSync将Storage实例持久化。使用callback方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

storage.put('startup', 'auto', function (err) {
    if (err) {
        console.info("Put the value of startup failed with err: " + err)
        return
    }
    console.info("Put the value of startup successfully.")
})

put

put(key: string, value: ValueType): Promise<void>

首先获取指定文件对应的Storage实例，然后借助Storage API将数据写入Storage实例，通过flush或者flushSync将Storage实例持久化。使用Promise方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

let promiseput = storage.put('startup', 'auto')
promiseput.then(() => {
    console.info("Put the value of startup successfully.")
}).catch((err) => {
    console.info("Put the value of startup failed with err: " + err)
})

hasSync

hasSync(key: string): boolean

检查存储对象是否包含名为给定key的存储。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

let isExist = storage.hasSync('startup')
if (isExist) {
    console.info("The key of startup is contained.")
}

has

has(key: string, callback: AsyncCallback<boolean>): boolean

检查存储对象是否包含名为给定key的存储。使用callback方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

storage.has('startup', function (err, isExist) {
    if (err) {
        console.info("Check the key of startup failed with err: " + err)
        return
    }
    if (isExist) {
        console.info("The key of startup is contained.")
    }
})

has

has(key: string): Promise<boolean>

检查存储对象是否包含名为给定key的存储。使用Promise方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

let promisehas = storage.has('startup')
promisehas.then((isExist) => {
    if (isExist) {
        console.info("The key of startup is contained.")
    }
}).catch((err) => {
    console.info("Check the key of startup failed with err: " + err)
})

deleteSync

deleteSync(key: string): void

从存储对象中删除名为给定key的存储。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

storage.deleteSync('startup')

delete

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

从存储对象中删除名为给定key的存储。使用callback方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

storage.delete('startup', function (err) {
    if (err) {
        console.info("Delete startup key failed with err: " + err)
        return
    }
    console.info("Deleted startup key successfully.")
})

delete

delete(key: string): Promise<void>

从存储对象删除名为给定key的存储。使用Promise方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

返回值：

示例：

let promisedel = storage.delete('startup')
promisedel.then(() => {
    console.info("Deleted startup key successfully.")
}).catch((err) => {
    console.info("Delete startup key failed with err: " + err)
})

flushSync

flushSync(): void

将当前storage对象中的修改保存到当前的storage，并同步存储到文件中。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

示例：

storage.flushSync()

flush

flush(callback: AsyncCallback<void>): void

将当前storage对象中的修改保存到当前的storage，并异步存储到文件中。使用callback方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

storage.flush(function (err) {
    if (err) {
        console.info("Flush to file failed with err: " + err)
        return
    }
    console.info("Flushed to file successfully.")
})

flush

flush(): Promise<void>

将当前storage对象中的修改保存到当前的storage，并异步存储到文件中。使用Promise方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

返回值：

示例：

let promiseflush = storage.flush()
promiseflush.then(() => {
    console.info("Flushed to file successfully.")
}).catch((err) => {
    console.info("Flush to file failed with err: " + err)
})

clearSync

clearSync(): void

清除此存储对象中的所有存储。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

示例：

storage.clearSync()

clear

clear(callback: AsyncCallback<void>): void

清除此存储对象中的所有存储。使用callback方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

storage.clear(function (err) {
    if (err) {
        console.info("Clear to file failed with err: " + err)
        return
    }
    console.info("Cleared to file successfully.")
})

clear

clear(): Promise<void>

清除此存储对象中的所有存储。使用Promise方式返回结果，此方法为异步方法。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

返回值：

示例：

let promiseclear = storage.clear()
promiseclear.then(() => {
    console.info("Cleared to file successfully.")
}).catch((err) => {
    console.info("Clear to file failed with err: " + err)
})

on('change')

on(type: 'change', callback: Callback<StorageObserver>): void

订阅数据变更者类需要实现StorageObserver接口，订阅的key的值发生变更后，在执行flush/flushSync方法后，callback方法会被回调。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

var observer = function (key) {
    console.info("The key of " + key + " changed.")
}
storage.on('change', observer)
storage.putSync('startup', 'auto')
storage.flushSync()  // observer will be called.

off('change')

off(type: 'change', callback: Callback<StorageObserver>): void

当不再进行订阅数据变更时，使用此接口取消订阅。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

参数：

示例：

var observer = function (key) {
    console.info("The key of " + key + " changed.")
}
storage.off('change', observer)

StorageObserver

系统能力： 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core

ValueType

用于表示允许的数据字段类型。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core