Interface: GenericQueryCtx<DataModel>
server.GenericQueryCtx
A set of services for use within Convex query functions.
The query context is passed as the first argument to any Convex query function run on the server.
This differs from the MutationCtx because all of the services are read-only.
Type parameters
| Name | Type |
|---|---|
DataModel | extends GenericDataModel |
Properties
db
• db: GenericDatabaseReader<DataModel>
A utility for reading data in the database.
Defined in
auth
• auth: Auth
Information about the currently authenticated user.
Defined in
storage
• storage: StorageReader
A utility for reading files in storage.
Defined in
runQuery
• runQuery: <Query>(query: Query, ...args: OptionalRestArgs<Query>) => Promise<FunctionReturnType<Query>>
Type declaration
▸ <Query>(query, ...args): Promise<FunctionReturnType<Query>>
Call a query function within the same transaction.
NOTE: often you can call the query's function directly instead of using this.
runQuery incurs overhead of running argument and return value validation,
and creating a new isolated JS context.
Type parameters
| Name | Type |
|---|---|
Query | extends FunctionReference<"query", "public" | "internal"> |
Parameters
| Name | Type |
|---|---|
query | Query |
...args | OptionalRestArgs<Query> |
Returns
Promise<FunctionReturnType<Query>>