Skip to content

basalt / search/src / ReindexOptions

Interface: ReindexOptions ​

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

Which part of an index reindex() rebuilds.

Inside a tenant context (a request, tenancy.run, tenancy.forEach) the rebuild is scoped to that tenant by default — the same rule every other Search call follows — so tenancy.run(id, () => search.reindex(name)) over a database-per-tenant backfill rebuilds that tenant and leaves the others alone.

Properties ​

all? ​

> optional all?: boolean

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

Rebuild the whole index, every tenant: clear + every backfill row. Only outside a tenant context (SearchReindexScopeError inside one), and the backfill must then yield every tenant's records.


tenantId? ​

> optional tenantId?: string

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

Rebuild only this tenant's documents: clearTenant + the backfill rows mapped to this tenant (rows of other tenants are skipped). Inside a tenant context it must name that tenant (SearchTenantMismatchError).

Released under the MIT License.