创建和获取分布式数据库

说明： 从 API Version 7 开始支持。

导入模块

import factory from '@ohos.data.distributeddata';

权限

无

createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void

创建分布式数据库管理对象。

此方法为异步callback方法。

• 参数：

  参数名	类型	说明
  config	KVManagerConfig	用于配置管理对象，包括用户信息和应用包名。
  callback	AsyncCallback<KVManager>	回调函数，获取数据库管理对象实例。

• 返回值：

  无

• 示例：

  factory.createKVManager(config, function (err, manager) {
              kvManager = manager;
          });
  

createKVManager(config: KVManagerConfig): Promise<KVManager>

创建分布式数据库管理对象。

此方法为异步promise方法。

• 参数：

  参数名	类型	说明
  config	KVManagerConfig	用于配置管理对象，包括用户信息和应用包名。

• 返回值：

  参数名	类型
  Promise<KVManager>	promise实例，用于获取异步返回结果。

• 示例：

  const promise = factory.createKVManager(config);
  promise.then((manager) => {
              kvManager = manager;
          }).catch((err) => {
          });
  

KVManager

提供管理分布式数据库的接口。

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

创建或获取数据库实例。需要先通过createKVManager创建或获取KVStore实例。

此方法为异步promise方法。

• 参数：

  参数名	类型	说明
  storeId	string	用于标识数据库。同一应用下该参数值必须唯一且长度应小于1KB。
  options	Options	数据库实例的配置信息。

• 返回值：

  参数名	类型
  Promise<T>	promise实例，用于获取异步返回结果。

• 示例：

  const promise = kvManager.getKVStore(options);
          promise.then((store) => {
              kvStore = store;
          }).catch((err) => {
          });
  

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

创建并获取数据库实例。

此方法为异步callback方法。

• 参数：

  参数名	类型	说明
  storeId	string	用于标识数据库。同一应用下该参数值必须唯一且长度应小于1KB。
  options	Options	数据库实例的配置信息。
  callback	AsyncCallback<T>	回调函数，获取数据库实例。

• 返回值：

  无

• 示例：

  kvManager.getKVStore('storeId', options, function(err, store){
  	kvStore = store;
  });