SqliteTreeRepository<T>

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteTreeRepository.ts:13

树形实体仓库

Extends

• SqliteRepository<T>

Type Parameters

Type Parameter
T extends EntityType

Implements

• ITreeRepository<T>

Constructors

Constructor

new SqliteTreeRepository<T>(adapter, EntityType): SqliteTreeRepository<T>;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepositoryBase.ts:14

Parameters

Parameter	Type
adapter	RxDBAdapterSqliteBase
EntityType	T

Returns

SqliteTreeRepository<T>

Inherited from

SqliteRepository.constructor

Properties

adapter

protected adapter: RxDBAdapterSqliteBase;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepositoryBase.ts:15

Inherited from

SqliteRepository.adapter

---

EntityType

readonly EntityType: T;

Defined in: packages/rxdb/dist/repository/RepositoryBase.d.ts:9

Inherited from

SqliteRepository.EntityType

---

metadata

readonly metadata: EntityMetadata;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepositoryBase.ts:12

Inherited from

SqliteRepository.metadata

---

rxdb

protected readonly rxdb: RxDB;

Defined in: packages/rxdb/dist/repository/RepositoryBase.d.ts:8

Inherited from

SqliteRepository.rxdb

---

_STATIC_METHODS

protected static _STATIC_METHODS: string[];

Defined in: packages/rxdb/dist/repository/RepositoryBase.d.ts:10

Inherited from

SqliteRepository._STATIC_METHODS

Accessors

staticMethods

Get Signature

get static staticMethods(): string[];

Defined in: packages/rxdb/dist/repository/RepositoryBase.d.ts:11

Returns

string[]

Inherited from

SqliteRepository.staticMethods

Methods

addQueryCache()

addQueryCache(sqliteSuccessResult, forcedUpdate?): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepositoryBase.ts:51

添加缓存

Parameters

Parameter	Type	Default value	Description
sqliteSuccessResult	SqliteSuccessResult	undefined	-
forcedUpdate	boolean	false	强制刷新，在数据有的情况下也会更新数据，在修改数据的情况下需要

Returns

Promise<InstanceType<T>[]>

Inherited from

SqliteRepository.addQueryCache

---

count()

count(options): Promise<number>;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepository.ts:38

查询实体数量

Parameters

Parameter	Type	Description
options	EntityStaticType<T, "countOptions">	查询选项

Returns

Promise<number>

Implementation of

ITreeRepository.count

Inherited from

SqliteRepository.count

---

countAncestors()

countAncestors(options): Promise<number>;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteTreeRepository.ts:35

查询祖先节点数量

Parameters

Parameter	Type
options	FindTreeOptions<T>

Returns

Promise<number>

Remarks

指定 entityId 时：不包含当前节点，只统计祖先数量

Implementation of

ITreeRepository.countAncestors

---

countDescendants()

countDescendants(options): Promise<number>;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteTreeRepository.ts:22

查询子孙实体数量

Parameters

Parameter	Type
options	FindTreeOptions<T>

Returns

Promise<number>

Remarks

• 指定 entityId 时：不包含当前节点，只统计后代数量
• 不指定 entityId 时：统计所有根节点及其后代的总数

Implementation of

ITreeRepository.countDescendants

---

create()

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

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepository.ts:44

创建实体

Parameters

Parameter	Type
entity	InstanceType<T>

Returns

Promise<InstanceType<T>>

Implementation of

ITreeRepository.create

Inherited from

SqliteRepository.create

---

createEntityRef()

createEntityRef(data): any;

Defined in: packages/rxdb/dist/repository/RepositoryBase.d.ts:17

获取实体实例

Parameters

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

Returns

any

Inherited from

SqliteRepository.createEntityRef

---

find()

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

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepository.ts:31

查询多个实体

Parameters

Parameter	Type	Description
options	EntityStaticType<T, "findOptions">	查询选项

Returns

Promise<InstanceType<T>[]>

Implementation of

ITreeRepository.find

Inherited from

SqliteRepository.find

---

findAncestors()

findAncestors(options): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteTreeRepository.ts:28

查询祖先节点

Parameters

Parameter	Type
options	FindTreeOptions<T>

Returns

Promise<InstanceType<T>[]>

Remarks

指定 entityId 时：包含当前节点 + 祖先节点

Implementation of

ITreeRepository.findAncestors

---

findByRowIds()

findByRowIds(rowIds): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepositoryBase.ts:22

Parameters

Parameter	Type
rowIds	bigint[]

Returns

Promise<InstanceType<T>[]>

Inherited from

SqliteRepository.findByRowIds

---

findDescendants()

findDescendants(options): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteTreeRepository.ts:14

查询子孙实体

Parameters

Parameter	Type
options	FindTreeOptions<T>

Returns

Promise<InstanceType<T>[]>

Remarks

• 指定 entityId 时：包含当前节点 + 子孙节点
• 不指定 entityId 时：返回所有根节点及其子孙

Implementation of

ITreeRepository.findDescendants

---

findOne()

findOne(options): Promise<InstanceType<T> | undefined>;

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepository.ts:26

Parameters

Parameter	Type
options	EntityStaticType<T, "findOneOptions">

Returns

Promise<InstanceType<T> | undefined>

Inherited from

SqliteRepository.findOne

---

get()

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

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepository.ts:14

Parameters

Parameter	Type
id	EntityStaticType<T, "idType">

Returns

Promise<InstanceType<T>>

Inherited from

SqliteRepository.get

---

getEntityRef()

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

Defined in: packages/rxdb/dist/repository/RepositoryBase.d.ts:22

获取实体实例

Parameters

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

Returns

InstanceType<T> | undefined

Inherited from

SqliteRepository.getEntityRef

---

hasEntityRef()

hasEntityRef(id): boolean;

Defined in: packages/rxdb/dist/repository/RepositoryBase.d.ts:27

获取实体实例

Parameters

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

Returns

boolean

Inherited from

SqliteRepository.hasEntityRef

---

remove()

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

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepository.ts:65

删除实体

Parameters

Parameter	Type
entity	InstanceType<T>

Returns

Promise<InstanceType<T>>

Implementation of

ITreeRepository.remove

Inherited from

SqliteRepository.remove

---

update()

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

Defined in: packages/rxdb-adapter-sqlite-core/src/repository/SqliteRepository.ts:54

更新实体

Parameters

Parameter	Type
entity	InstanceType<T>
patch	Partial<InstanceType<T>>

Returns

Promise<InstanceType<T>>

Implementation of

ITreeRepository.update

Inherited from

SqliteRepository.update

---

updateEntity()

updateEntity(entity, update): void;

Defined in: packages/rxdb/dist/repository/RepositoryBase.d.ts:31

更新实体

Parameters

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

Returns

void

Inherited from

SqliteRepository.updateEntity