Services

Confect exposes Effect services that wrap Convex platform capabilities. These services are generated in confect/_generated/services.ts and are available when implementing your Confect functions and HTTP endpoint handlers.

import {
  ActionRunner,
  Auth,
  DatabaseReader,
  DatabaseWriter,
  MutationRunner,
  QueryRunner,
  Scheduler,
  StorageReader,
  StorageWriter,
  StorageActionWriter,
  VectorSearch,
} from "./_generated/services";

Database

`DatabaseReader`

Read documents from the database.

`DatabaseWriter`

Insert, edit, and delete documents from the database.

Function invocation

`QueryRunner`

Run Confect queries.

`MutationRunner`

Run Confect mutations.

`ActionRunner`

Run Confect actions.

Storage

`StorageReader`

Retrieve URLs for blobs in storage.

`StorageWriter`

Generate upload URLs and delete blobs.

`StorageActionWriter`

Get and store blobs.

Authentication

`Auth`

Access the current user’s identity.

Scheduling

`Scheduler`

Schedule Confect functions to run after a delay or at a specific time.

Search

`VectorSearch`

Query vector indexes for semantic similarity search.

Convex context

`QueryCtx`

Raw Convex query context.

`MutationCtx`

Raw Convex mutation context.

`ActionCtx`

Raw Convex action context.

Getting Started

Concepts

Server

Clients

Guides

Database

`DatabaseReader`

`DatabaseWriter`

Function invocation

`QueryRunner`

`MutationRunner`

`ActionRunner`

Storage

`StorageReader`

`StorageWriter`

`StorageActionWriter`

Authentication

`Auth`

Scheduling

`Scheduler`

Search

`VectorSearch`

Convex context

`QueryCtx`

`MutationCtx`

`ActionCtx`

​Database

​DatabaseReader

​DatabaseWriter

​Function invocation

​QueryRunner

​MutationRunner

​ActionRunner

​Storage

​StorageReader

​StorageWriter

​StorageActionWriter

​Authentication

​Auth

​Scheduling

​Scheduler

​Search

​VectorSearch

​Convex context

​QueryCtx

​MutationCtx

​ActionCtx

Database

`DatabaseReader`

`DatabaseWriter`

Function invocation

`QueryRunner`

`MutationRunner`

`ActionRunner`

Storage

`StorageReader`

`StorageWriter`

`StorageActionWriter`

Authentication

`Auth`

Scheduling

`Scheduler`

Search

`VectorSearch`

Convex context

`QueryCtx`

`MutationCtx`

`ActionCtx`