跳到主要内容

rxdb

Enumerations

EnumerationDescription
OnDeleteAction外键约束操作枚举 定义 SQLite 外键约束的级联行为
OnUpdateAction外键更新行为枚举 定义当父表主键被更新时的级联行为
PropertyType实体属性类型枚举 定义实体属性支持的数据类型
RelationKind实体关系类型枚举 定义实体之间可能的关系类型
SyncStatus同步状态
SyncType同步类型枚举 定义不同的数据同步策略,控制本地数据和远程数据之间的同步方式

Classes

ClassDescription
ConflictDetectedEvent冲突检测事件
ConflictPendingEvent冲突待处理事件
EntityBase实体基类装饰器配置 定义了所有实体共有的基础属性
EntityLocalCreatedEvent本地实体创建成功事件
EntityLocalNewEvent本地实体初始化事件
EntityLocalRemovedEvent本地实体删除成功事件
EntityLocalUpdatedEvent本地实体更新成功事件
EntityRemoteCreatedEvent远程实体创建事件
EntityRemoteRemovedEvent远程实体删除事件
EntityRemoteUpdatedEvent远程实体更新事件
LWWConflictResolverLast-Write-Wins 冲突解决器
NetworkOfflineError网络离线错误 - 当启用 offlineFallback 但无本地缓存可用时抛出
QueryCacheRepositoryQueryCache 同步策略仓库
QueryTask查询任务实现
Repository实体仓库 根据配置决策实体的具体操作
RepositoryBase数据仓库 用来协调数据存取
RepositorySyncBeginEventRepository 同步开始事件
RepositorySyncCompleteEventRepository 同步完成事件
RepositorySyncErrorEventRepository 同步错误事件
RxDBRxDB 是个单例对象,负责管理插件、适配器、事件以及上下文等全局功能 全局只能创建一个 RxDB 实例,所有 entity 都通过这个实例进行管理 所有 Entity 的 Class 也只能被注册一次
RxDBAdapterBase数据库适配器基类
RxDBAdapterLocalBase数据库适配器基类(本地)
RxDBAdapterRemoteBase数据库适配器基类(远程)
RxDBBranch分支表
RxDBChange数据库变更记录
RxDBErrorRxDB 基础错误类型
RxDBMigration数据库迁移记录
RxDBPluginBaseRxDB 插件基类
RxDBSyncRepository 同步元数据表
SwitchBranchBeginEvent分支切换开始事件
SwitchBranchCommitEvent分支切换提交事件
SwitchBranchEventBase-
SwitchBranchRollbackEvent分支切换回滚事件
SyncBeginEvent同步开始事件
SyncCompleteEvent同步完成事件
SyncErrorEvent同步错误事件
TransactionBeginEvent事务开始事件
TransactionCommitEvent事务提交事件
TransactionRollbackEvent事务回滚事件
TreeAdjacencyListEntityBase树形实体装饰器配置 定义了树形结构所需的父子关系

Interfaces

InterfaceDescription
BooleanProperty-
CheckRepositoryUpdatesResultCheck repository updates result
CleanupExpiredOptions过期数据清理选项
CleanupExpiredResult过期数据清理结果
Conflict冲突信息
ConflictResolver冲突解决器接口
CountOptionsCount 查询选项
DateProperty-
DiffResultDiff result containing categorized entity IDs
EntityIndexMetadataOptions实体索引元数据接口 定义实体索引的配置
EntityMetadataFeaturesEntityMetadata 扩展特性
EntityMetadataOptions实体定义元数据选项接口 用于配置 @Entity 装饰器的完整选项,定义实体的结构和行为
EntityMetadataTreeFeatures实体元数据树形结构特性接口
FindAllOptionsFindAll 查询选项
FindByCursorOptionsFindByCursor 查询选项
FindOneOptionsFindOne 查询选项
FindOneOrFailOptionsFindOneOrFail 查询选项
FindOptionsFind 查询选项
FindTreeOptions树结构查询配置
HistoryItem历史记录项 表示一个可撤销/重做的操作单元
HistoryScopeAPI历史记录作用域 API 所有作用域返回统一的接口,消除特殊情况
ICascadeOptions外键级联选项接口 定义关系的外键约束配置
IEntity实体基础接口 定义所有实体共有的基本属性,为了能更好地与远程数据同步 所有实体类都应该实现这个接口
IEntityStaticType实体的静态类型
IMutationContext操作上下文
IntegerProperty-
IRepository数据仓库管理接口
IRepositoryConfigIRepositoryConfig 统一注册配置 合并 factory、class 和 merge operations 为单一配置对象
IRxDBAdapterRxDB 数据库适配器接口
IRxDBChange远程更改数据接口
IRxDBPluginRxDB 插件接口
ITreeEntity实体基础接口 定义所有实体共有的基本属性,为了能更好地与远程数据同步 所有实体类都应该实现这个接口
ITreeRepository树结构仓库接口
JSONPropertyjson
KeyValuePropertykeyValue
MigrationType升级脚本
NumberArrayProperty-
NumberProperty数字组
OrderBy排序
PullOptionsPull 操作选项
PullRepositoryOptionsPull repository options
PullRepositoryResultPull repository result
PullResultPull 操作结果
PushOptionsPush 操作选项
PushRepositoryOptionsPush repository options
PushRepositoryResultPush repository result
PushResultPush 操作结果
QueryCacheEntityQueryCache 实体约束接口
QueryCacheEntityMetadata实体元数据,用于 QueryCache 新鲜度比较
QueryCacheFindOptions查询选项
QueryCacheLocalAdapterQueryCache 适配器接口(本地)
QueryCacheRemoteAdapterQueryCache 适配器接口(远程)
QueryTaskOptions查询任务选项接口
RelationEntitiesObservable多个关系对象的访问接口 提供对多个关联实体集合的观察和操作能力
RelationEntityObservable单个关系对象的访问接口 提供对单个关联实体的观察和操作能力
RemoteChange远程更改数据接口
RemoteSyncOptions远程同步配置选项
RepositoryIdentifierRepository identifier Uniquely identifies an entity type
RestoreEntityOptions-
RuleGroupBase查询规则组(基础) 用于生成的类型文件,可以组合出更多复杂的类型
RxDBAdaptersRxDB 适配器
RxDBBranchInitData初始化数据
RxDBBranchStaticTypes静态类型
RxDBChangeInitData初始化数据
RxDBChangeStaticTypes静态类型
RxDBContextRxDB 环境上下文
RxDBEntityEventMapRxDB 实体事件映射接口
RxDBEntityLocalCreatedEventData-
RxDBEntityLocalNewEventData-
RxDBEntityLocalRemovedEventData-
RxDBEntityLocalUpdatedEventData-
RxDBEntityRemoteCreatedEventData-
RxDBEntityRemoteRemovedEventData-
RxDBEntityRemoteUpdatedEventData-
RxDBEventMapRxDB 完整事件映射接口
RxDBMigrationInitData初始化数据
RxDBMigrationStaticTypes静态类型
RxDBMutationsMap-
RxDBOptionsRxDB 配置
RxDBSyncInitData初始化数据
RxDBSyncStaticTypes静态类型
SchemaManagerSchemaManager
StringArrayProperty字符串组
StringProperty-
SwitchBranchOptions-
SwitchVersionActions切换分支版本需要的操作
SwitchVersionChange-
SyncAdapterOptions同步适配器选项接口 定义数据同步适配器的配置
SyncRepositoryOptionsSync repository options
SyncRepositoryResultSync repository result
SyncResultSync 操作结果(pull + push 组合)
SyncStats同步统计信息
UUIDProperty-

Type Aliases

Type AliasDescription
AbstractEntityType抽象实体类型 表示不可直接实例化的抽象实体构造函数类型
AdapterFactoryRxDB 插件
BooleanRulesBoolean
ConflictResolution冲突解决结果
DateRulesDate
EntityBaseType实体基础类型
EntityData实体数据类型 通用的键值对数据对象
EntityMetadata实体元数据(只读版本) 实体元数据的只读深度副本,防止元数据被修改
EntityPropertyMetadata-
EntityPropertyMetadataOptions实体属性元数据联合类型 包含所有可能的属性类型元数据
EntityRelationManyToManyMetadata-
EntityRelationManyToOneMetadata-
EntityRelationMetadata-
EntityRelationMetadataOptions实体关系元数据联合类型 包含所有可能的关系类型(一对一、一对多、多对一、多对多)
EntityRelationOneToManyMetadata-
EntityRelationOneToOneMetadata-
EntityStaticType-
EntityType实体类型 表示可实例化的实体构造函数类型
EntityUpdateData实体更新数据类型 用于表示更新实体时传递的数据结构
HistoryScope历史记录作用域配置
HistoryScopeType历史记录作用域类型
IntegerRulesinteger
IQueryContext查询上下文
IRxDBAdapterOptions适配器基础配置
KeyValue值对象 存储键值队列
KeyValuePropertyMetadata-
KeyValueRuleskeyValue
NumberArrayRulesnumberArray
NumberRulesnumber
OperatorName所有操作符
PluginRxDB 插件
RefreshMatchRules刷新匹配规则 二维数组表示多组规则的组合,每组规则内的条件是 AND 关系,组与组之间是 OR 关系 例如:[['match_where', 'result_contains'], ['not_match_where']] 表示:(匹配查询条件 AND 结果包含) OR (不匹配查询条件)
RelationBooleanRulesBoolean
RelationDateRulesDate
RelationExistsRulesRelation EXISTS Rules SubRG 类型参数应为关联实体的 RuleGroup 类型
RelationNumberRulesnumber
RelationStringRulesstring
RelationUUIDRulesUUID
RepositoryConstructor仓库构造函数类型 确保注册的仓库是可实例化的具体类,而不是抽象类 支持带有额外泛型参数的仓库
RepositorySyncDirectionRepository 同步方向
RepositorySyncTypeRepository 同步类型
Rule查询规则
RuleGroup查询规则组(自动计算类型)
RxDBBranchOrderByFieldOrderByField
RxDBBranchRuleGroupRuleGroupBase
RxDBBranchTreeRuleGroupTreeRuleGroup
RxDBChangeOrderByFieldOrderByField
RxDBChangeRuleGroupRuleGroupBase
RxDBEntityEventRxDB 实体事件联合类型
RxDBEntityLocalEventDataRxDB 实体本地事件数据联合类型
RxDBEntityRemoteEventDataRxDB 实体远程事件数据联合类型
RxDBEventRxDB 事件联合类型
RxDBMigrationOrderByFieldOrderByField
RxDBMigrationRuleGroupRuleGroupBase
RxDBScalar标量类型 定义可以直接存储的基本数据类型
RxDBSyncOrderByFieldOrderByField
RxDBSyncRuleGroupRuleGroupBase
StringArrayRulesstringArray
StringRulesstring
SyncDirection同步方向
SyncOptions同步配置联合类型 包含所有可能的同步配置类型
TransactionFun事务回调函数
TreeEntityType树形实体类型
UUIDUUID类型 表示标准的UUID字符串格式 格式为:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
UUIDRulesUUID

Variables

VariableDescription
CONFLICT_DETECTED_EVENT冲突检测事件类型
CONFLICT_PENDING_EVENT冲突待处理事件类型
ENTITIES-
ENTITY_BASE_METADATA_OPTIONS-
ENTITY_LOCAL_CREATE_EVENT本地实体创建事件类型
ENTITY_LOCAL_NEW_EVENT本地实体初始化事件类型
ENTITY_LOCAL_REMOVE_EVENT本地实体删除事件类型
ENTITY_LOCAL_UPDATE_EVENT本地实体更新事件类型
ENTITY_REMOTE_CREATE_EVENT远程实体创建事件类型
ENTITY_REMOTE_REMOVE_EVENT远程实体删除事件类型
ENTITY_REMOTE_UPDATE_EVENT远程实体更新事件类型
ENTITY_STATIC_TYPES-
REMOTE_CHANGES_PENDING_EVENT远程变更待处理事件类型
REPOSITORY_SYNC_BEGIN_EVENTRepository 同步开始事件类型
REPOSITORY_SYNC_COMPLETE_EVENTRepository 同步完成事件类型
REPOSITORY_SYNC_ERROR_EVENTRepository 同步错误事件类型
SWITCH_BRANCH_BEGIN分支切换开始事件类型
SWITCH_BRANCH_COMMIT分支切换提交事件类型
SWITCH_BRANCH_ROLLBACK分支切换回滚事件类型
SYNC_BEGIN_EVENT同步开始事件类型
SYNC_COMPLETE_EVENT同步完成事件类型
SYNC_ERROR_EVENT同步错误事件类型
TRANSACTION_BEGIN事务开始事件类型
TRANSACTION_COMMIT事务提交事件类型
TRANSACTION_ROLLBACK事务回滚事件类型
TREE_ADJACENCY_LIST_ENTITY_BASE_OPTIONS-

Functions

FunctionDescription
__decorateClassclass 的装饰器 代码生成时会重复创建这个方法,所以统一引用 rxdb 里的减少代码量
cleanupExpired清理不再满足过滤条件的本地过期数据
compactChanges压缩变更列表为 SwitchVersionActions(专用于 Push 场景)
diffMetadataCompare remote metadata with local metadata to determine sync actions
Entity实体装饰器 用于将类标记为 RxDB 实体,并处理元数据、代理和生命周期
fillDefaultValue给实体实例填充默认值 根据元数据中定义的默认值,为实体的未赋值属性设置默认值
fillInitValue给实体实例填充初始值 根据提供的初始值对象,为实体的属性设置值,同时尊重只读属性
getEntityMetadata获取实体元数据
getEntityMutations获取实体变更映射
getEntityStatus获取实体状态
getEntityType获取实体类型
getNeedRemoveEntities获取需要删除的实体 从根实体开始递归查找所有需要删除的关联实体 注意:根实体本身不会被加入删除列表,只收集它们的关系中标记为删除的实体
getNeedSaveEntities获取需要保存的实体
getRxDBChangeKey构造业务实体的唯一键(用于 deletes/updates/inserts Map)
getSyncableRepositories获取需要同步的 repository 列表
getSyncConfig获取实体的有效同步配置(支持全局配置回退)
getSyncType从 EntityMetadata 获取同步类型
groupBySyncType按同步类型分组 repositories
isEntityInternalName判断字段名是否是内部保留字段 包括基类字段、私有字段和以下划线开头的字段
isNoSync检查 repository 是否完全不同步
isRuleGroup判断是否是 RuleGroup
isRxDBEntity检查是否为 RxDB 实体
needsPull-
needsPush检查 repository 是否需要 push
parseRxDBChangeKey解析实体键
queryNeedRefreshCreate-
queryNeedRefreshRemove-
queryNeedRefreshUpdate-
setSafeObjectKey设置安全的不可变属性 创建一个不可枚举、不可配置、不可写的属性
setSafeObjectKeyLazyInitOnce设置懒加载属性 创建一个只在首次访问时计算值的属性,后续访问直接返回计算结果
setSafeObjectWritableKey设置安全的可变属性 创建一个不可枚举、不可配置但可写的属性
transitionMetadata将元数据选项(metadataOptions)转换为实体元数据(metadata)
TreeEntity树形实体装饰器 用于将类标记为树形结构实体,并处理树形特定的元数据
uuid生成 uuid v7