RxDBPluginSearch

Defined in: packages/rxdb-plugin-search/src/plugin.ts:79

@aiao/rxdb-plugin-search 主类。

职责：

• createRxDatabase 阶段校验 adapter（fail-fast）
• install() 阶段异步安装 FTS5 + backfill + 缓存 searchable 索引
• 在 RxDB 上挂载 search / searchCollection 入口
• 订阅 ENTITY_LOCAL_CREATE/UPDATE/REMOVE_EVENT 向注册的 handle 派发静默重查

Extends

• RxDBPluginBase

Implements

• IRxDBPlugin

Constructors

Constructor

new RxDBPluginSearch(rxdb, options?): RxDBPluginSearch;

Defined in: packages/rxdb-plugin-search/src/plugin.ts:106

Parameters

Parameter	Type
rxdb	RxDB
options?	SearchPluginOptions

Returns

RxDBPluginSearch

Overrides

RxDBPluginBase.constructor

Properties

name

readonly name: Uncapitalize<string> = 'search';

Defined in: packages/rxdb-plugin-search/src/plugin.ts:93

Implementation of

IRxDBPlugin.name

---

options

readonly options: SearchPluginOptions;

Defined in: packages/rxdb-plugin-search/src/plugin.ts:95

插件级默认项（页大小、防抖、snippet、排除 collection）

---

rxdb

protected readonly rxdb: RxDB;

Defined in: packages/rxdb/dist/rxdb-plugin.d.ts:14

Inherited from

RxDBPluginBase.rxdb

Accessors

ready

Get Signature

get ready(): Promise<void>;

Defined in: packages/rxdb-plugin-search/src/plugin.ts:102

当 FTS5 安装完成时 resolve；若失败则 reject，便于宿主应用在关键路径等待并处理 SearchSchemaMismatchError 等致命错误。插件不擅自记录日志；宿主通过显式 await 此 promise 决定错误展示与遥测策略。

Returns

Promise<void>

Methods

createHandle()

createHandle(performSearch, options?): SearchHandle;

Defined in: packages/rxdb-plugin-search/src/plugin.ts:197

直接以注入 performSearch 的方式创建 SearchHandle。

供框架绑定层与集成测试使用（便于 mock 执行器）；生产路径请使用 search / searchCollection。

Parameters

Parameter	Type	Description
performSearch	PerformSearch	真实查询执行函数；入参为归一化后的查询词与页号
options?	SearchOptions	单次调用级覆盖（debounce / initialQuery）

Returns

SearchHandle

---

destroy()

destroy(): void;

Defined in: packages/rxdb-plugin-search/src/plugin.ts:130

Returns

void

Implementation of

IRxDBPlugin.destroy

---

install()

install(): Promise<void>;

Defined in: packages/rxdb-plugin-search/src/plugin.ts:113

Returns

Promise<void>

Implementation of

IRxDBPlugin.install

---

search()

search(query, options?): SearchHandle;

Defined in: packages/rxdb-plugin-search/src/plugin.ts:151

跨 collection 聚合搜索入口。

query 可以是字符串（一次性查询）或 Observable<string>（对接输入流，自带防抖）。 SearchOptions.collections 用于进一步收窄范围（接受实体名或表名）； 包含未知名称或与插件级 excludedCollections 求交后为空时抛错（fail-fast）。

Parameters

Parameter	Type
query	string | Observable<string>
options?	SearchOptions

Returns

SearchHandle

---

searchCollection()

searchCollection(
   collection, 
   query, 
   options?): SearchHandle;

Defined in: packages/rxdb-plugin-search/src/plugin.ts:172

限定单个 collection（按实体名或表名）的搜索入口。

若给定 collection 未被索引（无 searchable 字段）或被 excludedCollections 排除，抛错； 宿主应在调用前通过 RxDBPluginSearch.ready 确认安装完成。

Parameters

Parameter	Type
collection	string
query	string | Observable<string>
options?	SearchOptions

Returns

SearchHandle