schema.prisma

mongodb

mongoDb

previewFeatures

generator

// Set the database provider to "mongodb"
datasource db {
  provider = "mongodb"
  url      = env("DATABASE_URL")
}

// We want to generate a Prisma Client
// Since mongodb is a preview feature, we need to enable it.
generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["mongoDb"]
}

// Create our Post model which will be mapped to a collection in the database.
// The id attributes tell Prisma it's a primary key and to generate 
// object ids by default when inserting posts.
model Post {
  id    String @id @default(dbgenerated()) @map("_id") @db.ObjectId
  slug  String @unique
  title String
  body  String
}

.env

interactiveTransactions

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["interactiveTransactions"]
}

namedConstraints

@@unique

@@index

namedConstraints

namedConstraints

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["namedConstraints"]
}

prisma db pull

fullTextSearch

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["fullTextSearch"]
}

search

String

// returns all posts that contain the words cat *or* dog.
const result = await prisma.post.findMany({
  where: {
    body: {
      search: 'cat | dog',
    },
  },
})

prisma introspect

prisma db pull

prisma introspect

prisma db pull

schema.prisma

prisma db pull

prisma introspect

User:Post

@relation()

referentialIntegrity

2.24.0

planetScaleMode

referentialIntegrity

referentialIntegrity = "prisma"

prisma

referentialIntegrity

datasource db {
  provider             = "mysql"
  url                  = env("DATABASE_URL")
  referentialIntegrity = "prisma"
}

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["referentialIntegrity"]
}

prisma

fullTextSearch

// Fetch all drafts with a title that contains the words fox or dog
posts, _ := client.Post.FindMany(
  db.Post.Title.Search("fox | dog"),
  db.Post.Status.Equals("Draft"),
).Exec(context.Background())

// Loop over the posts and print the title
for _, post := range posts {
  fmt.Println(post.Title)
}

prisma db pull

mongoDb

datasource

prisma db pull

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

// => [
//      { 
//        email: "<mailto:alice@prisma.io|alice@prisma.io>",
//        _count: { posts: 3 }
//      }
//    ]

3.3.0

import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()

addEventListener('fetch', (event) => {
  event.respondWith(handleRequest(event.request))
})

async function handleRequest(request: Request): Promise<Response> {
  await prisma.log.create({
    data: {
      level: 'Info',
      message: `${request.method} ${request.url}`,
    },
  })
  return new Response(`request method: ${request.method}!`)
}

2.16.0

ts
// Return a list of posts ordered by the author's email address
// in ascending order.
await prisma.post.findMany({
  orderBy: {
    author: {
      email: "asc",
    },
  },
})

3.3.0

model User {
  id   Int      @id @default(autoincrement())
  name String
  pets String[]
}

user, err := client.User.FindFirst(
  db.User.Pets.HasSome([]string{"Fido", "Scooby"}),
).Exec(ctx)

user, err := client.User.FindUnique(
  db.User.Name.Equals(1),
).Update(
  db.User.Items.Push([]string{"Charlemagne"}),
).Exec(ctx)

3.4.0

3.4.0

ORDER BY

city

const groupBy = await prisma.user.groupBy({
  by: ['city'],
  _count: {
    city: true,
  },
  orderBy: {
    _count: {
      city: 'desc',
    },
  },
})

prisma db push

prisma db push

@unique

@@unique

@@index

prisma db push

logs, _ := client.Log.FindMany(
  db.Log.Meta.Path([]string{"service"}),
	db.Log.Meta.Equals(db.JSON("\"api\"")),
).Exec(ctx)

3.5.0

search

where

const query = "node.js developer"
const developers = await prisma.people.findMany({
  where: {
    bio: {
      // Only select people whose bio's contain "node.js developer"
      search: query,
    },
  },
  orderBy: {
    // Order that selection by query relevance.
    _relevance: {
      fields: ["bio"],
      search: query,
      sort: "desc",
    },
  },
})

sort

length

model Post {
    title       String @db.VarChar(300)
    abstract    String @db.VarChar(3000)
    slug        String @db.VarChar(3000) @unique(sort: Desc, length: 42)
    author      String
    created_at  DateTime

    @@id([title(length: 100, sort: Desc), abstract(length: 10)])
    @@index([author, created_at(sort: Desc)])
}

users, err := client.User.FindMany(
    User.Email.Equals("prisMa"),
    User.Email.Mode(QueryModeInsensitive), // sets case insensitivity
).Exec(ctx)

db pull+

db push

migrate

fullTextIndex

@@fulltext

generator js {
  provider        = "prisma-client-js"
  previewFeatures = ["fullTextIndex"]
}

model A {
  id      Int    @id
  title   String @db.VarChar(255)
  content String @db.Text
  
  @@fulltext([title, content])
}

db pull

extendedIndexes

Hash

BTree

generator js {
  provider        = "prisma-client-js"
  previewFeatures = ["extendedIndexes"]
}

model A {
  id    Int @id
  value Int  
  
  @@index([value], type: Hash)
}

3.6.0

Bytes

in

notIn

in

notIn

Bytes

const audioTracks = raws.map(raw => {
  return Buffer.from(raw)
})

const result = await prisma.audio.find({
  where: {
    track: 
      in: audioTracks
    }
  }
})

Json

Json

audit

Json

const trail = [
  { event: "signup" },
  { event: "subscribe" },
  { event: "invite friend" }
] as const

await prisma.user.create({
  data: {
    audit: trail
  }
})

3.7.0

3.7.0

onDelete

onUpdate

model User {
   id    String @id @default(dbgenerated()) @map("_id") @db.ObjectId
   posts Post[]
   name  String
 }

 model Post {
   id     String @id @default(dbgenerated()) @map("_id") @db.ObjectId
   author User   @relation(fields: [userId], references: [id], *onDelete: Cascade*)
   title  String
   userId String @db.ObjectId
 }

onDelete: Cascade

onDelete

onUpdate

mongodb

Error parsing attribute "@relation": Reference causes a cycle.

type

3.7.0

type

type MyId = String @id @default(dbgenerated(new_uuid()))

model A {
  id MyId
}

BigInt

3.8.0

fullTextIndex

fullTextSearch

@@fulltext()

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["fullTextIndex", "fullTextSearch"]
}

datasource db {
  provider = "mysql"
  url      = env("DATABASE_URL")
}

model Post {
  id     Int    @id @default(autoincrement())
  title  String @unique
  @@fulltext([title])
}

prisma db push

prisma migrate dev

// search for titles that contain cat, but not fox
await prisma.post.findMany({
  where: {
    title: {
      search: "+cat -fox",
    },
  },
})

dataProxy

interactiveTransactions

3.8.0

push

3.8.0

push

model Course {
  id          String   @id @default(dbgenerated()) @map("_id") @db.ObjectId
  title       String
  students    String[] @db.Array(ObjectId)
}

// Add a new student to the course
await prisma.course.update({
  where: {
    id: 1
  },
  data: {
    students: {
      push: new ObjectID("...")
    }
  }
})

3.9.0

prisma migrate diff

prisma db execute

prisma migrate diff

prisma migrate diff

prisma db execute

3.9.0

// To find zero or more documents matching a filter
const result = await prisma.user.findRaw({
  filter: { age: { $gt: 25 } },
  options: { projection: { _id: false } },
})

// To perform aggregation operations on a collection
await prisma.user.aggregateRaw({
  pipeline: [
    { $match: { status: 'registered' } },
    { $group: { _id: '$country', total: { $sum: 1 } } },
  ],
})

// To run a command against the database
await prisma.$runCommandRaw({
  aggregate: 'User',
  pipeline: [
    { $match: { name: 'Bob' } },
    { $project: { email: true, _id: false } },
  ],
  explain: false,
})

3.9.0

3.10.0

3.10.0

type

datasource db {
  provider = "mongodb"
  url      = env("DATABASE_URL")
}

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["mongoDb"]
}

model Product {
  id     String  @id @default(auto()) @map("_id") @db.ObjectId
  name   String
  photos Photo[]
}

type Photo {
  height Int
  width  Int
  url    String
}

photos

// Create a new product with an embedded list of photos
const product = await prisma.product.create({
  data: {
    name: "Forest Runners",
    price: 59.99,
    // Create an embedded list of photos in the product
    photos: [
      { height: 100, width: 200, url: "1.jpg" },
      { height: 300, width: 400, url: "2.jpg" },
    ],
  },
})

3.4.0

prisma db pull

type

-composite-type-depth=0

--composite-type-depth=2

@default(dbgenerated())

@default(auto())

dbgenerated

references

3.10.0

@relation

fields

references

fields

references

model Post {
  id           String   @id @map("_id") @default(auto()) @db.ObjectId
  category_ids String[] @db.ObjectId
  categories   Category[]      @relation(fields: [category_ids], references: [id])
}
    
model Category {
  id       String   @id @map("_id") @default(auto()) @db.ObjectId
  post_ids String[] @db.ObjectId
  posts    Post[] @relation(fields: [post_ids], references: [id])
}

db.Array(ObjectId)

@db.ObjectId

dbgenerated

3.11.0

3.11.0

model Product {
  id     String  @id @default(auto()) @map("_id") @db.ObjectId
  photos Photo[]
}

model Order {
  id              String   @id @default(auto()) @map("_id") @db.ObjectId
  shippingAddress Address
  billingAddress  Address? /// optionally embedded document
}

type Photo {
  height Int
  width  Int
  url    String
}

type Address {
  street String
  city   String
  zip    String
}

// find all orders with the same shipping address
const orders = await prisma.order.findMany({
  where: {
    shipping: {
      equals: {
        street: "555 Candy Cane Lane",
        city: "Wonderland",
        zip: "52337",
      },  
    },
  },
})

// find all products that don't have photos
const product = prisma.product.findMany({
  where: {
    photos: {
      isEmpty: true
    }
  },
})

3.11.0

// sort orders by zip code in ascending order
const orders = await prisma.order.findMany({
  orderBy: {
    shippingAddress: {
      zip: "asc",
    },
  },
})

PrismaClient

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

prisma.$on('query', (e) => console.log(e.query))

mongosh

3.11.0

Json

3.11.0

migrate diff

3.11.0

--exit-code

migrate diff

3.11.1

undefined

undefined

undefined

model Address {
    id     Int    @id @map("_id")
    city   String
    street String? // Note that street is optional
}

null

undefined

{ "_id": 1, "city": "San Fransisco", "street": "Market st." }
{ "_id": 2, "city": "Seattle", "street": null }
{ "_id": 3, "city": "Chicago" }

3.11.1

where: { street: null }

_id: 2

_id: 3

3.11.1

_id: 2

isSet

isSet

isSet: bool

undefined

undefined

await prisma.address.findMany({
  where: {
    OR: [
      { street: { isSet: false } },
      { street: null }
    ]
  }
})

isSet

unset

3.11.1

unset

await prisma.address.update({
  where: {
    id: 10,
  },
  data: {
    street: {
      unset: true,
    },
  },
})

street

undefined

updateMany

model Product {
  id          Int  @id @map("_id")
  name        String  @unique
  photos      Photo[]
}

type Photo {
  height Int    @default(200)
  width  Int    @default(100)
  url    String
}

url

1.jpg

const product = prisma.product.update({
  where: {
    id: 10,
  },
  data: {
    photos: {
      updateMany: {
        where: {
          url: '1.jpg',
        },
        data: {
          url: '2.png',
        },
      },
    },
  },
})

deleteMany

updateMany

height

const product = prisma.product.update({
  where: {
    id: 10,
  },
  data: {
    photos: {
      deleteMany: {
        where: {
          height: 100,
        },
      },
    },
  },
})

3.12.0

3.12.0

datasource db {
   provider = "mongodb"
   url      = env("DATABASE_URL")
 }

generator client {
   provider        = "prisma-client-js"
-  previewFeatures = ["mongoDb"]
 }

db push

type Address {
  street String
  number Int
}

model User {
  id      Int     @id
  email   String
  address Address

  @@index([email, address.number])  /// normal index
  @@unique([email, address.street])  /// unique index
  @@fulltext([email, address.street]) /// full-text index
}

Note: Prisma Client does not yet fully support this feature and will be rolled out in a future release

3.12.0

3.13.0

migrate diff

db execute

--preview-feature

prisma migrate diff

prisma db execute

3.5.0

extendedIndexes

datasource db {
  provider = "sqlserver"
  url      = env("DATABASE_URL")
}

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["extendedIndexes"]
}

model Post {
  id      Int     @default(autoincrement()) @id(clustered: false)
  title   String
  content String?
}

prisma migrate dev

CREATE TABLE [Post] (
  id INT NOT NULL,
  [title] VARCHAR(255) NOT NULL,
  [content] NVARCHAR(1000),
  CONSTRAINT [Post_pkey] PRIMARY KEY NONCLUSTERED (id)
)

extendedIndexes

prisma db pull

3.13.0

3.14.0

npx prisma db pull

GIN

GiST

SP-GiST

BRIN

type

@@index

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["extendedIndexes"]
}

model Post {
  id      Int     @id
  title   String
  content String?
  tags    Json?
  
  @@index([tags], type: Gin)
}

CREATE TABLE "Post" (
    "id" INTEGER NOT NULL,
    "title" TEXT NOT NULL,
    "content" TEXT,
    "tags" JSONB,
    CONSTRAINT "Post_pkey" PRIMARY KEY ("id")
);

CREATE INDEX "Post_tags_idx" ON "Post" USING GIN ("tags");

queryRaw

improvedQueryRaw

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["improvedQueryRaw"]
}

improvedQueryRaw

findMany

DateTime

Date,

Bytes

Buffer

improvedQueryRaw

improvedQueryRaw

BigInt

Bytes

Decimal

await prisma.$executeRaw`INSERT INTO "Table" ("bigint", "bytes", "decimal") VALUES (${BigInt("123")}, ${Buffer.from([1, 2, 3])}, ${Decimal("12.23")});`

This improvement is available without the

improvedQueryRaw

Preview feature flag.

3.15.0

--data-proxy

npx prisma generate --data-proxy

@prisma/client/edge

@prisma/client

import { PrismaClient } from '@prisma/client/edge'

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["metrics"]
}

import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()

const metrics = await prisma.$metrics.json()
console.log(metrics)

migrate reset

4.0.0

4.0.0

extendedIndexes

filterJson

improvedQueryRaw

model User {
  id             Int      @id @default(autoincrement())
  posts          Post[]
  favoriteColors String[] @default(["red", "blue", "green"])
}

4.0.0

@default

findUniqueOrThrow

findFirstOrThrow

findUniqueOrThrow

findUnique

RecordNotFound

findFirstOrThrow

findFirst

RecordNotFound

rejectOnNotFound

DbNull

JsonNull

AnyNull

type

sqlite

references

references

@prisma/sdk

@prisma/internals

schema

4.1.0

orderByNulls

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["orderByNulls"]
}

prisma generate

await prisma.post.findMany({
  orderBy: {
    updatedAt: { 
      sort: 'asc',
      nulls: 'last'
    },
  },
})

4.2.0

interactiveTransactions

isolationLevel

await prisma.$transaction(
  async (prisma) => {
    // Your transaction...
  },
  {
    isolationLevel: Prisma.TransactionIsolationLevel.Serializable,
    maxWait: 5000,
    timeout: 10000,
  }
)

prisma.$metrics()

metrics

()

$queryRaw()

$executeRaw()

$queryRawUnsafe()

$executeRawUnsafe()

4.3.0

fieldReference

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["fieldReference"]
}

model Invoice {
  id     Int @id @default(autoincrement)
  paid   Int
  due    Int
}

// Filter all invoices that haven't been paid yet
await prisma.invoice.findMany({
  where: {
    paid: {
      lt: prisma.invoice.fields.due // paid < due
    }
  }
})

filteredRelationCount

// Count all published user posts 
await prisma.user.findMany({
  select: {
    _count: {
      posts: { where: { published: true } },
    },
  },
})

multiSchema

tracing

tracing

datasource

generator

model

enum

type

1.70

4.4.0

isolationLevel

4.2.0

prisma.$transaction([ ])

await prisma.$transaction(
  [
    // sequential operations
    prisma.user.create({ data: {/** args */ } }),
    prisma.post.create({ data: {/** args  */ } })
  ],
  {
    isolationLevel: Prisma.TransactionIsolationLevel.Serializable
  }
)

P2034

PrismaClientKnownRequestError

4.5.0

where

findUnique

update

delete

where

4.5.0

where

generator js {
  provider        = "prisma-client-js"
  previewFeatures = ["extendedWhereUnique"]
}

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["postgresqlExtensions"]
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

extensions

datasource

datasource db {
  provider   = "postgresql"
  url        = env("DATABASE_URL")
  extensions = [hstore(schema: "myHstoreSchema"), pg_tgrm, postgis(version: "2.1")]
}

datasource

relationMode

datasource

referentialIntegrity

relationMode

referentialIntegrity

generator js {
  provider        = "prisma-client-js"
  previewFeatures = ["referentialIntegrity"]
}

datasource db {
  provider     = "mysql"
  url          = env("DATABASE_URL")
  relationMode = "prisma"
}

NoAction

relationMode = "prisma"

relationMode

4.3.0