Repository<T, RT>

Defined in: packages/rxdb/src/repository/Repository.ts:26

实体仓库 根据配置决策实体的具体操作

Extends

• RepositoryBase<T>

Extended by

• GraphRepository

Type Parameters

Type Parameter	Default type
T extends EntityType	-
RT extends IRepository<T>	IRepository<T>

Constructors

Constructor

new Repository<T, RT>(rxdb, EntityType): Repository<T, RT>;

Defined in: packages/rxdb/src/repository/Repository.ts:65

Parameters

Parameter	Type
rxdb	RxDB
EntityType	T

Returns

Repository<T, RT>

Overrides

RepositoryBase.constructor

Properties

EntityType

readonly EntityType: T;

Defined in: packages/rxdb/src/repository/RepositoryBase.ts:18

Inherited from

RepositoryBase.EntityType

---

local$

protected readonly local$: Observable<RT>;

Defined in: packages/rxdb/src/repository/Repository.ts:41

本地仓库

---

primary$

protected readonly primary$: Observable<RT>;

Defined in: packages/rxdb/src/repository/Repository.ts:53

主仓库（根据 SyncOptions 选择 local 或 remote）

• SyncType.None + 只有 remote：使用 remote$
• 其他情况：使用 local$

---

queryManager

protected readonly queryManager: QueryManager<T>;

Defined in: packages/rxdb/src/repository/Repository.ts:58

查询缓存管理器

---

remote$

protected readonly remote$: Observable<IRepository<T>>;

Defined in: packages/rxdb/src/repository/Repository.ts:46

远程仓库

---

rxdb

protected readonly rxdb: RxDB;

Defined in: packages/rxdb/src/repository/RepositoryBase.ts:17

Inherited from

RepositoryBase.rxdb

---

sync

readonly sync: SyncOptions;

Defined in: packages/rxdb/src/repository/Repository.ts:63

同步配置

---

_STATIC_METHODS

protected static _STATIC_METHODS: string[];

Defined in: packages/rxdb/src/repository/Repository.ts:27

Overrides

RepositoryBase._STATIC_METHODS

Accessors

staticMethods

Get Signature

get static staticMethods(): string[];

Defined in: packages/rxdb/src/repository/RepositoryBase.ts:12

Returns

string[]

Inherited from

RepositoryBase.staticMethods

Methods

_setLocal()

protected _setLocal(entity): void;

Defined in: packages/rxdb/src/repository/Repository.ts:275

设置状态 local

Parameters

Parameter	Type
entity	InstanceType<T>

Returns

void

---

_setLocals()

protected _setLocals(entities): void;

Defined in: packages/rxdb/src/repository/Repository.ts:280

Parameters

Parameter	Type
entities	InstanceType<T>[]

Returns

void

---

count()

count(options): Observable<number>;

Defined in: packages/rxdb/src/repository/Repository.ts:229

查询实体数量

Parameters

Parameter	Type	Description
options	CountOptions<T>	查询选项，包含 where 条件

Returns

Observable<number>

---

create()

create(entity): Promise<InstanceType<T>>;

Defined in: packages/rxdb/src/repository/Repository.ts:242

创建实体

Parameters

Parameter	Type	Description
entity	InstanceType<T>	要创建的实体实例

Returns

Promise<InstanceType<T>>

---

createEntityRef()

createEntityRef(data): any;

Defined in: packages/rxdb/src/repository/RepositoryBase.ts:25

获取实体实例

Parameters

Parameter	Type	Description
data	EntityUpdateData<T>	实体数据

Returns

any

Inherited from

RepositoryBase.createEntityRef

---

find()

find(options): Observable<InstanceType<T>[]>;

Defined in: packages/rxdb/src/repository/Repository.ts:161

查询多个实体

Parameters

Parameter	Type	Description
options	FindOptions<T>	查询选项，包含 where 条件、limit、offset 等

Returns

Observable<InstanceType<T>[]>

---

findAll()

findAll(options): Observable<InstanceType<T>[]>;

Defined in: packages/rxdb/src/repository/Repository.ts:179

查询所有实体

Parameters

Parameter	Type	Description
options	FindAllOptions<T>	查询选项，包含 where 条件和排序（不限制数量）

Returns

Observable<InstanceType<T>[]>

---

findByCursor()

findByCursor(options): Observable<InstanceType<T>[]>;

Defined in: packages/rxdb/src/repository/Repository.ts:196

通过游标进行分页查询

Parameters

Parameter	Type	Description
options	FindByCursorOptions<T>	游标分页选项，包含 orderBy、before/after 游标

Returns

Observable<InstanceType<T>[]>

---

findOne()

findOne(options): Observable<InstanceType<T> | null>;

Defined in: packages/rxdb/src/repository/Repository.ts:122

查找一个实体

Parameters

Parameter	Type	Description
options	FindOneOptions<T>	查询选项，包含 where 条件

Returns

Observable<InstanceType<T> | null>

---

findOneOrFail()

findOneOrFail(options): Observable<InstanceType<T>>;

Defined in: packages/rxdb/src/repository/Repository.ts:140

查找一个实体，查不到就抛出错误

Parameters

Parameter	Type	Description
options	FindOneOrFailOptions<T>	查询选项，包含 where 条件

Returns

Observable<InstanceType<T>>

---

get()

get(id): Observable<InstanceType<T>>;

Defined in: packages/rxdb/src/repository/Repository.ts:88

根据 id 获取实体

Parameters

Parameter	Type	Description
id	EntityStaticType<T, "idType">	实体的唯一标识符

Returns

Observable<InstanceType<T>>

---

getEntityRef()

getEntityRef(id): InstanceType<T> | undefined;

Defined in: packages/rxdb/src/repository/RepositoryBase.ts:33

获取实体实例

Parameters

Parameter	Type	Description
id	EntityStaticType<T, "idType">	实体的 ID

Returns

InstanceType<T> | undefined

Inherited from

RepositoryBase.getEntityRef

---

hasEntityRef()

hasEntityRef(id): boolean;

Defined in: packages/rxdb/src/repository/RepositoryBase.ts:41

获取实体实例

Parameters

Parameter	Type	Description
id	EntityStaticType<T, "idType">	实体的 ID

Returns

boolean

Inherited from

RepositoryBase.hasEntityRef

---

remove()

remove(entity): Promise<InstanceType<T>>;

Defined in: packages/rxdb/src/repository/Repository.ts:267

删除实体

Parameters

Parameter	Type	Description
entity	InstanceType<T>	要删除的实体实例

Returns

Promise<InstanceType<T>>

---

update()

update(entity, patch): Promise<InstanceType<T>>;

Defined in: packages/rxdb/src/repository/Repository.ts:255

更新实体

Parameters

Parameter	Type	Description
entity	InstanceType<T>	要更新的实体实例
patch	Partial<InstanceType<T>>	部分更新数据

Returns

Promise<InstanceType<T>>

---

updateEntity()

updateEntity(entity, update): void;

Defined in: packages/rxdb/src/repository/RepositoryBase.ts:48

更新实体

Parameters

Parameter	Type
entity	InstanceType<T>
update	InstanceType<T>

Returns

void

Inherited from

RepositoryBase.updateEntity