跳到主要内容

RxDBSync

Defined in: packages/rxdb/src/system/sync.ts:118

Repository 同步元数据表

追踪每个 repository 在每个分支上的同步状态，包括：

  • 同步类型（full/remote/local/none）
  • 最后推送/拉取时间
  • 最后推送/拉取的 changeId
  • 是否启用同步

Constructors​

Constructor​

new RxDBSync(): RxDBSync;

Returns​

RxDBSync

Properties​

branch?​

optional branch?: RxDBBranch;

Defined in: packages/rxdb/src/system/sync.ts:192

关联分支

branchId​

branchId: string;

Defined in: packages/rxdb/src/system/sync.ts:141

所属分支ID

createdAt​

createdAt: Date;

Defined in: packages/rxdb/src/system/sync.ts:182

创建时间

enabled​

enabled: boolean;

Defined in: packages/rxdb/src/system/sync.ts:177

是否启用同步（手动禁用开关）

entity​

entity: string;

Defined in: packages/rxdb/src/system/sync.ts:136

实体名称

Example​

"Todo"

id​

id: string;

Defined in: packages/rxdb/src/system/sync.ts:124

主键ID 格式: {namespace}:{entity}:{branchId}

Example​

"public:Todo:main"

lastPulledAt​

lastPulledAt: Date | null;

Defined in: packages/rxdb/src/system/sync.ts:167

最后拉取时间

lastPullRemoteChangeId​

lastPullRemoteChangeId: number | null;

Defined in: packages/rxdb/src/system/sync.ts:172

最后拉取的远程 changeId

lastPushedAt​

lastPushedAt: Date | null;

Defined in: packages/rxdb/src/system/sync.ts:162

最后推送时间

lastPushedChangeId​

lastPushedChangeId: number | null;

Defined in: packages/rxdb/src/system/sync.ts:157

最后推送的本地 changeId

namespace​

namespace: string;

Defined in: packages/rxdb/src/system/sync.ts:130

实体命名空间

Example​

"public"

remove​

remove: () => Promise<RxDBSync>;

Defined in: packages/rxdb/src/system/sync.ts:220

删除

Returns​

Promise<RxDBSync>

reset​

reset: () => void;

Defined in: packages/rxdb/src/system/sync.ts:224

重置数据

Returns​

void

save​

save: () => Promise<RxDBSync>;

Defined in: packages/rxdb/src/system/sync.ts:228

保存

Returns​

Promise<RxDBSync>

syncType​

syncType: "full" | "filter" | "none" | "local" | "remote" | "querycache";

Defined in: packages/rxdb/src/system/sync.ts:152

同步类型

  • full: 本地 ↔ 远程完全同步
  • filter: 本地 ↔ 远程条件同步（只同步满足条件的数据）
  • querycache: 查询缓存同步（根据查询结果集进行本地缓存与远程数据的一致性维护）
  • remote: 只读远程数据（只 pull，不 push）
  • local: 只在本地（只 push，不 pull）
  • none: 不同步（系统表或临时数据）

updatedAt​

updatedAt: Date;

Defined in: packages/rxdb/src/system/sync.ts:187

更新时间

count​

static count: (options) => Observable<number>;

Defined in: packages/rxdb/src/system/sync.ts:215

Parameters​

ParameterType
optionsCountOptions<typeof RxDBSync, RxDBSyncRuleGroup>

Returns​

Observable<number>

find​

static find: (options) => Observable<RxDBSync[]>;

Defined in: packages/rxdb/src/system/sync.ts:195

Parameters​

ParameterType
optionsFindOptions<typeof RxDBSync, RxDBSyncRuleGroup, RxDBSyncOrderByField>

Returns​

Observable<RxDBSync[]>

findAll​

static findAll: (options) => Observable<RxDBSync[]>;

Defined in: packages/rxdb/src/system/sync.ts:199

Parameters​

ParameterType
optionsFindAllOptions<typeof RxDBSync, RxDBSyncRuleGroup, RxDBSyncOrderByField>

Returns​

Observable<RxDBSync[]>

findByCursor​

static findByCursor: (options) => Observable<RxDBSync[]>;

Defined in: packages/rxdb/src/system/sync.ts:211

Parameters​

ParameterType
optionsFindByCursorOptions<typeof RxDBSync, RxDBSyncRuleGroup, RxDBSyncOrderByField>

Returns​

Observable<RxDBSync[]>

findOne​

static findOne: (options) => Observable<RxDBSync | undefined>;

Defined in: packages/rxdb/src/system/sync.ts:203

Parameters​

ParameterType
optionsFindOneOptions<typeof RxDBSync, RxDBSyncRuleGroup, RxDBSyncOrderByField>

Returns​

Observable<RxDBSync | undefined>

findOneOrFail​

static findOneOrFail: (options) => Observable<RxDBSync>;

Defined in: packages/rxdb/src/system/sync.ts:207

Parameters​

ParameterType
optionsFindOneOrFailOptions<typeof RxDBSync, RxDBSyncRuleGroup, RxDBSyncOrderByField>

Returns​

Observable<RxDBSync>