authDbApi
authDbApi<
DataModel>(options):object
Defined in: packages/better-auth/src/convex/index.ts:53
Creates the auth DB operations as proper Convex functions.
Use this in www/convex/auth/db.ts to export the db operations:
import { authDbApi } from "@vexcms/better-auth/convex"import { internalMutation, internalQuery } from "../../_generated/server"import schema from "../schema"
export const { dbCreate, dbFindOne, dbFindMany, dbCount, dbUpdate, dbUpdateMany, dbDelete, dbDeleteMany } = authDbApi({ schema, internalMutation, internalQuery,})This follows the exact same pattern as queryApi/mutationApi in @vexcms/core. The returned functions are proper Convex FunctionReferences available as internal.auth.db.dbCreate, etc. in the user’s Convex API.
Type Parameters
Section titled “Type Parameters”DataModel
Section titled “DataModel”DataModel extends GenericDataModel
Parameters
Section titled “Parameters”options
Section titled “options”AuthDbApiOptions<DataModel>
The user’s Convex schema plus their internalMutation
and internalQuery builders, used to construct the auth DB functions.
Returns
Section titled “Returns”object
An object exposing dbCreate, dbFindOne, dbFindMany,
dbCount, dbUpdate, dbUpdateMany, dbDelete, and dbDeleteMany as
internal Convex function references, ready to re-export from the
user’s Convex API.
dbCount
Section titled “dbCount”dbCount:
RegisteredQuery<"internal", {betterAuthSchema:string;model:string;where?:any[]; },Promise<number>>
dbCreate
Section titled “dbCreate”dbCreate:
RegisteredMutation<"internal", {betterAuthSchema:string;data:any;model:string;select?:string[]; },Promise<GenericDocument|null>>
dbDelete
Section titled “dbDelete”dbDelete:
RegisteredMutation<"internal", {betterAuthSchema:string;model:string;where:any[]; },Promise<void>>
dbDeleteMany
Section titled “dbDeleteMany”dbDeleteMany:
RegisteredMutation<"internal", {betterAuthSchema:string;model:string;where:any[]; },Promise<number>>
dbFindMany
Section titled “dbFindMany”dbFindMany:
RegisteredQuery<"internal", {betterAuthSchema:string;limit?:number;model:string;sortBy?: {direction:"asc"|"desc";field:string; };where?:any[]; },Promise<any[]>>
dbFindOne
Section titled “dbFindOne”dbFindOne:
RegisteredQuery<"internal", {betterAuthSchema:string;model:string;select?:string[];where:any[]; },Promise<GenericDocument|null>>
dbUpdate
Section titled “dbUpdate”dbUpdate:
RegisteredMutation<"internal", {betterAuthSchema:string;model:string;update:any;where:any[]; },Promise<GenericDocument|null>>
dbUpdateMany
Section titled “dbUpdateMany”dbUpdateMany:
RegisteredMutation<"internal", {betterAuthSchema:string;model:string;update:any;where:any[]; },Promise<number>>