basalt / search/src / SearchServiceOptions

Interface: SearchServiceOptions

Defined in: search/src/search.ts:218

Properties

driver?

> optional driver?: SearchDriver

Defined in: search/src/search.ts:219

---

indexes?

> optional indexes?: IndexDefinition[]

Defined in: search/src/search.ts:227

The index definitions. When an index is listed here, filters may only name its filterable fields (and tenantId); an index not listed keeps the old behaviour and passes any field to the driver. searchPlugin forwards its indexes.

---

maxLimit?

> optional maxLimit?: number

Defined in: search/src/search.ts:229

Largest limit a search may ask for. Default DEFAULT_MAX_LIMIT.

---

maxOffset?

> optional maxOffset?: number

Defined in: search/src/search.ts:231

Largest offset a search may ask for. Default DEFAULT_MAX_OFFSET.

---

maxScan?

> optional maxScan?: number

Defined in: search/src/search.ts:236

Ceiling on the driver rows one authorized search may scan (the per-call maxScan may only lower it). Default DEFAULT_MAX_SCAN.

---

rules?

> optional rules?: ReindexableRule[]

Defined in: search/src/search.ts:220