跳到主要内容

IRxDBAdapter

Defined in: packages/rxdb/src/rxdb-adapter.ts:63

RxDB 数据库适配器接口

Properties

name

readonly name: string;

Defined in: packages/rxdb/src/rxdb-adapter.ts:67

适配器名称

Methods

connect()

connect(): Promise<IRxDBAdapter>;

Defined in: packages/rxdb/src/rxdb-adapter.ts:72

连接数据库

Returns

Promise<IRxDBAdapter>


disconnect()

disconnect(): Promise<void>;

Defined in: packages/rxdb/src/rxdb-adapter.ts:77

取消连接

Returns

Promise<void>


getRepository()

getRepository<T, RT>(EntityType): RT;

Defined in: packages/rxdb/src/rxdb-adapter.ts:88

获取仓库

Type Parameters

Type ParameterDefault type
T extends EntityType-
RT extends IRepository<T>IRepository<T>

Parameters

ParameterType
EntityTypeT

Returns

RT


isTableExisted()

isTableExisted(EntityType): Promise<boolean>;

Defined in: packages/rxdb/src/rxdb-adapter.ts:111

判断 table 是否存在

Parameters

ParameterType
EntityTypeEntityType

Returns

Promise<boolean>


mutations()

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

Defined in: packages/rxdb/src/rxdb-adapter.ts:106

批量修改实体(创建/更新/删除)

Type Parameters

Type Parameter
T extends EntityType

Parameters

ParameterTypeDescription
optionsRxDBMutationsMap<T>批量修改选项

Returns

Promise<InstanceType<T>[]>


rawQuery()?

optional rawQuery(sql, params?): Promise<RawQueryResult>;

Defined in: packages/rxdb/src/rxdb-adapter.ts:119

执行原始 SQL 查询(可选) 用于条件 UPDATE 等需要绕过 ORM 的场景

Parameters

ParameterTypeDescription
sqlstringSQL 语句
params?unknown[]绑定参数

Returns

Promise<RawQueryResult>


removeMany()

removeMany<T>(entities): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb/src/rxdb-adapter.ts:100

删除多个实体

Type Parameters

Type Parameter
T extends EntityType

Parameters

ParameterType
entitiesInstanceType<T>[]

Returns

Promise<InstanceType<T>[]>


saveMany()

saveMany<T>(entities): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb/src/rxdb-adapter.ts:94

保存多个实体

Type Parameters

Type Parameter
T extends EntityType

Parameters

ParameterType
entitiesInstanceType<T>[]

Returns

Promise<InstanceType<T>[]>


version()

version(): Promise<string>;

Defined in: packages/rxdb/src/rxdb-adapter.ts:82

获取数据库版本

Returns

Promise<string>