数据类型描述

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

导入模块

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

权限

无

SubscribeType

描述订阅类型。

名称	默认值	说明
SUBSCRIBE_TYPE_LOCAL	0	表示订阅本地数据变更。
SUBSCRIBE_TYPE_REMOTE	1	表示订阅远端数据变更。
SUBSCRIBE_TYPE_ALL	2	表示订阅远端和本地数据变更。

KVStoreType

用于指定创建的数据库的类型。

名称	默认值	说明
DEVICE_COLLABORATION	0	表示设备协同数据库。
SINGLE_VERSION	1	表示单版本数据库。
MULTI_VERSION	2	表示多版本数据库。此类型当前不允许使用。

SecurityLevel

用于指定创建的数据库的安全级别。

名称	默认值	说明
NO_LEVEL	0	表示数据库不设置安全级别。
S0	1	表示数据库的安全级别为公共级别安全，当数据泄露时不会产生影响。
S1	2	表示数据库的安全级别为低级别安全，当数据泄露时会产生较低影响。
S2	3	表示数据库的安全级别为中级别安全，当数据泄露时会产生较大影响。
S3	5	表示数据库的安全级别为高级别安全，当数据泄露时会产生重大影响。
S4	6	表示数据库的安全级别为关键级别安全，当数据泄露时会产生严重影响。

Options

用于提供创建数据库的配置信息。

参数名	类型	必填	说明
createIfMissing	boolean	否	当数据库文件不存在时是否创建数据库。默认创建。
encrypt	boolean	否	设置数据库文件是否加密。默认不加密。
backup	boolean	否	设置数据库文件是否备份。默认备份。
autoSync	boolean	否	设置数据库文件是否自动同步。默认自动同步。
kvStoreType	KVStoreType	否	设置要创建的数据库类型。默认为多设备协同数据库。
securityLevel	SecurityLevel	否	设置数据库安全级别。默认不设置安全级别。

SyncMode

用于指定同步模式。

名称	默认值	说明
PULL_ONLY	0	表示只能从远端拉取数据到本端。
PUSH_ONLY	1	表示只能从本端推送数据到对端。
PUSH_PULL	2	表示从本端推送数据到远端，然后从远端拉取数据到对端。

ValueType

用于表示数据类型。

只能被内部应用使用。

名称	默认值	说明
STRING	0	表示值类型为字符串。
INTEGER	1	表示值类型为整数。
FLOAT	2	表示值类型为浮点数。
BYTE_ARRAY	3	表示值类型为字节数组。
BOOLEAN	4	表示值类型为布尔值。
DOUBLE	5	表示值类型为双浮点数。

Value

存储在数据库中的对象。

名称	参数类型	可读	可写	说明
type	ValueType	是	是	值类型。
value	Uint8Array \| string \| number \| boolean	是	是	返回值。Uint8Array的长度小于4MB。

Entry

表示存储在分布式数据库中的键值对。

名称	参数类型	可读	可写	说明
key	string	是	是	键值。
value	Value	是	是	值对象。

ChangeNotification

数据变更时通知的对象，包括数据插入、更新和删除。

名称	参数类型	可读	可写	说明
insertEntries	Entry[]	是	是	数据添加记录。
updateEntries	Entry[]	是	是	数据更新记录。
deleteEntries	Entry[]	是	是	数据删除记录。
deviceId	string	是	是	设备ID。此处为设备UUID。