SearchServerArgs

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

Server-side args for search.

Inherits ctx, populate, depth, and config (with mutual-exclusion constraints) from GenericQueryServerParams.

Extends

• GenericQueryServerParams<DataModel, TCollectionSlug, TPopulate, D>

Type Parameters

DataModel

DataModel extends GenericDataModel

The Convex data model (inferred from ctx).

TCollectionSlug

TCollectionSlug extends CollectionSlug

Collection slug.

TPopulate

TPopulate extends PopulateShape<TCollectionSlug>

Populate object.

D

D extends number = 0

Depth literal (0 = no depth, default).

Properties

access?

optional access?: AccessCallOptions<QueryCallAction>

Defined in: packages/core/src/api/types.ts:216

Per-call access overrides.

See

AccessCallOptions

Inherited from

GenericQueryServerParams.access

---

auth?

optional auth?: VexApiAuth

Defined in: packages/core/src/api/types.ts:223

The auth config of the current user making the query.

Example

{ user: {...}, organization: {...} }

Inherited from

GenericQueryServerParams.auth

---

collection

collection: TCollectionSlug

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

The collection to search — must match a registered collection slug.

---

config?

optional config?: [TPopulate] extends [Record<string, never>] ? VexConfig : never

Defined in: packages/core/src/api/types.ts:241

The resolved VexConfig. Required alongside depth; passed from the queryApi factory closure so the Convex handler has schema info.

Inherited from

GenericQueryServerParams.config

---

ctx

ctx: GenericQueryCtx<DataModel>

Defined in: packages/core/src/api/types.ts:225

Discriminator: server args MUST supply a Convex query context.

Inherited from

GenericQueryServerParams.ctx

---

depth?

optional depth?: [TPopulate] extends [Record<string, never>] ? D : never

Defined in: packages/core/src/api/types.ts:236

Auto-populate all relationship fields to this many levels. Becomes never when TPopulate is non-empty. Use populate for consumer-facing code; this is an internal escape hatch for CollectionListView.

Inherited from

GenericQueryServerParams.depth

---

filter?

optional filter?: (q) => ExpressionOrValue<boolean>

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

Filter predicate applied after index narrowing. Equivalent to .filter(q => q.eq(q.field("published"), true)) on the Convex query.

Prefer withIndex for performance — filter scans every document in the range and is O(n). Use filter for secondary conditions that can’t be expressed as index equality ranges.

Parameters

q

FilterBuilder<NamedTableInfo<DataModel, TCollectionSlug extends TableNamesInDataModel<DataModel> ? TCollectionSlug : never>>

Returns

ExpressionOrValue<boolean>

Example

find({ ctx, collection: "posts", filter: q => q.eq(q.field("published"), true) })

---

limit?

optional limit?: number

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

Maximum number of results. Defaults to 20.

---

paginationOpts?

optional paginationOpts?: PaginationOptions

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

Pagination options. When provided, the function returns a PaginationResult with { page, continueCursor, isDone } instead of a plain array.

Uses Convex’s native .paginate(opts) API under the hood.

---

populate?

optional populate?: [D] extends [0] ? TPopulate : never

Defined in: packages/core/src/api/types.ts:230

Recursive populate object, type-narrowed against RelationshipKeysOf<TCollectionSlug>. Mutually exclusive with depth — becomes never when D ≠ 0.

Inherited from

GenericQueryServerParams.populate

---

query

query: string

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

The search text. Pass "" to list recent documents (falls back to .take()).

---

searchField

searchField: string

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

The field the search index is built on. Must match searchField in the index declaration.

---

searchIndexName

searchIndexName: string

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

The .searchIndex() name declared in the Convex schema (e.g. "search_name").