searchServer

Search documents in a collection with optional pagination and total count.

When includeTotalCount=true, runs .collect() on the first page to count all matching search results. Returns null if count exceeds 32k documents.

Param

args

Search arguments including query, filters, pagination, and count options

Example

// With pagination and count (first page only)
const result = await search({
  ctx,
  collection: "posts",
  query: "react hooks",
  searchIndexName: "search_posts",
  searchField: "title",
  paginationOpts: { numItems: 100, cursor: null },
  includeTotalCount: true,
});
// result: { page: [...], continueCursor: "...", isDone: false, totalCount: 42 }

Call Signature

searchServer<DataModel, TCollectionSlug, TPopulate, D>(args): Promise<DocReturnItem<TCollectionSlug, TPopulate, D>[]>

Defined in: packages/core/src/api/search/server.ts:84

Type Parameters

DataModel

DataModel extends GenericDataModel

TCollectionSlug

TCollectionSlug extends string

TPopulate

TPopulate extends PopulateShape<TCollectionSlug> = Record<string, never>

D

D extends number = 0

Parameters

args

SearchServerArgs<DataModel, TCollectionSlug, TPopulate, D> & object

Returns

Promise<DocReturnItem<TCollectionSlug, TPopulate, D>[]>