Prisma Client API

The Prisma Client API reference documentation is based on the following schema:

model User {
  id           Int              @id @default(autoincrement())
  name         String?
  email        String           @unique
  profileViews Int              @default(0)
  role         Role             @default(USER)
  coinflips    Boolean[]
  posts        Post[]
  city         String
  country      String
  profile      ExtendedProfile?
  pets         Json
}

model ExtendedProfile {
  id     Int     @id @default(autoincrement())
  userId Int?    @unique
  bio    String?
  User   User?   @relation(fields: [userId], references: [id])
}

model Post {
  id        Int     @id @default(autoincrement())
  title     String
  published Boolean @default(true)
  author    User    @relation(fields: [authorId], references: [id])
  authorId  Int
  comments  Json
  views     Int     @default(0)
  likes     Int     @default(0)
}

enum Role {
  USER
  ADMIN
}

All example generated types (such as UserSelect and UserWhereUniqueInput) are based on the User model.

PrismaClient

This section describes the PrismaClient constructor and its parameters.

adapter

Specifies a driver adapter for database connections. Required unless using accelerateUrl.

Example

import { PrismaPg } from "@prisma/adapter-pg";
import { PrismaClient } from "../prisma/generated/client";

const adapter = new PrismaPg({ connectionString: process.env.DATABASE_URL });
const prisma = new PrismaClient({ adapter });

accelerateUrl

Specifies a Prisma Accelerate URL for remote query execution. Required unless using adapter.

Example

import { PrismaClient } from "../prisma/generated/client";

const prisma = new PrismaClient({
  accelerateUrl: process.env.ACCELERATE_URL,
});

log

Determines the type and level of logging. See also: Logging

Options

Log levels

For relational databases this logs all SQL queries. Example: prisma:query SELECT "public"."User"."id", "public"."User"."email" FROM "public"."User" WHERE ("public"."User"."id") IN (SELECT "t0"."id" FROM "public"."User" AS "t0" INNER JOIN "public"."Post" AS "j0" ON ("j0"."authorId") = ("t0"."id") WHERE ("j0"."views" > $1 AND "t0"."id" IS NOT NULL)) OFFSET $2

For MongoDB this logs queries using the mongosh shell format. Example: prisma:query db.User.deleteMany({ _id: ( $in: [ “6221ce49f756b0721fc00542”, ], }, }) | | info | Example: prisma:info Started http server on http://127.0.0.1:58471 | | warn | Warnings. | | error | Errors. |

Emit formats

Event types

The query event type:

export type QueryEvent = {
  timestamp: Date;
  query: string; // Query sent to the database
  params: string; // Query parameters
  duration: number; // Time elapsed (in milliseconds) between client issuing query and database responding - not only time taken to run query
  target: string;
};

Note that for MongoDB, the params and duration fields will be undefined.

All other log level event types:

export type LogEvent = {
  timestamp: Date;
  message: string;
  target: string;
};

Examples

Log query and info to stdout

import { PrismaClient } from "../prisma/generated/client";

const prisma = new PrismaClient({ log: ["query", "info"] });

async function main() {
  const countUsers = await prisma.user.count({});
}

main()
  .then(async () => {
    await prisma.$disconnect();
  })
  .catch(async (e) => {
    console.error(e);
    await prisma.$disconnect();
    process.exit(1);
  });

prisma:info  Starting a postgresql pool with 13 connections.
prisma:info  Started http server
prisma:query SELECT COUNT(*) FROM (SELECT "public"."User"."id" FROM "public"."User" WHERE 1=1 ORDER BY "public"."User"."coinflips" ASC OFFSET $1) AS "sub"

Log a query event to console

import { PrismaClient } from "../prisma/generated/client";

const prisma = new PrismaClient({
  log: [{ level: "query", emit: "event" }],
});

prisma.$on("query", (e) => {
  console.log(e);
});

async function main() {
  const countUsers = await prisma.user.count({});
}

main()
  .then(async () => {
    await prisma.$disconnect();
  })
  .catch(async (e) => {
    console.error(e);
    await prisma.$disconnect();
    process.exit(1);
  });

{
  timestamp: 2020-11-17T10:32:10.898Z,
  query: 'SELECT COUNT(*) FROM (SELECT "public"."User"."id" FROM "public"."User" WHERE 1=1 OFFSET $1) AS "sub"',
  params: '[0]',
  duration: 5,
  target: 'quaint::connector::metrics'
}

Log info, warn, and error events to console

import { PrismaClient } from "../prisma/generated/client";

const prisma = new PrismaClient({
  log: [
    { level: "warn", emit: "event" },
    { level: "info", emit: "event" },
    { level: "error", emit: "event" },
  ],
});

prisma.$on("warn", (e) => {
  console.log(e);
});

prisma.$on("info", (e) => {
  console.log(e);
});

prisma.$on("error", (e) => {
  console.log(e);
});

async function main() {
  const countUsers = await prisma.user.count({});
}

main()
  .then(async () => {
    await prisma.$disconnect();
  })
  .catch(async (e) => {
    console.error(e);
    await prisma.$disconnect();
    process.exit(1);
  });

{
  timestamp: 2020-11-17T10:33:24.592Z,
  message: 'Starting a postgresql pool with 13 connections.',
  target: 'quaint::pooled'
}
{
  timestamp: 2020-11-17T10:33:24.637Z,
  message: 'Started http server',
  target: 'query_engine::server'
}

errorFormat

Determines the level and formatting of errors returned by Prisma Client.

Error formats

Examples

No error formatting

const prisma = new PrismaClient({
  // Defaults to colorless
});

pretty error formatting

const prisma = new PrismaClient({
  errorFormat: "pretty",
});

colorless error formatting

const prisma = new PrismaClient({
  errorFormat: "colorless",
});

minimal error formatting

const prisma = new PrismaClient({
  errorFormat: "minimal",
});

comments

Defines an array of SQL commenter plugins that add metadata to your SQL queries as comments. This is useful for observability, debugging, and correlating queries with application traces.

Options

First-party plugins

Examples

Using first-party plugins

import { PrismaClient } from "../prisma/generated/client";
import { PrismaPg } from "@prisma/adapter-pg";
import { queryTags } from "@prisma/sqlcommenter-query-tags";
import { traceContext } from "@prisma/sqlcommenter-trace-context";

const adapter = new PrismaPg({ connectionString: process.env.DATABASE_URL });

const prisma = new PrismaClient({
  adapter,
  comments: [queryTags(), traceContext()],
});

Creating a custom plugin

import { PrismaClient } from "../prisma/generated/client";
import { PrismaPg } from "@prisma/adapter-pg";
import type { SqlCommenterPlugin } from "@prisma/sqlcommenter";

const appPlugin: SqlCommenterPlugin = (context) => ({
  application: "my-app",
  environment: process.env.NODE_ENV ?? "development",
  model: context.query.modelName,
  action: context.query.action,
});

const adapter = new PrismaPg({ connectionString: process.env.DATABASE_URL });

const prisma = new PrismaClient({
  adapter,
  comments: [appPlugin],
});

This produces SQL queries with comments like:

SELECT "id", "name" FROM "User" /*action='findMany',application='my-app',environment='production',model='User'*/

For more details, see SQL comments.

transactionOptions

Sets default transaction options globally.

Remarks

• The transaction levels can be overridden on a per-transaction level.

Options

Example

const prisma = new PrismaClient({
  transactionOptions: {
    isolationLevel: Prisma.TransactionIsolationLevel.Serializable,
    maxWait: 5000, // default: 2000
    timeout: 10000, // default: 5000
  },
});

Model queries

Use model queries to perform CRUD operations on your models. See also: CRUD

findUnique()

findUnique() query lets you retrieve a single database record:

• By ID
• By a unique attribute

Remarks

• Prisma Client's dataloader automatically batches findUnique() queries with the same select and where parameters.
• If you want the query to throw an error if the record is not found, then consider using findUniqueOrThrow instead.
• You cannot use filter conditions (e.g. equals, contains, not) to filter fields of the JSON data type. Using filter conditions will likely result in a null response for that field.

Options

Return type

Examples

Get the User record with an id of 42

const result = await prisma.user.findUnique({
  where: {
    id: 42,
  },
});

Get the User record with an email of [email protected]

const result = await prisma.user.findUnique({
  where: {
    email: "[email protected]",
  },
});

Get the User record with firstName of Alice and lastName of Smith (@@unique)

model User {
  firstName String
  lastName  String

  @@unique(fields: [firstName, lastName], name: "fullname")
}

const result = await prisma.user.findUnique({
  where: {
    fullname: {
      // name property of @@unique attribute - default is firstname_lastname
      firstName: "Alice",
      lastName: "Smith",
    },
  },
});

Get the User record with firstName of Alice and lastName of Smith (@@id)

model User {
  firstName String
  lastName  String

  @@id([firstName, lastName])
}

const result = await prisma.user.findUnique({
  where: {
    firstName_lastName: {
      firstName: "Alice",
      lastName: "Smith",
    },
  },
});

findUniqueOrThrow()

findUniqueOrThrow() retrieves a single record in the same way as findUnique(). However, if the query does not find the requested record, it throws a PrismaClientKnownRequestError.

Here's an example of its usage:

await prisma.user.findUniqueOrThrow({
  where: { id: 1 },
});

findUniqueOrThrow() differs from findUnique() as follows:

• Its return type is non-nullable. For example, post.findUnique() can return post or null, but post.findUniqueOrThrow() always returns post.

• It is not compatible with sequential operations in the $transaction API. If the query throws a PrismaClientKnownRequestError, then the API will not roll back any operations in the array of calls. As a workaround, you can use interactive transactions with the $transaction API, as follows:

  tsCopy

   $transaction(async (prisma) => {
     await prisma.model.create({ data: { ... });
     await prisma.model.findUniqueOrThrow();
   })
  

findFirst()

findFirst returns the first record in a list that matches your criteria.

Remarks

• If you want the query to throw an error if the record is not found, then consider using findFirstOrThrow instead.

Options

Return type

Remarks

• findFirst calls findMany behind the scenes and accepts the same query options.
• Passing in a negative take value when you use a findFirst query reverses the order of the list.

Examples

See Filter conditions and operators for examples of how to filter results.

Get the first User record where the name is Alice

const user = await prisma.user.findFirst({
  where: { name: "Alice" },
});

Get the first Post record where the title starts with A test, reverse the list with take

import { PrismaClient } from "../prisma/generated/client";

const prisma = new PrismaClient({});

async function main() {
  const a = await prisma.post.create({
    data: {
      title: "A test 1",
    },
  });

  const b = await prisma.post.create({
    data: {
      title: "A test 2",
    },
  });

  const c = await prisma.post.findFirst({
    where: {
      title: {
        startsWith: "A test",
      },
    },
    orderBy: {
      title: "asc",
    },
    take: -1, // Reverse the list
  });
}

main();

findFirstOrThrow()

findFirstOrThrow() retrieves a single data record in the same way as findFirst(). However, if the query does not find a record, it throws a PrismaClientKnownRequestError.

findFirstOrThrow() differs from findFirst() as follows:

• Its return type is non-nullable. For example, post.findFirst() can return post or null, but post.findFirstOrThrow always returns post.

• It is not compatible with sequential operations in the $transaction API. If the query returns PrismaClientKnownRequestError, then the API will not roll back any operations in the array of calls. As a workaround, you can use interactive transactions with the $transaction API, as follows:

  tsCopy

  prisma.$transaction(async (tx) => {
    await tx.model.create({ data: { ... });
    await tx.model.findFirstOrThrow();
  })
  

findMany()

findMany returns a list of records.

Options

Return type

Examples

See Filter conditions and operators for examples of how to filter results.

Get all User records where the name is Alice

const user = await prisma.user.findMany({
  where: { name: "Alice" },
});

create()

create creates a new database record.

Options

Return type

Remarks

• You can also perform a nested create - for example, add a User and two Post records at the same time.

Examples

Create a single new record with the only required field email

const user = await prisma.user.create({
  data: { email: "[email protected]" },
});

Create multiple new records

In most cases, you can carry out batch inserts with the createMany() or createManyAndReturn() queries. However, there are scenarios where create() is the best option to insert multiple records.

The following example results in two INSERT statements:

import { Prisma, PrismaClient } from "../prisma/generated/client";

const prisma = new PrismaClient({ log: ["query"] });

async function main() {
  let users: Prisma.UserCreateInput[] = [
    {
      email: "[email protected]",
      name: "Ari",
      profileViews: 20,
      coinflips: [true, false, false],
      role: "ADMIN",
    },
    {
      email: "[email protected]",
      name: "Elsa",
      profileViews: 20,
      coinflips: [true, false, false],
      role: "ADMIN",
    },
  ];

  await Promise.all(
    users.map(async (user) => {
      await prisma.user.create({
        data: user,
      });
    }),
  );
}

main()
  .then(async () => {
    await prisma.$disconnect();
  })
  .catch(async (e) => {
    console.error(e);
    await prisma.$disconnect();
    process.exit(1);
  });

prisma:query BEGIN
prisma:query INSERT INTO "public"."User" ("name","email","profileViews","role","coinflips") VALUES ($1,$2,$3,$4,$5) RETURNING "public"."User"."id"
prisma:query SELECT "public"."User"."id", "public"."User"."name", "public"."User"."email", "public"."User"."profileViews", "public"."User"."role", "public"."User"."coinflips" FROM "public"."User" WHERE "public"."User"."id" = $1 LIMIT $2 OFFSET $3
prisma:query INSERT INTO "public"."User" ("name","email","profileViews","role","coinflips") VALUES ($1,$2,$3,$4,$5) RETURNING "public"."User"."id"
prisma:query COMMIT
prisma:query SELECT "public"."User"."id", "public"."User"."name", "public"."User"."email", "public"."User"."profileViews", "public"."User"."role", "public"."User"."coinflips" FROM "public"."User" WHERE "public"."User"."id" = $1 LIMIT $2 OFFSET $3
prisma:query COMMIT

update()

update updates an existing database record.

Options

Return type

Remarks

• To perform arithmetic operations on update (add, subtract, multiply, divide), use atomic updates to prevent race conditions.
• You can also perform a nested update - for example, update a user and that user's posts at the same time.

Examples

Update the email of the User record with id of 1 to [email protected]

const user = await prisma.user.update({
  where: { id: 1 },
  data: { email: "[email protected]" },
});

upsert()

:::info

This section covers the usage of the upsert() operation. To learn about using nested upsert queries within update(), reference the linked documentation.

:::

upsert does the following:

• If an existing database record satisfies the where condition, it updates that record
• If no database record satisfies the where condition, it creates a new database record

Options

Return type

Remarks

• To perform arithmetic operations on update (add, subtract, multiply, divide), use atomic updates to prevent race conditions.
• If two or more upsert operations happen at the same time and the record doesn't already exist, then a race condition might happen. As a result, one or more of the upsert operations might throw a unique key constraint error. Your application code can catch this error and retry the operation. Learn more.
• Prisma ORM hands over upsert queries to the database where possible. Learn more.

Examples

Update (if exists) or create a new User record with an email of [email protected]

const user = await prisma.user.upsert({
  where: { id: 1 },
  update: { email: "[email protected]" },
  create: { email: "[email protected]" },
});

Unique key constraint errors on upserts

Problem

If multiple upsert operations happen at the same time and the record doesn't already exist, then one or more of the operations might return a unique key constraint error.

Cause

When Prisma Client does an upsert, it first checks whether that record already exists in the database. To make this check, Prisma Client performs a read operation with the where clause from the upsert operation. This has two possible outcomes, as follows:

• If the record does not exist, then Prisma Client creates that record.
• If the record exists, then Prisma Client updates it.

When your application tries to perform two or more concurrent upsert operations, then a race condition might happen where two or more operations do not find the record and therefore try to create that record. In this situation, one of the operations successfully creates the new record but the other operations fail and return a unique key constraint error.

Solution

Handle the P2002 error in your application code. When it occurs, retry the upsert operation to update the row.

Database upserts

Where possible, Prisma Client hands over an upsert query to the database. This is called a database upsert.

Database upserts have the following advantages:

• They are faster than upserts handled by Prisma Client
• Unique key constraint errors cannot happen

Prisma Client uses a database upsert automatically when specific criteria are met. When these criteria are not met, Prisma Client handles the upsert.

To use a database upsert, Prisma Client sends the SQL construction INSERT ... ON CONFLICT SET .. WHERE to the database.

Database upsert prerequisites

Prisma Client uses database upserts with CockroachDB, PostgreSQL, or SQLite data sources.

Database upsert query criteria

Prisma Client uses a database upsert for an upsert query when the query meets the following criteria:

• There are no nested queries in the upsert's create and update options
• The query does not include a selection that uses a nested read
• The query modifies only one model
• There is only one unique field in the upsert's where option
• The unique field in the where option and the unique field in the create option have the same value

If your query does not meet these criteria, then Prisma Client handles the upsert itself.

Database upsert examples

The following examples use this schema:

model User {
  id           Int    @id
  profileViews Int
  userName     String @unique
  email        String

  @@unique([id, profileViews])
}

The following upsert query meets all of the criteria, so Prisma Client uses a database upsert.

prisma.user.upsert({
  where: {
    userName: "Alice",
  },
  create: {
    id: 1,
    profileViews: 1,
    userName: "Alice",
    email: "[email protected]",
  },
  update: {
    email: "[email protected]",
  },
});

In this situation, Prisma uses the following SQL query:

INSERT INTO "public"."User" ("id","profileViews","userName","email") VALUES ($1,$2,$3,$4)
ON CONFLICT ("userName") DO UPDATE
SET "email" = $5 WHERE ("public"."User"."userName" = $6 AND 1=1) RETURNING "public"."User"."id", "public"."User"."profileViews", "public"."User"."userName", "public"."User"."email"

The following query has multiple unique values in the where clause, so Prisma Client does not use a database upsert:

prisma.User.upsert({
  where: {
    userName: "Alice",
    profileViews: 1,
    id: 1,
  },
  create: {
    id: 1,
    profileViews: 1,
    userName: "Alice",
    email: "[email protected]",
  },
  update: {
    email: "[email protected]",
  },
});

In the following query, the values for userName in the where and create options are different, so Prisma Client does not use a database upsert.

prisma.User.upsert({
  where: {
    userName: "Alice",
  },
  create: {
    id: 1,
    profileViews: 1,
    userName: "AliceS",
    email: "[email protected]",
  },
  update: {
    email: "[email protected]",
  },
});

In the following query, the selection on the title field in posts is a nested read, so Prisma Client does not use a database upsert.

prisma.user.upsert({
  select: {
    email: true,
    id: true,
    posts: {
      select: {
        title: true,
      },
    },
  },
  where: {
    userName: "Alice",
  },

  create: {
    id: 1,
    profileViews: 1,
    userName: "Alice",
    email: "[email protected]",
  },
  update: {
    email: "[email protected]",
  },
});

delete()

delete deletes an existing database record. You can delete a record:

• By ID
• By a unique attribute

To delete records that match a certain criteria, use deleteMany with a filter.

Options

Return type

Remarks

• To delete multiple records based on some criteria (for example, all User records with a prisma.io email address, use deleteMany)

Examples

Delete the User record with an id of 1

const user = await prisma.user.delete({
  where: { id: 1 },
});

Delete the User record where email equals [email protected]

The following query deletes a specific user record and uses select to return the name and email of the deleted user:

const deleteUser = await prisma.user.delete({
  where: {
    email: "[email protected]",
  },
  select: {
    email: true,
    name: true,
  },
});

{ "email": "[email protected]", "name": "Elsa" }

createMany()

createMany creates multiple records in a transaction.

Options

Return type

Remarks

• createMany() is supported by SQLite.
• The skipDuplicates option is not supported by MongoDB, SQLServer, or SQLite.
• You cannot create or connect relations by using nested create, createMany, connect, connectOrCreate queries inside a top-level createMany() query. See here for a workaround.
• You can use a nested createMany query inside an update() or create() query - for example, add a User and two Post records with a nested createMany at the same time.

Examples

Create several new users

const users = await prisma.user.createMany({
  data: [
    { name: "Sonali", email: "[email protected]" },
    { name: "Alex", email: "[email protected]" },
  ],
});

createManyAndReturn()

createManyAndReturn creates multiple records and returns the resulting objects. Supported for PostgreSQL, CockroachDB, and SQLite.

Options

Remarks

• The skipDuplicates option is not supported by SQLite.
• Note that the order of elements returned by createManyAndReturn is not guaranteed.
• You cannot create or connect relations by using nested create, createMany, connect, connectOrCreate queries inside a top-level createManyAndReturn() query. See here for a workaround.
• When relations are included via include, a separate query is generated per relation.
• relationLoadStrategy: join is not supported.

Return type

Examples

Create and return several new users

const users = await prisma.user.createManyAndReturn({
  data: [
    { name: "Sonali", email: "[email protected]" },
    { name: "Alex", email: "[email protected]" },
  ],
});

[
  { "id": 0, "name": "Sonali", "email": "[email protected]", "profileViews": 0 },
  { "id": 1, "name": "Alex", "email": "[email protected]", "profileViews": 0 }
]

updateMany()

updateMany updates a batch of existing database records in bulk and returns the number of updated records.

Options

Return type

export type BatchPayload = {
  count: number;
};

Examples

Update all User records where the name is Alice to ALICE

const updatedUserCount = await prisma.user.updateMany({
  where: { name: "Alice" },
  data: { name: "ALICE" },
});

Update all User records where the email contains prisma.io and at least one related Post has more than 10 likes

const updatedUserCount = await prisma.user.updateMany({
  where: {
    email: {
      contains: "prisma.io",
    },
    posts: {
      some: {
        likes: {
          gt: 10,
        },
      },
    },
  },
  data: {
    role: "USER",
  },
});

Update User records where the email contains prisma.io, but limit to 5 records updated.

const updatedUserCount = await prisma.user.updateMany({
  where: {
    email: {
      contains: "prisma.io",
    },
  },
  data: {
    role: "USER",
  },
  limit: 5,
});

updateManyAndReturn()

updateManyAndReturn updates multiple records and returns the resulting objects. Supported for PostgreSQL, CockroachDB, and SQLite.

Options

Return type

Examples

Update and return multiple users

const users = await prisma.user.updateManyAndReturn({
  where: {
    email: {
      contains: "prisma.io",
    },
  },
  data: {
    role: "ADMIN",
  },
});

[
  { "id": 0, "name": "Sonali", "email": "[email protected]", "role": "ADMIN", "profileViews": 0 },
  { "id": 1, "name": "Alex", "email": "[email protected]", "role": "ADMIN", "profileViews": 0 }
]

deleteMany()

deleteMany deletes multiple records in a transaction.

Options

Return type

export type BatchPayload = {
  count: number;
};

Examples

Delete all User records

const deletedUserCount = await prisma.user.deleteMany({});

Delete all User records where the name is Alice

const deletedUserCount = await prisma.user.deleteMany({
  where: { name: "Alice" },
});

Delete all User records where the email contains prisma.io, but limit to 5 records deleted.

const deletedUserCount = await prisma.user.deleteMany({
  where: {
    email: {
      contains: "prisma.io",
    },
  },
  limit: 5,
});

See Filter conditions and operators for examples of how to filter the records to delete.

count()

Options

Return type

Examples

Count all User records

const result = await prisma.user.count();

Count all User records with at least one published Post

const result = await prisma.user.count({
  where: {
    post: {
      some: {
        published: true,
      },
    },
  },
});

Use select to perform three separate counts

The following query returns:

• A count of all records (_all)
• A count of all records with non-null name fields
• A count of all records with non-null city fields

const c = await prisma.user.count({
  select: {
    _all: true,
    city: true,
    name: true,
  },
});

aggregate()

See also: Aggregation, grouping, and summarizing

Options

Examples

Return _min, _max, and _count of profileViews of all User records

const minMaxAge = await prisma.user.aggregate({
  _count: {
    _all: true,
  },
  _max: {
    profileViews: true,
  },
  _min: {
    profileViews: true,
  },
});

{
  _count: { _all: 29 },
  _max: { profileViews: 90 },
  _min: { profileViews: 0 }
}

Return _sum of all profileViews for all User records

const setValue = await prisma.user.aggregate({
  _sum: {
    profileViews: true,
  },
});

{
  "_sum": {
    "profileViews": 9493
  }
}

groupBy()

See also: Aggregation, grouping, and summarizing

Options

Examples

Group by country/city where the average profileViews is greater than 200, and return the _sum of profileViews for each group

The query also returns a count of _all records in each group, and all records with non-null city field values in each group.

const groupUsers = await prisma.user.groupBy({
  by: ["country", "city"],
  _count: {
    _all: true,
    city: true,
  },
  _sum: {
    profileViews: true,
  },
  orderBy: {
    country: "desc",
  },
  having: {
    profileViews: {
      _avg: {
        gt: 200,
      },
    },
  },
});

[
  {
    country: "Denmark",
    city: "Copenhagen",
    _sum: { profileViews: 490 },
    _count: {
      _all: 70,
      city: 8,
    },
  },
  {
    country: "Sweden",
    city: "Stockholm",
    _sum: { profileViews: 500 },
    _count: {
      _all: 50,
      city: 3,
    },
  },
];

findRaw()

See: Using Raw SQL (findRaw()).

aggregateRaw()

See: Using Raw SQL (aggregateRaw()).

Model query options

select

select defines which fields are included in the object that Prisma Client returns. See: Select fields and include relations .

Remarks

• You cannot combine select and include on the same level.
• You can select a _count of relations.

Examples

Select the name and profileViews fields of a single User record

const result = await prisma.user.findUnique({
  where: { id: 1 },
  select: {
    name: true,
    profileViews: true,
  },
});

{
  name: "Alice",
  profileViews: 0
}

Select the email and role fields of a multiple User records

const result = await prisma.user.findMany({
  select: {
    email: true,
    role: true,
  },
});

[
  {
    email: "[email protected]",
    role: "ADMIN",
  },
  {
    email: "[email protected]",
    role: "USER",
  },
];

Select a _count of relations

const usersWithCount = await prisma.user.findMany({
  select: {
    _count: {
      select: { posts: true },
    },
  },
});

{
  _count: {
    posts: 3;
  }
}

Select the 'id' and 'title' fields of related Post records

const result = await prisma.user.findMany({
  select: {
    id: true,
    name: true,
    posts: {
      select: {
        id: true,
        title: true,
      },
    },
  },
});

[
  {
    id: 1,
    name: "Alice",
    posts: [
      { id: 1, title: "Hello World" },
      { id: 2, title: "Bye bye" },
    ],
  },
  {
    id: 2,
    name: "Bob",
    posts: [],
  },
];

include inside select

const result = await prisma.user.findMany({
  select: {
    id: true,
    name: true,
    posts: {
      include: {
        author: true,
      },
    },
  },
});

[
  {
    id: 1,
    name: "Alice",
    posts: [
      {
        id: 1,
        title: "Hello World",
        published: true,
        author: {
          id: 1,
          name: "Alice",
          email: "[email protected]",
          role: "ADMIN",
          coinflips: [true, false],
          profileViews: 0,
        },
      },
      {
        id: 2,
        title: "Bye bye",
        published: false,
        author: {
          id: 1,
          name: "Alice",
          email: "[email protected]",
          role: "USER",
          coinflips: [],
          profileViews: 0,
        },
      },
    ],
  },
];

include

include defines which relations are included in the result that Prisma Client returns. See: Select fields and include relations .

Remarks

• You can include a _count of relations.

Examples

Include the posts and profile relation when loading User records

const users = await prisma.user.findMany({
  include: {
    posts: true, // Returns all fields for all posts
    profile: true, // Returns all Profile fields
  },
});

Include the posts relation on the returned objects when creating a new User record with two Post records

const user = await prisma.user.create({
  data: {
    email: "[email protected]",
    posts: {
      create: [{ title: "This is my first post" }, { title: "Here comes a second post" }],
    },
  },
  include: { posts: true }, // Returns all fields for all posts
});

Generated types for include

The following example demonstrates how to use TypeScript's satisfies operator with include:

const includePosts = { posts: true } satisfies Prisma.UserInclude;

Include a _count of relations

const usersWithCount = await prisma.user.findMany({
  include: {
    _count: {
      select: { posts: true },
    },
  },
});

{ id: 1, name: "Bob", email: "[email protected]", _count: { posts: 3 } },
{ id: 2,  name: "Enya", email: "[email protected]", _count: { posts: 2 } }

omit

omit defines which fields are excluded in the object that Prisma Client returns.

Remarks

• You cannot combine omit and select since they serve opposite purposes.

Examples

Omit the password field from all User records

const result = await prisma.user.findMany({
  omit: {
    password: true,
  },
});

[
  {
    id: 1,
    email: "[email protected]",
    name: "Jenny",
  },
  {
    id: 2,
    email: "[email protected]",
    name: "Rose",
  },
];

Omit the title fields from all User's posts relation

const results = await prisma.user.findMany({
  omit: {
    password: true,
  },
  include: {
    posts: {
      omit: {
        title: true,
      },
    },
  },
});

[
  {
    id: 1,
    email: "[email protected]",
    name: "Jenny",
    posts: [
      {
        id: 1,
        author: {
          id: 1,
          email: "[email protected]",
          name: "Jenny",
        },
        authorId: 1,
      },
    ],
  },
  {
    id: 2,
    email: "[email protected]",
    name: "Rose",
    posts: [
      {
        id: 2,
        author: {
          id: 2,
          email: "[email protected]",
          name: "Rose",
        },
        authorId: 2,
      },
    ],
  },
];

Generated types for omit

The following example demonstrates how to use TypeScript's satisfies operator with omit:

const omitPassword = { password: true } satisfies Prisma.UserOmit;

relationLoadStrategy (Preview)

relationLoadStrategy specifies how a relation should be loaded from the database. It has two possible values:

• join (default): Uses a database-level LATERAL JOIN (PostgreSQL) or correlated subqueries (MySQL) and fetches all data with a single query to the database.
• query: Sends multiple queries to the database (one per table) and joins them on the application level.

Note: Once relationLoadStrategy moves from Preview into General Availability, join will universally become the default for all relation queries.

You can learn more about join strategies here.

Because the relationLoadStrategy option is currently in Preview, you need to enable it via the relationJoins preview feature flag in your Prisma schema file:

generator client {
  provider        = "prisma-client"
  output          = "./generated"
  previewFeatures = ["relationJoins"]
}

After adding this flag, you need to run prisma generate again to re-generate Prisma Client. The relationJoins feature is currently available on PostgreSQL, CockroachDB and MySQL.

Remarks

• In most situations, the default join strategy will be more effective. Use query if you want to save resources on your database server or if you profiling shows that the application-level join is more performant.
• You can only specify the relationLoadStrategy on the top-level in your query. The top-level choice will affect all nested sub-queries.

Examples

Load the posts relation via a database-level JOIN when using include

const users = await prisma.user.findMany({
  relationLoadStrategy: "join",
  include: {
    posts: true,
  },
});

Load the posts relation via a database-level JOIN when using select

const users = await prisma.user.findMany({
  relationLoadStrategy: "join",
  select: {
    posts: true,
  },
});

where

where defines one or more filters, and can be used to filter on record properties (like a user's email address) or related record properties (like a user's top 10 most recent post titles).

Examples

const results = await prisma.user.findMany({
  where: {
    email: {
      endsWith: "prisma.io",
    },
  },
});

Generated types for where

The following examples demonstrate how to use TypeScript's satisfies operator with where:

• UserWhereInput

  tsCopy

  // UserWhereInput
  const whereNameIs = { name: "Rich" } satisfies Prisma.UserWhereInput;
  
  // It can be combined with conditional operators too
  const whereNameIsWithAnd = {
    name: "Rich",
    AND: [
      {
        email: {
          contains: "[email protected]",
        },
      },
    ],
  } satisfies Prisma.UserWhereInput;
  

• UserWhereUniqueInput This type works by exposing any unique fields on the model. A field assigned @id is considered unique, as is one assigned @unique.

  This type exposes all fields on the model. This means that when you filter for a single record based on a unique field, you can check additional non-unique and unique fields at the same time. Learn more.

  tsCopy

  // UserWhereUniqueInput
  const whereEmailIsUnique = { email: "[email protected]" } satisfies Prisma.UserWhereUniqueInput;
  

• PostScalarWhereInput

  tsCopy

  const whereScalarTitleIs = { title: "boop" } satisfies Prisma.PostScalarWhereInput;
  

• PostUpdateWithWhereUniqueWithoutAuthorInput - This type accepts a unique where field (an @id or another assigned @unique) and updates any field on the Post model except the Author. The Author is the scalar field on the Post model.

  tsCopy

  const updatePostByIdWithoutAuthor = {
    where: { id: 1 },
    data: {
      content: "This is some updated content",
      published: true,
      title: "This is a new title",
    },
  } satisfies Prisma.PostUpdateWithWhereUniqueWithoutAuthorInput;
  

• PostUpsertWithWhereUniqueWithoutAuthorInput - This type will update the Post records title field where the id matches, if it doesn't exist it will create it instead.

  tsCopy

  const updatePostTitleOrCreateIfNotExist = {
    where: { id: 1 },
    update: { title: "This is a new title" },
    create: {
      id: 1,
      title: "If the title doesn't exist, then create one with this text",
    },
  } satisfies Prisma.PostUpsertWithWhereUniqueWithoutAuthorInput;
  

• PostUpdateManyWithWhereWithoutAuthorInput - This type will update all Post records where published is set to false.

  tsCopy

  const publishAllPosts = {
    where: { published: { equals: false } },
    data: { published: true },
  } satisfies Prisma.PostUpdateManyWithWhereWithoutAuthorInput;
  

orderBy

Sorts a list of records. See also: Sorting

Remarks

• You can order by relation fields - for example, order posts by the author's name.
• In PostgreSQL you can order by relevance. For details, see Sort by relevance.
• You can sort null records first or last. For details, see Sort with nulls first or last.

Inputs for sort argument

Inputs for nulls argument

Note:

• This argument is optional.
• For use on optional scalar fields only. If you try to sort by nulls on a required or relation field, Prisma Client throws a P2009 error.

Examples

Sort User by email field

The following example returns all User records sorted by email ascending:

const users = await prisma.user.findMany({
  orderBy: {
    email: "asc",
  },
});

The following example returns all User records sorted by email descending:

const users = await prisma.user.findMany({
  orderBy: {
    email: "desc",
  },
});

Sort Post by the related User record's name

The following query orders posts by user name:

const posts = await prisma.post.findMany({
  orderBy: {
    author: {
      name: "asc",
    },
  },
});

Sort Post by the related User record's name, with null records first

The following query orders posts by user name, with null records first:

const posts = await prisma.post.findMany({
  orderBy: {
    author: {
      name: { sort: "asc", nulls: "first" },
    },
  },
});

Sort Post by relevance of the title

:::info

For PostgreSQL, this feature is still in Preview. Enable the fullTextSearchPostgres feature flag in order to use it.

:::

The following query orders posts by relevance of the search term 'database' to the title:

const posts = await prisma.post.findMany({
  orderBy: {
    _relevance: {
      fields: ['title'],
      search: 'database',
      sort: 'asc'
    },
})

Sort User by the posts count

The following query orders users by post count:

const getActiveusers = await prisma.user.findMany({
  orderBy: {
    posts: {
      count: "desc",
    },
  },
});

Sort User by multiple fields - email and role

The following example sorts users by two fields - first email, then role:

const users = await prisma.user.findMany({
  select: {
    email: true,
    role: true,
  },
  orderBy: [
    {
      email: "desc",
    },
    {
      role: "desc",
    },
  ],
});

[
  {
    "email": "[email protected]",
    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "MODERATOR"
  },
  {
    "email": "[email protected]",
    "role": "MODERATOR"
  },
  {
    "email": "[email protected]",
    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "ADMIN"
  },
  {
    "email": "[email protected]",
    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "USER"
  }
]

The order of sorting parameters matters - the following query sorts by role, then email. Note the difference in the results:

const users = await prisma.user.findMany({
  select: {
    email: true,
    role: true,
  },
  orderBy: [
    {
      role: "desc",
    },
    {
      email: "desc",
    },
  ],
});

[
  {
    "email": "[email protected]",
    "role": "MODERATOR"
  },
  {
    "email": "[email protected]",
    "role": "MODERATOR"
  },
  {
    "email": "[email protected]",
    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "ADMIN"
  }
]

Sort User by email, select name and email

The following example returns all the name and email fields of all User records, sorted by email:

const users3 = await prisma.user.findMany({
  orderBy: {
    email: "asc",
  },
  select: {
    name: true,
    email: true,
  },
});

[
  {
    name: "Alice",
    email: "[email protected]",
  },
  {
    name: "Ariadne",
    email: "[email protected]",
  },
  {
    name: "Bob",
    email: "[email protected]",
  },
];

Sort User records by email and sort nested Post records by title

The following example:

• Returns all User records sorted by email
• For each User record, returns the title field of all nested Post records sorted by title

const usersWithPosts = await prisma.user.findMany({
  orderBy: {
    email: "asc",
  },
  include: {
    posts: {
      select: {
        title: true,
      },
      orderBy: {
        title: "asc",
      },
    },
  },
});

[
  {
    "id": 2,
    "email": "[email protected]",
    "name": "Alice",
    "posts": [
      {
        "title": "Watch the talks from Prisma Day 2019"
      }
    ]
  },
  {
    "id": 3,
    "email": "[email protected]",
    "name": "Ariadne",
    "posts": [
      {
        "title": "How to connect to a SQLite database"
      },
      {
        "title": "My first day at Prisma"
      }
    ]
  },
  {
    "id": 1,
    "email": "[email protected]",
    "name": "Bob",
    "posts": [
      {
        "title": "Follow Prisma on Twitter"
      },
      {
        "title": "Subscribe to GraphQL Weekly for community news "
      }
    ]
  }
]

Sort one user's nested list of Post records

The following example retrieves a single User record by ID, as well as a list of nested Post records sorted by title:

const userWithPosts = await prisma.user.findUnique({
  where: {
    id: 1,
  },
  include: {
    posts: {
      orderBy: {
        title: "desc",
      },
      select: {
        title: true,
        published: true,
      },
    },
  },
});

{
  "email": "[email protected]",
  "id": 1,
  "name": "Sarah",
  "extendedProfile": null,
  "role": "USER",
  "posts": [
    {
      "title": "Prisma Day 2020",
      "published": false
    },
    {
      "title": "My first post",
      "published": false
    },
    {
      "title": "All about databases",
      "published": true
    }
  ]
}

Sort by enum

The following sorts all User records by role (an enum):

const sort = await prisma.user.findMany({
  orderBy: {
    role: "desc",
  },
  select: {
    email: true,
    role: true,
  },
});

[
  {
    "email": "[email protected]",

    "role": "USER"
  },
  {
    "email": "[email protected]",
    "role": "ADMIN"
  },
  {
    "email": "[email protected]",
    "role": "ADMIN"
  },
  {
    "email": "[email protected]",
    "role": "ADMIN"
  }
]

Generated types for orderBy

The following examples demonstrate how to use TypeScript's satisfies operator with orderBy:

• UserOrderByInput
  tsCopy

  const orderEmailsByDescending = { email: "desc" } satisfies Prisma.UserOrderByInput;
  

distinct

Deduplicate a list of records from findMany or findFirst. See also: Aggregation, grouping, and summarizing

Examples

Select distinct on a single field

The following example returns all distinct city fields, and selects only the city and country fields:

const distinctCities = await prisma.user.findMany({
  select: {
    city: true,
    country: true,
  },
  distinct: ["city"],
});

[
  { city: "Paris", country: "France" },
  { city: "Lyon", country: "France" },
];

Select distinct on multiple fields

The following example returns all distinct city and country field combinations, and selects only the city and country fields:

const distinctCitiesAndCountries = await prisma.user.findMany({
  select: {
    city: true,
    country: true,
  },
  distinct: ["city", "country"],
});

[
  { city: "Paris", country: "France" },
  { city: "Paris", country: "Denmark" },
  { city: "Lyon", country: "France" },
];

Note that there is now a "Paris, Denmark" in addition to "Paris, France":

Select distinct in combination with a filter

The following example returns all distinct city and country field combinations where the user's email contains "prisma.io", and selects only the city and country fields:

const distinctCitiesAndCountries = await prisma.user.findMany({
  where: {
    email: {
      contains: "prisma.io",
    },
  },
  select: {
    city: true,
    country: true,
  },
  distinct: ["city", "country"],
});

[
  { city: "Paris", country: "Denmark" },
  { city: "Lyon", country: "France" },
];

nativeDistinct

Enabling nativeDistinct in your Prisma schema pushes the distinct operation to the database layer (where supported). This can significantly improve performance. However, note that:

• Some databases may not fully support DISTINCT on certain field combinations.
• Behavior can differ among providers.

To enable nativeDistinct:

generator client {
  provider        = "prisma-client"
  output          = "./generated"
  previewFeatures = ["nativeDistinct"]
}

See Preview Features for more details.

Nested queries

create

A nested create query adds a new related record or set of records to a parent record. See: Working with relations

Remarks

• create is available as a nested query when you create() (prisma.user.create(...)) a new parent record or update() (prisma.user.update(...)) an existing parent record.
• You can use a nested create or a nested createMany to create multiple related records. If you require the skipDuplicates query option you should use createMany.

Examples

Create a new User record with a new Profile record

const user = await prisma.user.create({
  data: {
    email: '[email protected]',
    profile: {
      create: { bio: 'Hello World' },
    },
  },
});

Create a new Profile record with a new User record

const user = await prisma.profile.create({
  data: {
    bio: "Hello World",
    user: {
      create: { email: "[email protected]" }, // [!code highlight]
    },
  },
});

Create a new User record with a new Post record

const user = await prisma.user.create({
  data: {
    email: "[email protected]",
    posts: {
      create: { title: "Hello World" },
    },
  },
});

Create a new User record with two new Post records

Because it's a one-to-many relation, you can also create multiple Post records at once by passing an array to create:

const user = await prisma.user.create({
  data: {
    email: "[email protected]",
    posts: {
      create: [
        {
          title: "This is my first post",
        },
        {
          title: "Here comes a second post",
        },
      ],
    },
  },
});

Note: You can also use a nested createMany to achieve the same result.

Update an existing User record by creating a new Profile record

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    profile: {
      create: { bio: "Hello World" },
    },
  },
});

Update an existing User record by creating a new Post record

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    posts: {
      create: { title: "Hello World" }, // [!code highlight]
    },
  },
});

createMany

A nested createMany query adds a new set of records to a parent record. See: Working with relations

Remarks

• createMany is available as a nested query when you create() (prisma.user.create(...)) a new parent record or update() (prisma.user.update(...)) an existing parent record.
  • Available in the context of a one-to-many relation — for example, you can prisma.user.create(...) a user and use a nested createMany to create multiple posts (posts have one user).
  • Not available in the context of a many-to-many relation — for example, you cannot prisma.post.create(...) a post and use a nested createMany to create categories (many posts have many categories).
• You cannot nest an additional create or createMany.
• Allows setting foreign keys directly — for example, setting the categoryId on a post.
• Nested createMany is supported by SQLite.
• You can use a nested create or a nested createMany to create multiple related records - if you do not need the skipDuplicates query option, you should probably use create.

Options [#nested-createmany-options]

Examples

Update a User and multiple new related Post records

const user = await prisma.user.update({
  where: {
    id: 9,
  },
  data: {
    name: "Elliott",
    posts: {
      createMany: {
        data: [{ title: "My first post" }, { title: "My second post" }],
      },
    },
  },
});

set

set overwrites the value of a relation - for example, replacing a list of Post records with a different list. See: Working with relations

Examples

Update an existing User record by disconnecting any previous Post records and connecting two other existing ones

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    posts: {
      set: [{ id: 32 }, { id: 42 }],
    },
  },
});

connect

A nested connect query connects a record to an existing related record by specifying an ID or unique identifier. See: Working with relations

Remarks

• connect is available as a nested query when you create a new parent record or update an existing parent record.

• If the related record does not exist, Prisma Client throws an exception:

  Copy

  The required connected records were not found. Expected 1 records to be connected, found 0.
  

• When using set and connect together, the order in which they are applied significantly impacts the result. If set is used before connect, the connected records will only reflect the final state established by the connect operation, as set clears all existing connections before connect establishes new ones. Conversely, if connect is applied before set, the set operation will override the connect action by clearing all connected records and replacing them with its own specified state.

Examples

Create a new Profile record and connect it to an existing User record via unique field

const user = await prisma.profile.create({
  data: {
    bio: "Hello World",
    user: {
      connect: { email: "[email protected]" },
    },
  },
});

Create a new Profile record and connect it to an existing User record via an ID field

const user = await prisma.profile.create({
  data: {
    bio: "Hello World",
    user: {
      connect: { id: 42 }, // sets userId of Profile record
    },
  },
});

You can also set the foreign key directly:

const user = await prisma.profile.create({
  data: {
    bio: "Hello World",
    userId: 42,
  },
});

However, you can't use both the direct approach and the connect approach in the same query. See this issue comment for details.

Create a new Post record and connect it to an existing User record

const user = await prisma.post.create({
  data: {
    title: "Hello World",
    author: {
      connect: { email: "[email protected]" },
    },
  },
});

Update an existing User record by connecting it to an existing Profile record

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    profile: {
      connect: { id: 24 },
    },
  },
});

Update an existing User record by connecting it to two existing Post records

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    posts: {
      connect: [{ id: 24 }, { id: 42 }],
    },
  },
});

connectOrCreate

connectOrCreate either connects a record to an existing related record by ID or unique identifier or creates a new related record if the record does not exist. See: Working with relations

Remarks

Multiple connectOrCreate queries that run as concurrent transactions can result in a race condition. Consider the following example, where two queries attempt to connectOrCreate a blog post tag named computing at the same time (tag names must be unique):

const createPost = await prisma.post.create({
  data: {
    title: "How to create a compiler",
    content: "...",
    author: {
      connect: {
        id: 9,
      },
    },
    tags: {
      connectOrCreate: {
        create: {
          name: "computing",
        },
        where: {
          name: "computing",
        },
      },
    },
  },
});

const createPost = await prisma.post.create({
  data: {
    title: "How to handle schema drift in production",
    content: "...",
    author: {
      connect: {
        id: 15,
      },
    },
    tags: {
      connectOrCreate: {
        create: {
          name: "computing",
        },
        where: {
          name: "computing",
        },
      },
    },
  },
});

If query A and query B overlap in the following way, query A results in an exception:

To work around this scenario, we recommend catching the unique violation exception (PrismaClientKnownRequestError, error P2002) and retrying failed queries.

Examples

Create a new Profile record, then connect it to an existing User record or create a new User

The following example:

1. Creates a Profile
2. Attempts to connect the profile to a User where the email address is [email protected]
3. Creates a new user if a matching user does not exist

const user = await prisma.profile.create({
  data: {
    bio: 'The coolest Alice on the planet',
    user: {
      connectOrCreate: {
        where:  { email: '[email protected]' },
        create: { email: '[email protected]'}
    },
  },
})

Create a new Post record and connect it to an existing User record, or create a new User

const user = await prisma.post.create({
  data: {
    title: "Hello World",
    author: {
      connectOrCreate: {
        where: { email: "[email protected]" },
        create: { email: "[email protected]" },
      },
    },
  },
});

Update an existing User record by connecting it to an existing Profile record, or creating a new Profile record

The following example:

1. Attempts to connect the user to a Profile with an id of 20
2. Creates a new profile if a matching profile does not exist

const updateUser = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    profile: {
      connectOrCreate: {
        where: { id: 20 },
        create: {
          bio: "The coolest Alice in town",
        },
      },
    },
  },
});

Update an existing User record by connect it to two existing Post records, or creating two new Post records

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    posts: {
      connectOrCreate: [
        {
          where: { id: 32 },
          create: { title: "This is my first post" },
        },
        {
          where: { id: 19 },
          create: { title: "This is my second post" },
        },
      ],
    },
  },
});

disconnect

A nested disconnect query breaks the connection between a parent record and a related record, but does not delete either record. See: Working with relations

Remarks

• disconnect is only available if the relation is optional.
• If the relationship you are attempting to disconnect does not exist, the operation does nothing.

Examples

Update an existing User record by disconnecting the Profile record it's connected to

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    profile: {
      disconnect: true,
    },
  },
});

Update an existing User record by disconnecting two Post records it's connected to

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    posts: {
      disconnect: [{ id: 44 }, { id: 46 }],
    },
  },
});

update

A nested update query updates one or more related records where the parent record's ID is n. See: Working with relations

Remarks

• Nested update queries are only available in the context of a top-level update query (for example, prisma.user.update(...)).

• If the parent record does not exist, Prisma Client throws an exception:

  Copy

  AssertionError("Expected a valid parent ID to be present for nested update to-one case.")
  

• If the related record that you want to update does not exist, Prisma Client throws an exception:

  Copy

  AssertionError("Expected a valid parent ID to be present for nested update to-one case.")
  

Examples

Update an existing User record by updating the Profile record it's connected to

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    profile: {
      update: { bio: "Hello World" },
    },
  },
});

Update an existing User record by updating two Post records it's connected to

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    posts: {
      update: [
        {
          data: { published: true },
          where: { id: 32 },
        },
        {
          data: { published: true },
          where: { id: 23 },
        },
      ],
    },
  },
});

upsert

:::info

This section covers the usage of nested upsert within update(). To learn about the upsert() operation, reference the linked documentation.

:::

A nested upsert query updates a related record if it exists, or creates a new related record.

Examples

Update an existing User record by updating the Profile record it's connected to or creating a new one (upsert)

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    profile: {
      upsert: {
        create: { bio: "Hello World" },
        update: { bio: "Hello World" },
      },
    },
  },
});

Update an existing User record by updating two Post record it's connected to or creating new ones (upsert)

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    posts: {
      upsert: [
        {
          create: { title: "This is my first post" },
          update: { title: "This is my first post" },
          where: { id: 32 },
        },
        {
          create: { title: "This is my second post" },
          update: { title: "This is my second post" },
          where: { id: 23 },
        },
      ],
    },
  },
});

delete

A nested delete query deletes a related record. The parent record is not deleted.

Remarks

• delete is only available if the relation is optional.

Examples

Update an existing User record by deleting the Profile record it's connected to

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    profile: {
      delete: true,
    },
  },
});

Update an existing User record by deleting two Post records it's connected to

const user = await prisma.user.update({
  where: { email: "[email protected]" },
  data: {
    posts: {
      delete: [{ id: 34 }, { id: 36 }],
    },
  },
});

updateMany

A nested updateMany updates a list of related records and supports filtering - for example, you can update a user's unpublished posts.

Examples

Update all unpublished posts belonging to a specific user

const result = await prisma.user.update({
  where: {
    id: 2,
  },
  data: {
    posts: {
      updateMany: {
        where: {
          published: false,
        },
        data: {
          likes: 0,
        },
      },
    },
  },
});

deleteMany

A nested deleteMany deletes related records and supports filtering. For example, you can delete a user's posts while updating other properties of that user.

Examples

Delete all posts belonging to a specific user as part of an update

const result = await prisma.user.update({
  where: {
    id: 2,
  },
  data: {
    name: "Updated name",
    posts: {
      deleteMany: {},
    },
  },
});

Filter conditions and operators

equals

Value equals n.

Examples

Return all users where name equals "Eleanor"

const result = await prisma.user.findMany({
  where: {
    name: {
      equals: "Eleanor",
    },
  },
});

You can also exclude the equals:

const result = await prisma.user.findMany({
  where: {
    name: "Eleanor",
  },
});

Return all products with a quantity lower than the "warn quantity" threshold

This example compares fields of the same model.

const productsWithLowQuantity = await prisma.product.findMany({
  where: {
    quantity: {
      lte: prisma.product.fields.warnQuantity,
    },
  },
});

Return all users that have blue and green as their favorite colors

This example finds users that have set their favoriteColors field to ['blue', 'green'].

Note that when using equals, order of elements matters. That is to say ['blue', 'green'] is not equal to ['green', 'blue']

const favoriteColorFriends = await prisma.user.findMany({
  where: {
    favoriteColors: {
      equals: ["blue", "green"],
    },
  },
});

not

Value does not equal n.

Examples

Return all users where name does not equal "Eleanor"

const result = await prisma.user.findMany({
  where: {
    name: {
      not: "Eleanor",
    },
  },
});

:::warning

not will return all items that do not match a given value. However, if the column is nullable, NULL values will not be returned. If you require null values to be returned, use an OR operator to include NULL values.

:::

Return all users where name does not equal "Eleanor" including users where name is NULL

await prisma.user.findMany({
  where: {
    OR: [{ name: { not: "Eleanor" } }, { name: null }],
  },
});

in

Value n exists in list.

:::note

null values are not returned. For example, if you combine in and NOT to return a user whose name is not in the list, users with null value names are not returned.

:::

Examples

Get User records where the id can be found in the following list: [22, 91, 14, 2, 5]

const getUser = await prisma.user.findMany({
  where: {
    id: { in: [22, 91, 14, 2, 5] },
  },
});

Get User records where the name can be found in the following list: ['Saqui', 'Clementine', 'Bob']

const getUser = await prisma.user.findMany({
  where: {
    name: { in: ["Saqui", "Clementine", "Bob"] },
  },
});

Get User records where name is not present in the list

The following example combines in and NOT. You can also use notIn.

const getUser = await prisma.user.findMany({
  where: {
    NOT: {
      name: { in: ["Saqui", "Clementine", "Bob"] },
    },
  },
});

Get a User record where at least one Post has at least one specified Category

const getUser = await prisma.user.findMany({
  where: {
    // Find users where..
    posts: {
      some: {
        // ..at least one (some) posts..
        categories: {
          some: {
            // .. have at least one category ..
            name: {
              in: ["Food", "Introductions"], // .. with a name that matches one of the following.
            },
          },
        },
      },
    },
  },
});

notIn

Value n does not exist in list.

Remarks

• null values are not returned.

Examples

Get User records where the id can not be found in the following list: [22, 91, 14, 2, 5]

const getUser = await prisma.user.findMany({
  where: {
    id: { notIn: [22, 91, 14, 2, 5] },
  },
});

lt

Value n is less than x.

Examples

Get all Post records where likes is less than 9

const getPosts = await prisma.post.findMany({
  where: {
    likes: {
      lt: 9,
    },
  },
});

lte

Value n is less than or equal to x.

Examples

Get all Post records where likes is less or equal to 9

const getPosts = await prisma.post.findMany({
  where: {
    likes: {
      lte: 9,
    },
  },
});

gt

Value n is greater than x.

Examples

Get all Post records where likes is greater than 9

const getPosts = await prisma.post.findMany({
  where: {
    likes: {
      gt: 9,
    },
  },
});

gte

Value n is greater than or equal to x.

Examples

Get all Post records where likes is greater than or equal to 9

const getPosts = await prisma.post.findMany({
  where: {
    likes: {
      gte: 9,
    },
  },
});

Examples

Get all Post records where date_created is greater than March 19th, 2020

const result = await prisma.post.findMany({
  where: {
    date_created: {
      gte: new Date("2020-03-19T14:21:00+0200") /* Includes time offset for UTC */,
    },
  },
});

contains

Value n contains x.

Examples

Count all Post records where content contains databases

const result = await prisma.post.count({
  where: {
    content: {
      contains: "databases",
    },
  },
});

Count all Post records where content does not contain databases

const result = await prisma.post.count({
  where: {
    NOT: {
      content: {
        contains: "databases",
      },
    },
  },
});

search

Use Full-Text Search to search within a String field.

:::info

For PostgreSQL, this feature is still in Preview. Enable the fullTextSearchPostgres feature flag in order to use it.

:::

Examples

Find all posts with a title that contains cat or dog.

const result = await prisma.post.findMany({
  where: {
    title: {
      search: "cat | dog",
    },
  },
});

Find all posts with a title that contains cat and dog.

const result = await prisma.post.findMany({
  where: {
    title: {
      search: "cat & dog",
    },
  },
});

Find all posts with a title that doesn't contain cat.

const result = await prisma.post.findMany({
  where: {
    title: {
      search: "!cat",
    },
  },
});

mode

Remarks

• Supported by the PostgreSQL and MongoDB connectors only

Examples

Get all Post records where title contains prisma, in a case insensitive way

const result = await prisma.post.findMany({
  where: {
    title: {
      contains: "prisma",
      mode: "insensitive",
    },
  },
});

startsWith

Examples

Get all Post records where title starts with Pr (such as Prisma)

const result = await prisma.post.findMany({
  where: {
    title: {
      startsWith: "Pr",
    },
  },
});

endsWith

Get all User records where email ends with prisma.io

const result = await prisma.user.findMany({
  where: {
    email: {
      endsWith: "prisma.io",
    },
  },
});

AND

All conditions must return true. Alternatively, pass a list of objects into the where clause - the AND operator is not required.

Examples

Get all Post records where the content field contains Prisma and published is false

const result = await prisma.post.findMany({
  where: {
    AND: [
      {
        content: {
          contains: "Prisma",
        },
      },
      {
        published: {
          equals: false,
        },
      },
    ],
  },
});

Get all Post records where the content field contains Prisma and published is false (no AND)

The following format returns the same results as the previous example without the AND operator:

const result = await prisma.post.findMany({
  where: {
    content: {
      contains: "Prisma",
    },
    published: {
      equals: false,
    },
  },
});

Get all Post records where the title field contains Prisma or databases, and published is false

The following example combines OR and AND:

const result = await prisma.post.findMany({
  where: {
    OR: [
      {
        title: {
          contains: "Prisma",
        },
      },
      {
        title: {
          contains: "databases",
        },
      },
    ],
    AND: {
      published: false,
    },
  },
});

OR

One or more conditions must return true.

Examples

Get all Post records where the title field contains Prisma or databases

const result = await prisma.post.findMany({
  where: {
    OR: [
      {
        title: {
          contains: "Prisma",
        },
      },
      {
        title: {
          contains: "databases",
        },
      },
    ],
  },
});

Get all Post records where the title field contains Prisma or databases, but not SQL

The following example combines OR and NOT:

const result = await prisma.post.findMany({
  where: {
    OR: [
      {
        title: {
          contains: "Prisma",
        },
      },
      {
        title: {
          contains: "databases",
        },
      },
    ],
    NOT: {
      title: {
        contains: "SQL",
      },
    },
  },
});

Get all Post records where the title field contains Prisma or databases, and published is false

The following example combines OR and AND:

const result = await prisma.post.findMany({
  where: {
    OR: [
      {
        title: {
          contains: "Prisma",
        },
      },
      {
        title: {
          contains: "databases",
        },
      },
    ],
    AND: {
      published: false,
    },
  },
});

NOT

All conditions must return false.

Examples

Get all Post records where the title does not contain SQL

const result = await prisma.post.findMany({
  where: {
    NOT: {
      title: {
        contains: "SQL",
      },
    },
  },
});

Get all Post records where the title field contains Prisma or databases, but not SQL, and the related User record' email address does not contain sarah

const result = await prisma.post.findMany({
  where: {
    OR: [
      {
        title: {
          contains: "Prisma",
        },
      },
      {
        title: {
          contains: "databases",
        },
      },
    ],
    NOT: {
      title: {
        contains: "SQL",
      },
    },
    user: {
      NOT: {
        email: {
          contains: "sarah",
        },
      },
    },
  },
  include: {
    user: true,
  },
});

Relation filters

some

Returns all records where one or more ("some") related records match filtering criteria.

Remarks

• You can use some without parameters to return all records with at least one relation

Examples

Get all User records where some posts mention Prisma

const result = await prisma.user.findMany({
  where: {
    post: {
      some: {
        content: {
          contains: "Prisma"
        }
      }
    }
  }
}

every

Returns all records where all ("every") related records match filtering criteria.

Examples

Get all User records where all posts are published

const result = await prisma.user.findMany({
  where: {
    post: {
      every: {
        published: true
      },
    }
  }
}

none

Returns all records where zero related records match filtering criteria.

Remarks

• You can use none without parameters to return all records with no relations

Examples

Get all User records with zero posts

const result = await prisma.user.findMany({
  where: {
    post: {
        none: {} // User has no posts
    }
  }
}

Get all User records with zero published posts

const result = await prisma.user.findMany({
  where: {
    post: {
        none: {
          published: true
        }
    }
  }
}

is

Returns all records where related record matches filtering criteria (for example, user's name is Bob).

Examples

Get all Post records where user's name is "Bob"

const result = await prisma.post.findMany({
  where: {
    user: {
        is: {
          name: "Bob"
        },
    }
  }
}

isNot

Returns all records where the related record does not match the filtering criteria (for example, user's name isNot Bob).

Examples

Get all Post records where user's name is NOT "Bob"

const result = await prisma.post.findMany({
  where: {
    user: {
        isNot: {
          name: "Bob"
        },
    }
  }
}

Scalar list methods

set

Use set to overwrite the value of a scalar list field.

Remarks

• set is optional - you can set the value directly:

  tsCopy

  tags: ["computers", "books"];
  

Examples

Set the value of tags to a list of string values

const setTags = await prisma.post.update({
  where: {
    id: 9,
  },
  data: {
    tags: {
      set: ["computing", "books"],
    },
  },
});

Set tags to a list of values without using the set keyword

const setTags = await prisma.post.update({
  where: {
    id: 9,
  },
  data: {
    tags: ["computing", "books"],
  },
});

Set the value of tags to a single string value

const setTags = await prisma.post.update({
  where: {
    id: 9,
  },
  data: {
    tags: {
      set: "computing",
    },
  },
});

push

Use push to add one value or multiple values to a scalar list field.

Remarks

• Available for PostgreSQL and MongoDB only.
• You can push a list of values or only a single value.

Examples

Add a computing item to the tags list

const addTag = await prisma.post.update({
  where: {
    id: 9,
  },
  data: {
    tags: {
      push: "computing",
    },
  },
});

const addTag = await prisma.post.update({
  where: {
    id: 9,
  },
  data: {
    tags: {
      push: ["computing", "genetics"],
    },
  },
});

unset

Use unset to unset the value of a scalar list (MongoDB only). Unlike set: null, unset removes the list entirely.

Examples

Unset the value of tags

const setTags = await prisma.post.update({
  where: {
    id: 9,
  },
  data: {
    tags: {
      unset: true,
    },
  },
});

Scalar list filters

Scalar list filters allow you to filter by the contents of a list / array field.

:::warning

Available for PostgreSQL, CockroachDB, and MongoDB.

:::

Remarks

• Scalar list / array filters ignore NULL values . Using isEmpty or NOT does not return records with NULL value lists / arrays, and { equals: null } results in an error.

has

The given value exists in the list.

Examples

The following query returns all Post records where the tags list includes "databases":

const posts = await client.post.findMany({
  where: {
    tags: {
      has: "databases",
    },
  },
});

The following query returns all Post records where the tags list does not include "databases":

const posts = await client.post.findMany({
  where: {
    NOT: {
      tags: {
        has: "databases",
      },
    },
  },
});

hasEvery

Every value exists in the list.

Examples

The following query returns all Post records where the tags list includes at least "databases" and "typescript":

const posts = await prisma.post.findMany({
  where: {
    tags: {
      hasEvery: ["databases", "typescript"],
    },
  },
});

hasSome

At least one value exists in the list.

Examples

The following query returns all Post records where the tags list includes "databases" or "typescript":

const posts = await prisma.post.findMany({
  where: {
    tags: {
      hasSome: ["databases", "typescript"],
    },
  },
});

isEmpty

The list is empty.

Examples

The following query returns all Post records that have no tags:

const posts = await prisma.post.findMany({
  where: {
    tags: {
      isEmpty: true,
    },
  },
});

isSet

Filter lists to include only results that have been set (MongoDB only) (either set to a value, or explicitly set to null). Setting this filter to true will exclude undefined results that are not set at all.

Examples

The following query returns all Post records where the tags have been set to either null or a value:

const posts = await prisma.post.findMany({
  where: {
    tags: {
      isSet: true,
    },
  },
});

equals

The list matches the given value exactly.

Examples

The following query returns all Post records where the tags list includes "databases" and "typescript" only:

const posts = await prisma.post.findMany({
  where: {
    tags: {
      equals: ["databases", "typescript"],
    },
  },
});

Composite type methods

Composite type methods allow you to create, update and delete composite types (MongoDB only).

set

Use set to overwrite the value of a composite type.

Remarks

• The set keyword is optional - you can set the value directly:
  tsCopy

  photos: [
    { height: 100, width: 200, url: "1.jpg" },
    { height: 100, width: 200, url: "2.jpg" },
  ];
  

Examples

Set the shippingAddress composite type within a new order

const order = await prisma.order.create({
  data: {
    // Normal relation
    product: { connect: { id: "some-object-id" } },
    color: "Red",
    size: "Large",
    // Composite type
    shippingAddress: {
      set: {
        street: "1084 Candycane Lane",
        city: "Silverlake",
        zip: "84323",
      },
    },
  },
});

Set an optional composite type to null

const order = await prisma.order.create({
  data: {
    // Embedded optional type, set to null
    billingAddress: {
      set: null,
    },
  },
});

unset

Use unset to unset the value of a composite type. Unlike set: null, this removes the field entirely from the MongoDB document.

Examples

Remove the billingAddress from an order

const order = await prisma.order.update({
  where: {
    id: "some-object-id",
  },
  data: {
    billingAddress: {
      // Unset the billing address
      // Removes "billingAddress" field from order
      unset: true,
    },
  },
});

update

Use update to update fields within a required composite type.

Remarks

The update method cannot be used on optional types. Instead, use upsert

Examples

Update the zip field of a shippingAddress composite type

const order = await prisma.order.update({
  where: {
    id: "some-object-id",
  },
  data: {
    shippingAddress: {
      // Update just the zip field
      update: {
        zip: "41232",
      },
    },
  },
});

upsert

Use upsert to update an existing optional composite type if it exists, and otherwise set the composite type.

Remarks

The upsert method cannot be used on required types. Instead, use update

Examples

Create a new billingAddress if it doesn't exist, and otherwise update it

const order = await prisma.order.update({
  where: {
    id: "some-object-id",
  },
  data: {
    billingAddress: {
      // Create the address if it doesn't exist,
      // otherwise update it
      upsert: {
        set: {
          street: "1084 Candycane Lane",
          city: "Silverlake",
          zip: "84323",
        },
        update: {
          zip: "84323",
        },
      },
    },
  },
});

push

Use push to push values to the end of a list of composite types.

Examples

Add a new photo to the photos list

const product = prisma.product.update({
  where: {
    id: 10,
  },
  data: {
    photos: {
      // Push a photo to the end of the photos list
      push: [{ height: 100, width: 200, url: "1.jpg" }],
    },
  },
});

Composite type filters

Composite type filters allow you to filter the contents of composite types (MongoDB only).

equals

Use equals to filter results by matching a composite type or a list of composite types. Requires all required fields of the composite type to match.

Remarks

When matching optional fields, you need to distinguish between undefined (missing) fields of the document, and fields that have been explicitly set to null:

• If you omit an optional field, it will match undefined fields, but not fields that have been set to null
• If you filter for null values of an optional field with equals: { ... exampleField: null ... }, then it will match only documents where the field has been set to null, and not undefined fields

The ordering of fields and lists matters when using equals:

• For fields, { "a": "1", "b": "2" } and { "b": "2", "a": "1" } are not considered equal
• For lists, [ { "a": 1 }, { "a": 2 } ] and [ { "a": 2 }, { "a": 1 } ] are not considered equal

Examples

Find orders that exactly match the given shippingAddress

const orders = await prisma.order.findMany({
  where: {
    shippingAddress: {
      equals: {
        street: "555 Candy Cane Lane",
        city: "Wonderland",
        zip: "52337",
      },
    },
  },
});

Find products with photos that match all of a list of urls

const product = prisma.product.findMany({
  where: {
    equals: {
      photos: [{ url: "1.jpg" }, { url: "2.jpg" }],
    },
  },
});

is

Use is to filter results by matching specific fields within composite types.

Examples

Find orders with a shippingAddress that matches the given street name

const orders = await prisma.order.findMany({
  where: {
    shippingAddress: {
      is: {
        street: "555 Candy Cane Lane",
      },
    },
  },
});

isNot

Use isNot to filter results for composite type fields that do not match.

Examples

Find orders with a shippingAddress that does not match the given zip code

const orders = await prisma.order.findMany({
  where: {
    shippingAddress: {
      isNot: {
        zip: "52337",
      },
    },
  },
});

isEmpty

Use isEmpty to filter results for an empty list of composite types.

Examples

Find products with no photos

const product = prisma.product.findMany({
  where: {
    photos: {
      isEmpty: true,
    },
  },
});

every

Use every to filter for lists of composite types where every item in the list matches the condition

Examples

Find the first product where every photo has a height of 200

const product = await prisma.product.findFirst({
  where: {
    photos: {
      every: {
        height: 200,
      },
    },
  },
});

some

Use some to filter for lists of composite types where one or more items in the list match the condition.

Examples

Find the first product where one or more photos have a url of 2.jpg

const product = await prisma.product.findFirst({
  where: {
    photos: {
      some: {
        url: "2.jpg",
      },
    },
  },
});

none

Use none to filter for lists of composite types where no items in the list match the condition.

Examples

Find the first product where no photos have a url of 2.jpg

const product = await prisma.product.findFirst({
  where: {
    photos: {
      none: {
        url: "2.jpg",
      },
    },
  },
});

Atomic number operations

Atomic operations on update is available for number field types (Float and Int). This feature allows you to update a field based on its current value (such as subtracting or dividing) without risking a race condition.

A race conditions occurs when two or more operations must be done in sequence in order to complete a task. In the following example, two clients try to increase the same field (postCount) by one:

The value should be 23, but the two clients did not read and write to the postCount field in sequence. Atomic operations on update combine read and write into a single operation, which prevents a race condition:

Operators

Remarks

• You can only perform one atomic update per field, per query.
• If a field is null, it will not be updated by increment, decrement, multiply, or divide.

Examples

Increment all view and likes fields of all Post records by 1

const updatePosts = await prisma.post.updateMany({
  data: {
    views: {
      increment: 1,
    },
    likes: {
      increment: 1,
    },
  },
});

Set all views fields of all Post records to 0

const updatePosts = await prisma.post.updateMany({
  data: {
    views: {
      set: 0,
    },
  },
});

Can also be written as:

const updatePosts = await prisma.post.updateMany({
  data: {
    views: 0,
  },
});

Json filters

For use cases and advanced examples, see: Working with Json fields.

:::warning

Supported by PostgreSQL and MySQL with different syntaxes for the path option. PostgreSQL does not support filtering on object key values in arrays.

:::

The examples in this section assumes that the value of the pet field is:

{
  "favorites": {
    "catBreed": "Turkish van",
    "dogBreed": "Rottweiler",
    "sanctuaries": ["RSPCA", "Alley Cat Allies"],
    "treats": [
      { "name": "Dreamies", "manufacturer": "Mars Inc" },
      { "name": "Treatos", "manufacturer": "The Dog People" }
    ]
  },
  "fostered": {
    "cats": ["Bob", "Alice", "Svetlana the Magnificent", "Queenie"]
  },
  "owned": {
    "cats": ["Elliott"]
  }
}

Remarks

• The implementation of Json filtering differs between database connectors
• Filtering is case sensitive in PostgreSQL and does not yet support mode

path

path represents the location of a specific key. The following query returns all users where the nested favorites > dogBreed key equals "Rottweiler".

const getUsers = await prisma.user.findMany({
  where: {
    pets: {
      path: ["favorites", "dogBreed"],
      equals: "Rottweiler",
    },
  },
});

const getUsers = await prisma.user.findMany({
  where: {
    pets: {
      path: "$.favorites.dogBreed",
      equals: "Rottweiler",
    },
  },
});

The following query returns all users where the nested owned > cats array contains "Elliott".