ContextQMD
Back to Better Auth

Prisma

docs/content/docs/adapters/prisma.mdx

1.6.263.2 KB
Original Source

Prisma ORM is an open-source database toolkit that simplifies database access and management in applications by providing a type-safe query builder and an intuitive data modeling interface.

Before getting started, make sure you have Prisma installed and configured. For more information, see Prisma Documentation

Installation

To use the Prisma adapter, you need to install the @better-auth/prisma-adapter package:

package-install
@better-auth/prisma-adapter

Example Usage

You can use the Prisma adapter to connect to your database as follows.

ts
import { betterAuth } from "better-auth";
import { prismaAdapter } from "better-auth/adapters/prisma";
import { PrismaClient } from "@prisma/client";

const prisma = new PrismaClient();

export const auth = betterAuth({
  database: prismaAdapter(prisma, {
    provider: "sqlite",
  }),
});
<Callout type="warning"> Starting from Prisma 7, the `output` path field is required. If you have configured a custom output path in your `schema.prisma` file (e.g., `output = "../src/generated/prisma"`), make sure to [import the Prisma client from that location](https://www.prisma.io/docs/orm/prisma-client/setup-and-configuration/generating-prisma-client#the-location-of-prisma-client) instead of `@prisma/client`. </Callout>

Schema generation & migration

The Better Auth CLI allows you to generate or migrate your database schema based on your Better Auth configuration and plugins.

<table> <thead> <tr className="border-b"> <th> <p className="font-bold text-[16px] mb-1">Prisma Schema Generation</p> </th> 
  <th>
    <p className="font-bold text-[16px] mb-1">Prisma Schema Migration</p>
  </th>
</tr>
</thead> <tbody> <tr className="h-10"> <td>✅ Supported</td> <td>❌ Not Supported</td> </tr> </tbody> </table>
package-install
npx auth@latest generate

Joins (Experimental)

Database joins is useful when Better-Auth needs to fetch related data from multiple tables in a single query. Endpoints like /get-session, /get-full-organization and many others benefit greatly from this feature, seeing upwards of 2x to 3x performance improvements depending on database latency.

The Prisma adapter supports joins out of the box since version 1.4.0. To enable this feature, you need to set the experimental.joins option to true in your auth configuration.

ts
import { betterAuth } from "better-auth";

export const auth = betterAuth({
  experimental: { joins: true }
});
<Callout type="warn"> Please make sure that your Prisma schema has the necessary relations defined. If you do not see any relations in your Prisma schema, you can manually add them using the `@relation` directive or run our latest CLI version `npx auth@latest generate` to generate a new Prisma schema with the relations. </Callout>

Additional Information