跳到主要内容

SearchEngineQuery

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:39

createSearchEngine().search(...) 入参。

Properties​

compiled​

readonly compiled: CompiledQuery | null;

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:61

已编译查询；null 直接返回空数组

entity​

readonly entity: string;

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:53

业务实体名（面向展示）

fields​

readonly fields: readonly string[];

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:57

参与搜索的字段列表；顺序 = FTS5 列声明顺序（列索引从 0 起）

fieldSpecs?​

readonly optional fieldSpecs?: readonly FtsField[];

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:59

字段元数据，用于构造 array/scalar 安全 snippet

offset​

readonly offset: number;

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:65

内存 over-fetch 偏移。每字段子查询取 offset + pageSize 行，SQL OFFSET 固定为 0

pageSize​

readonly pageSize: number;

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:63

单页结果数上限

primaryKey​

readonly primaryKey: string;

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:55

业务表主键列名（= FTS5 rowid）

schema?​

readonly optional schema?: string;

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:51

PostgreSQL schema 名（= 实体的 namespace）；SQLite 后端忽略。

与 SearchEngineQuery.sqlTable 是同一个 namespace 的两种落法， 不能互相替代：pg 适配器建的是 "<namespace>"."<table>"， sqlite 适配器建的是 <namespace>$<table>。

snippetLength?​

readonly optional snippetLength?: number;

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:67

snippet 长度（字符），默认 120

sqlTable?​

readonly optional sqlTable?: string;

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:43

SQLite 物理表名（含 namespace 前缀）

table​

readonly table: string;

Defined in: packages/rxdb-plugin-search/src/core/search-engine.ts:41

业务表名