Skip to main content

Interface: GenericActionCtx<DataModel>

server.GenericActionCtx

A set of services for use within Convex action functions.

The context is passed as the first argument to any Convex action run on the server.

If you're using code generation, use the ActionCtx type in convex/_generated/server.d.ts which is typed for your data model.

Type parameters

NameType
DataModelextends GenericDataModel

Hierarchy

Properties

scheduler

scheduler: Scheduler

A utility for scheduling Convex functions to run in the future.

Defined in

server/registration.ts:174


auth

auth: Auth

Information about the currently authenticated user.

Defined in

server/registration.ts:179


storage

storage: StorageActionWriter

A utility for reading and writing files in storage.

Defined in

server/registration.ts:184

Methods

runQuery

runQuery<Query>(query, ...args): Promise<FunctionReturnType<Query>>

Run the Convex query with the given name and arguments.

Consider using an internalQuery to prevent users from calling the query directly.

Type parameters

NameType
Queryextends FunctionReference<"query", "public" | "internal">

Parameters

NameTypeDescription
queryQueryA FunctionReference for the query to run.
...argsOptionalRestArgs<Query>The arguments to the query function.

Returns

Promise<FunctionReturnType<Query>>

A promise of the query's result.

Defined in

server/registration.ts:134


runMutation

runMutation<Mutation>(mutation, ...args): Promise<FunctionReturnType<Mutation>>

Run the Convex mutation with the given name and arguments.

Consider using an internalMutation to prevent users from calling the mutation directly.

Type parameters

NameType
Mutationextends FunctionReference<"mutation", "public" | "internal">

Parameters

NameTypeDescription
mutationMutationA FunctionReference for the mutation to run.
...argsOptionalRestArgs<Mutation>The arguments to the mutation function.

Returns

Promise<FunctionReturnType<Mutation>>

A promise of the mutation's result.

Defined in

server/registration.ts:149


runAction

runAction<Action>(action, ...args): Promise<FunctionReturnType<Action>>

Run the Convex action with the given name and arguments.

Consider using an internalAction to prevent users from calling the action directly.

Type parameters

NameType
Actionextends FunctionReference<"action", "public" | "internal">

Parameters

NameTypeDescription
actionActionA FunctionReference for the action to run.
...argsOptionalRestArgs<Action>The arguments to the action function.

Returns

Promise<FunctionReturnType<Action>>

A promise of the action's result.

Defined in

server/registration.ts:166


vectorSearch

vectorSearch<TableName, IndexName>(tableName, indexName, query): Promise<{ _id: GenericId<TableName> ; _score: number }[]>

Run a vector search on the given table and index.

Type parameters

NameType
TableNameextends string
IndexNameextends string | number | symbol

Parameters

NameTypeDescription
tableNameTableNameThe name of the table to query.
indexNameIndexNameThe name of the vector index on the table to query.
queryObjectA VectorSearchQuery containing the vector to query, the number of results to return, and any filters.
query.vectornumber[]The query vector. This must have the same length as the dimensions of the index. This vector search will return the IDs of the documents most similar to this vector.
query.limit?numberThe number of results to return. If specified, must be between 1 and 256 inclusive. Default ts 10
query.filter?(q: VectorFilterBuilder<DocumentByInfo<NamedTableInfo<DataModel, TableName>>, NamedVectorIndex<NamedTableInfo<DataModel, TableName>, IndexName>>) => FilterExpression<boolean>Optional filter expression made up of q.or and q.eq operating over the filter fields of the index. e.g. filter: q => q.or(q.eq("genre", "comedy"), q.eq("genre", "drama"))

Returns

Promise<{ _id: GenericId<TableName> ; _score: number }[]>

A promise of IDs and scores for the documents with the nearest vectors

Defined in

server/registration.ts:196