Class: SearchIndex
A handle bound to one index. Modeled on Meilisearch’s client.index(uid):
search / autocomplete read, addDocuments / deleteDocuments write (to
a direct-access index), and info fetches the live definition.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SearchIndex(
name,client):SearchIndex
Parameters
Section titled “Parameters”string
client
Section titled “client”Returns
Section titled “Returns”SearchIndex
Properties
Section titled “Properties”
readonlyname:string
Methods
Section titled “Methods”addDocuments()
Section titled “addDocuments()”addDocuments(
documents,signal?):Promise<{count:number;index:string; }>
Add or update documents in this (direct-access) index.
Parameters
Section titled “Parameters”documents
Section titled “documents”Record<string, unknown>[]
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<{ count: number; index: string; }>
autocomplete()
Section titled “autocomplete()”autocomplete(
prefix,options?):Promise<{count:number;hits:object[];index?:string;query:string; }>
Autocomplete against this index: a search with a small default limit and
the raw prefix as the query. Hybrid mode already handles prefixes, so this
is a self-documenting alias rather than a separate code path.
Parameters
Section titled “Parameters”prefix
Section titled “prefix”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ count: number; hits: object[]; index?: string; query: string; }>
delete()
Section titled “delete()”delete(
signal?):Promise<void>
Delete this index.
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
deleteDocuments()
Section titled “deleteDocuments()”deleteDocuments(
ids,signal?):Promise<{count:number;index:string; }>
Delete documents from this (direct-access) index by primary key.
Parameters
Section titled “Parameters”(string | number)[]
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<{ count: number; index: string; }>
ensure()
Section titled “ensure()”ensure(
options?):Promise<{columns:string[];directAccess?:boolean;endpoint?:string;name:string;primaryKey?:string;ready:boolean;rowCount?:number; }>
Create this index if it does not exist, otherwise return the existing one.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ columns: string[]; directAccess?: boolean; endpoint?: string; name: string; primaryKey?: string; ready: boolean; rowCount?: number; }>
info()
Section titled “info()”info(
signal?):Promise<{columns:string[];directAccess?:boolean;endpoint?:string;name:string;primaryKey?:string;ready:boolean;rowCount?:number; }>
Fetch this index’s live definition (primary key, columns, readiness).
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<{ columns: string[]; directAccess?: boolean; endpoint?: string; name: string; primaryKey?: string; ready: boolean; rowCount?: number; }>
search()
Section titled “search()”search(
query,options?):Promise<{count:number;hits:object[];index?:string;query:string; }>
Search this index. See SearchClient.search.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ count: number; hits: object[]; index?: string; query: string; }>
sync()
Section titled “sync()”sync(
signal?):Promise<void>
Trigger a sync of this (Delta Sync) index from its source table.
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>