Defines a data source in the Prisma schema.

Fields

A datasource block accepts the following fields:

Connection URLs (url, directUrl, shadowDatabaseUrl) are configured in prisma.config.ts, not in the schema file.

The following providers are available:

• sqlite

• postgresql

• mysql

• sqlserver

• mongodb

• cockroachdb

• You can only have one datasource block in a schema.

• datasource db is convention - however, you can give your data source any name - for example, datasource mysql or datasource data.

Examples

PostgreSQL datasource

datasource db {
  provider = "postgresql"
}

Configure the connection URL in prisma.config.ts:

import { defineConfig, env } from "prisma/config";

export default defineConfig({
  datasource: {
    url: env("DATABASE_URL"),
  },
});

Learn more about PostgreSQL connection strings here.

Specify a PostgreSQL data source via an environment variable

In this example, the target database is available with the following credentials:

• User: johndoe
• Password: mypassword
• Host: localhost
• Port: 5432
• Database name: mydb
• Schema name: public

datasource db {
  provider = "postgresql"
}

When running a Prisma CLI command that needs the database connection URL (e.g. prisma generate), you need to make sure that the DATABASE_URL environment variable is set.

One way to do so is by creating a .env file with the following contents. Note that the file must be in the same directory as your schema.prisma file to automatically picked up the Prisma CLI.

DATABASE_URL=postgresql://johndoe:mypassword@localhost:5432/mydb?schema=public

MySQL datasource

datasource db {
  provider = "mysql"
}

Learn more about MySQL connection URLs.

MongoDB datasource

datasource db {
  provider = "mongodb"
}

Learn more about MongoDB connection URLs.

SQLite datasource

datasource db {
  provider = "sqlite"
}

Learn more about SQLite connection URLs.

CockroachDB datasource

datasource db {
  provider = "cockroachdb"
}

CockroachDB uses the same connection URL format as PostgreSQL. Learn more about PostgreSQL connection URLs.

Multi-schema datasource (PostgreSQL)

datasource db {
  provider = "postgresql"
  schemas  = ["public", "analytics"]
}

Defines a generator in the Prisma schema.

Fields for prisma-client-js provider

This is the default generator for Prisma ORM 6.x and earlier versions. Learn more about generators.

A generator block accepts the following fields:

Fields for prisma-client provider

The ESM-first client generator that offers greater control and flexibility across different JavaScript environments. It generates plain TypeScript code into a custom directory, providing full visibility over the generated code. Learn more about the new prisma-client generator.

A generator block accepts the following fields:

binaryTargets options

The following tables list all supported operating systems with the name of platform to specify in binaryTargets.

Unless specified otherwise, the default supported CPU architecture is x86_64.

macOS

Windows

Linux (Alpine on x86_64 architectures)

Linux (Alpine on ARM64 architectures)

Linux (Debian), x86_64

Linux (Ubuntu), x86_64

Linux (CentOS), x86_64

Linux (Fedora), x86_64

Linux (Linux Mint), x86_64

Linux (Arch Linux), x86_64

Linux ARM64 (all major distros but Alpine)

Examples

Specify the prisma-client-js generator with the default output, previewFeatures, engineType and binaryTargets

generator client {
  provider = "prisma-client-js"
}

Note that the above generator definition is equivalent to the following because it uses the default values for output, engineType and binaryTargets (and implicitly previewFeatures):

generator client {
  provider      = "prisma-client-js"
  output        = "node_modules/.prisma/client"
  engineType    = "library"
  binaryTargets = ["native"]
}

Specify a custom output location for Prisma Client

This example shows how to define a custom output location of the generated asset to override the default one.

generator client {
  provider = "prisma-client-js"
  output   = "../src/generated/client"
}

Specify custom binaryTargets to ensure compatibility with the OS

This example shows how to configure Prisma Client to run on Ubuntu 19.04 (disco) based on the table above.

generator client {
  provider      = "prisma-client-js"
  binaryTargets = ["debian-openssl-1.1.x"]
}

Specify a provider pointing to some custom generator implementation

This example shows how to use a custom generator that's located in a directory called my-generator.

generator client {
  provider = "./my-generator"
}

Defines a Prisma model .

• Every record of a model must be uniquely identifiable. You must define at least one of the following attributes per model:
  • @unique
  • @@unique
  • @id
  • @@id

Naming conventions

• Model names must adhere to the following regular expression: [A-Za-z][A-Za-z0-9_]*
• Model names must start with a letter and are typically spelled in PascalCase
• Model names should use the singular form (for example, User instead of user, users or Users)
• Prisma ORM has a number of reserved words that are being used by Prisma ORM internally and therefore cannot be used as a model name. You can find the reserved words here and here.

Note: You can use the @@map attribute to map a model (for example, User) to a table with a different name that does not match model naming conventions (for example, users).

Order of fields

• Introspection lists model fields in the same order as the corresponding columns in the database. Relation fields are listed after scalar fields.

Examples

A model named User with two scalar fields

Fields are properties of models.

Naming conventions

• Must start with a letter
• Typically spelled in camelCase
• Must adhere to the following regular expression: [A-Za-z][A-Za-z0-9_]*

Note: You can use the @map attribute to map a field name to a column with a different name that does not match field naming conventions: e.g. myField @map("my_field").

The data source connector determines what native database type each of Prisma ORM scalar type maps to. Similarly, the generator determines what type in the target programming language each of these types map to.

Prisma models also have model field types that define relations between models.

String

Variable length text.

Default type mappings

PostgreSQL

MySQL

You can use Prisma Migrate to map @db.Bit(1) to String:

model Model {
  /* ... */
  myField String @db.Bit(1)
}

MongoDB

String

Microsoft SQL Server

SQLite

TEXT

CockroachDB

Note that the xml and citext types supported in PostgreSQL are not currently supported in CockroachDB.

Clients

Boolean

True or false value.

Default type mappings

PostgreSQL

MySQL

MongoDB

Bool

Microsoft SQL Server

SQLite

INTEGER

CockroachDB

Clients

Int

Default type mappings

PostgreSQL

MySQL

MongoDB

Int

Microsoft SQL Server

SQLite

INTEGER

CockroachDB

Clients

BigInt

Default type mappings

PostgreSQL

MySQL

MongoDB

Long

Microsoft SQL Server

SQLite

INTEGER

CockroachDB

Clients

Float

Floating point number.

Default type mappings

PostgreSQL

MySQL

MongoDB

Double

Microsoft SQL Server

SQLite connector

REAL

CockroachDB

Clients

Decimal

Default type mappings

PostgreSQL

• † p (precision), the maximum total number of decimal digits to be stored. s (scale), the number of decimal digits that are stored to the right of the decimal point.

MySQL

• † p (precision), the maximum total number of decimal digits to be stored. s (scale), the number of decimal digits that are stored to the right of the decimal point.

MongoDB

Not supported.

Microsoft SQL Server

• † p (precision), the maximum total number of decimal digits to be stored. s (scale), the number of decimal digits that are stored to the right of the decimal point.

SQLite

DECIMAL (changed from REAL in 2.17.0)

CockroachDB

• † p (precision), the maximum total number of decimal digits to be stored. s (scale), the number of decimal digits that are stored to the right of the decimal point.

Clients

DateTime

• Prisma Client returns all DateTime as native Date objects.
• Currently, Prisma ORM does not support zero dates (0000-00-00 00:00:00, 0000-00-00, 00:00:00) in MySQL.
• There currently is a bug that doesn't allow you to pass in DateTime values as strings and produces a runtime error when you do. DateTime values need to be passed as Date objects (i.e. new Date('2024-12-04') instead of '2024-12-04').

You can find more info and examples in this section: Working with DateTime.

Default type mappings

PostgreSQL

MySQL

You can also use MySQL's YEAR type with Int:

yearField     Int    @db.Year

MongoDB

Timestamp

Microsoft SQL Server

SQLite

NUMERIC or STRING. If the underlying data type is STRING, you must use one of the following formats:

• RFC 3339 (1996-12-19T16:39:57-08:00)
• RFC 2822 (Tue, 1 Jul 2003 10:52:37 +0200)

CockroachDB

Clients

Json

A JSON object.

Default type mappings

PostgreSQL

MySQL

MongoDB

A valid BSON object (Relaxed mode)

Microsoft SQL Server

Microsoft SQL Server does not have a specific data type for JSON. However, there are a number of built-in functions for reading and modifying JSON.

SQLite

Not supported

CockroachDB

Clients

Bytes

Default type mappings

PostgreSQL

MySQL

MongoDB

BinData

Microsoft SQL Server

SQLite

BLOB

CockroachDB

Clients

Unsupported

The Unsupported type was introduced in 2.17.0 and allows you to represent data types in the Prisma schema that are not supported by Prisma Client. Fields of type Unsupported can be created during Introspection with prisma db pull or written by hand, and created in the database with Prisma Migrate or db push.

• Fields with Unsupported types are not available in the generated client.

• If a model contains a required Unsupported type, prisma.model.create(..), prisma.model.update(...) and prisma.model.upsert(...) are not available in Prisma Client.

• When you introspect a database that contains unsupported types, Prisma ORM will provide the following warning:

  *** WARNING ***
  
  These fields are not supported by Prisma Client, because Prisma does not currently support their types.
  * Model "Post", field: "circle", original data type: "circle"
  

Examples

model Star {
  id       Int                    @id @default(autoincrement())
  position Unsupported("circle")?
  example1 Unsupported("circle")
  circle   Unsupported("circle")? @default(dbgenerated("'<(10,4),11>'::circle"))
}

[] modifier

Makes a field a list.

• Cannot be optional (for example Post[]?).

Relational databases

• Scalar lists (arrays) are only supported in the data model if your database natively supports them. Currently, scalar lists are therefore only supported when using PostgreSQL or CockroachDB (since MySQL and SQLite don't natively support scalar lists).

MongoDB

• Scalar lists are supported

Examples

Define a scalar list

Define a scalar list with a default value

? modifier

Makes a field optional.

• Cannot be used with a list field (for example, Posts[])

Examples

Optional name field

model User {
  id   Int     @id @default(autoincrement())
  name String?
}

Attributes modify the behavior of a field or block (e.g. models). There are two ways to add attributes to your data model:

• Field attributes are prefixed with @
• Block attributes are prefixed with @@

Some attributes take arguments. Arguments in attributes are always named, but in most cases the argument name can be omitted.

Note: The leading underscore in a signature means the argument name can be omitted.

@id

Defines a single-field ID on the model.

General

• Cannot be defined on a relation field
• Cannot be optional

Relational databases

• Corresponding database construct: PRIMARY KEY

• Can be annotated with a @default attribute that uses functions to auto-generate an ID:

  • autoincrement()
  • cuid()
  • uuid()
  • ulid()

• Can be defined on any scalar field (String, Int, enum)

MongoDB

• Corresponding database construct: Any valid BSON type, except arrays

• Every model must define an @id field

• The underlying ID field name is always _id, and must be mapped with @map("_id")

• Can be defined on any scalar field (String, Int, enum) unless you want to use ObjectId in your database

• To use an ObjectId as your ID, you must:

  • Use the String or Bytes field type

  • Annotate your field with @db.ObjectId:

    id   String  @db.ObjectId  @map("_id")
    

  • Optionally, annotate your field with a @default attribute that uses the auto() function to auto-generate an ObjectId

    id   String  @db.ObjectId  @map("_id") @default(auto())
    

• cuid(), uuid() and ulid() are supported but do not generate a valid ObjectId - use auto() instead for @id

• autoincrement() is not supported

Arguments

| | length | No | number | Allows you to specify a maximum length for the subpart of the value to be indexed.

MySQL only.

| | sort | No | String | Allows you to specify in what order the entries of the ID are stored in the database. The available options are Asc and Desc.

SQL Server only.

| | clustered | No | Boolean | Defines whether the ID is clustered or non-clustered. Defaults to true.

SQL Server only.

|

Signature

@id(map: String?, length: number?, sort: String?, clustered: Boolean?)

Examples

In most cases, you want your database to create the ID. To do this, annotate the ID field with the @default attribute and initialize the field with a function.

Generate autoincrementing integers as IDs (Relational databases only)

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

Generate ObjectId as IDs (MongoDB only)

model User {
  id   String @id @default(auto()) @map("_id") @db.ObjectId
  name String
}

Generate cuid() values as IDs

Generate uuid() values as IDs

Generate ulid() values as IDs

Single-field IDs without default values

In the following example, id does not have a default value:

model User {
id    String   @id  @map("_id")
name  String
}

Note that in the above case, you must provide your own ID values when creating new records for the User model using Prisma Client, e.g.:

const newUser = await prisma.user.create({
  data: {
    id: 1,
    name: "Alice",
  },
});

Specify an ID on relation scalar field without a default value

In the following example, authorId is a both a relation scalar and the ID of Profile:

In this scenario, you cannot create a Profile only - you must use Prisma Client's nested writes create a User or connect the profile to an existing user.

The following example creates a user and a profile:

const userWithProfile = await prisma.user.create({
  data: {
    id: 3,
    email: "bob@prisma.io",
    name: "Bob Prismo",
    profile: {
      create: {
        bio: "Hello, I'm Bob Prismo and I love apples, blue nail varnish, and the sound of buzzing mosquitoes.",
      },
    },
  },
});

The following example connects a new profile to a user:

const profileWithUser = await prisma.profile.create({
  data: {
    bio: "Hello, I'm Bob and I like nothing at all. Just nothing.",
    author: {
      connect: {
        id: 22,
      },
    },
  },
});

@@id

Defines a multi-field ID (composite ID) on the model.

• Corresponding database type: PRIMARY KEY
• Can be annotated with a @default attribute that uses functions to auto-generate an ID
• Cannot be optional
• Can be defined on any scalar field (String, Int, enum)
• Cannot be defined on a relation field
• The name of the composite ID field in Prisma Client has the following pattern: field1_field2_field3

Arguments

| | length | No | number | Allows you to specify a maximum length for the subpart of the value to be indexed.

MySQL only.

| | sort | No | String | Allows you to specify in what order the entries of the ID are stored in the database. The available options are Asc and Desc.

SQL Server only.

| | clustered | No | Boolean | Defines whether the ID is clustered or non-clustered. Defaults to true.

SQL Server only.

|

The name of the fields argument on the @@id attribute can be omitted:

@@id(fields: [title, author])
@@id([title, author])

Signature

@@id(_ fields: FieldReference[], name: String?, map: String?)

Examples

Specify a multi-field ID on two String fields (Relational databases only)

model User {
  firstName String
  lastName  String
  email     String  @unique
  isAdmin   Boolean @default(false)

  @@id([firstName, lastName])
}

When you create a user, you must provide a unique combination of firstName and lastName:

const user = await prisma.user.create({
  data: {
    firstName: "Alice",
    lastName: "Smith",
  },
});

To retrieve a user, use the generated composite ID field (firstName_lastName):

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

Specify a multi-field ID on two String fields and one Boolean field (Relational databases only)

model User {
  firstName String
  lastName  String
  email     String  @unique
  isAdmin   Boolean @default(false)

  @@id([firstName, lastName, isAdmin])
}

When creating new User records, you now must provide a unique combination of values for firstName, lastName and isAdmin:

const user = await prisma.user.create({
  data: {
    firstName: "Alice",
    lastName: "Smith",
    isAdmin: true,
  },
});

Specify a multi-field ID that includes a relation field (Relational databases only)

model Post {
  title     String
  published Boolean @default(false)
  author    User    @relation(fields: [authorId], references: [id])
  authorId  Int

  @@id([authorId, title])
}

model User {
  id    Int     @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}

When creating new Post records, you now must provide a unique combination of values for authorId (foreign key) and title:

const post = await prisma.post.create({
  data: {
    title: "Hello World",
    author: {
      connect: {
        email: "alice@prisma.io",
      },
    },
  },
});

@default

Defines a default value for a field.

• Default values that cannot yet be represented in the Prisma schema are represented by the dbgenerated() function when you use introspection.
• Default values are not allowed on relation fields in the Prisma schema. Note however that you can still define default values on the fields backing a relation (the ones listed in the fields argument in the @relation attribute). A default value on the field backing a relation will mean that relation is populated automatically for you.
• Default values can be used with scalar lists in databases that natively support them.

Relational databases

• Corresponding database construct: DEFAULT
• Default values can be a static value (4, "hello") or one of the following functions:
  • autoincrement()
  • sequence() (CockroachDB only)
  • dbgenerated(...)
  • cuid()
  • cuid(2)
  • uuid()
  • uuid(4)
  • uuid(7)
  • ulid()
  • nanoid()
  • now()
• Default values that cannot yet be represented in the Prisma schema are represented by the dbgenerated(...) function when you use introspection.
• Default values are not allowed on relation fields in the Prisma schema. Note however that you can still define default values on the fields backing a relation (the ones listed in the fields argument in the @relation attribute). A default value on the field backing a relation will mean that relation is populated automatically for you.
• Default values can be used with scalar lists in databases that natively support them.
• JSON data. Note that JSON needs to be enclosed with double-quotes inside the @default attribute, e.g.: @default("[]"). If you want to provide a JSON object, you need to enclose it with double-quotes and then escape any internal double quotes using a backslash, e.g.: @default("{ \"hello\": \"world\" }").

MongoDB

• Default values can be a static value (4, "hello") or one of the following functions:
  • auto() (can only be used with @db.ObjectId to generate an ObjectId in MongoDB)
  • cuid()
  • uuid()
  • ulid()
  • now()

Arguments

The name of the value argument on the @default attribute can be omitted:

id Int @id @default(value: autoincrement())
id Int @id @default(autoincrement())

Signature

@default(_ value: Expression, map: String?)

Examples

Default value for an Int

Default value for a Float

Default value for Decimal

Default value for BigInt

Default value for a String

Default value for a Boolean

Default value for a DateTime

Note that static default values for DateTime are based on the ISO 8601 standard.

Default value for a Bytes

Default value for an enum

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique
  name    String?
  role    Role     @default(USER) 
  posts   Post[]
  profile Profile?
}

model User {
  id      String   @id @default(auto()) @map("_id") @db.ObjectId
  email   String   @unique
  name    String?
  role    Role     @default(USER) 
  posts   Post[]
  profile Profile?
}

Default values for scalar lists

@unique

Defines a unique constraint for this field.

General

• A field annotated with @unique can be optional or required
• A field annotated with @unique must be required if it represents the only unique constraint on a model without an @id / @@id
• A model can have any number of unique constraints
• Can be defined on any scalar field
• Cannot be defined on a relation field

Relational databases

• Corresponding database construct: UNIQUE
• NULL values are considered to be distinct (multiple rows with NULL values in the same column are allowed)
• Adding a unique constraint automatically adds a corresponding unique index to the specified column(s).

MongoDB

• Enforced by a unique index in MongoDB

Arguments

| | sort | No | String | Allows you to specify in what order the entries of the constraint are stored in the database. The available options are Asc and Desc. | | clustered | No | Boolean | Defines whether the constraint is clustered or non-clustered. Defaults to false.

SQL Server only.

| | where | No | function or object | Defines a partial index that only includes rows matching the specified condition. Accepts raw("SQL expression") or an object literal like { field: value }.

PostgreSQL, SQLite, SQL Server, and CockroachDB. Requires the partialIndexes Preview feature.

|

• ¹ Can be required by some of the index and field types.

Signature

@unique(map: String?, length: number?, sort: String?, clustered: Boolean?, where: raw(String) | { field: value }?)

Note: The where argument accepts either raw("SQL expression") for raw SQL predicates or an object literal like { field: value } for type-safe conditions. See Configuring partial indexes for details.

Note: Before the partialIndexes Preview feature, the signature was:

@unique(map: String?, length: number?, sort: String?, clustered: Boolean?)

Examples

Specify a unique attribute on a required String field

Specify a unique attribute on an optional String field

Specify a unique attribute with cuid() values as default values

@@unique

Defines a compound unique constraint for the specified fields.

General

• All fields that make up the unique constraint must be mandatory fields. The following model is not valid because id could be null:

  model User {
    firstname Int
    lastname  Int
    id        Int?
  
    @@unique([firstname, lastname, id])
  }
  

  The reason for this behavior is that all connectors consider null values to be distinct, which means that two rows that look identical are considered unique:

   firstname  | lastname | id
   -----------+----------+------
   John       | Smith    | null
   John       | Smith    | null
  

• A model can have any number of @@unique blocks

Relational databases

• Corresponding database construct: UNIQUE
• A @@unique block is required if it represents the only unique constraint on a model without an @id / @@id
• Adding a unique constraint automatically adds a corresponding unique index to the specified column(s)

MongoDB

• Enforced by a compound index in MongoDB
• A @@unique block cannot be used as the only unique identifier for a model - MongoDB requires an @id field

Arguments

| | sort | No | String | Allows you to specify in what order the entries of the constraint are stored in the database. The available options are Asc and Desc. | | clustered | No | Boolean | Defines whether the constraint is clustered or non-clustered. Defaults to false.

SQL Server only.

| | where | No | function or object | Defines a partial index that only includes rows matching the specified condition. Accepts raw("SQL expression") or an object literal like { field: value }.

PostgreSQL, SQLite, SQL Server, and CockroachDB. Requires the partialIndexes Preview feature.

|

The name of the fields argument on the @@unique attribute can be omitted:

@@unique(fields: [title, author])
@@unique([title, author])
@@unique(fields: [title, author], name: "titleAuthor")

The length and sort arguments are added to the relevant field names:

@@unique(fields: [title(length:10), author])
@@unique([title(sort: Desc), author(sort: Asc)])

Signature

@@unique(_ fields: FieldReference[], name: String?, map: String?, where: raw(String) | { field: value }?)

Note: The where argument accepts either raw("SQL expression") for raw SQL predicates or an object literal like { field: value } for type-safe conditions. See Configuring partial indexes for details.

Note: Before the partialIndexes Preview feature (and before version 4.0.0 / 3.5.0 with the extendedIndexes Preview feature), the signature was:

@@unique(_ fields: FieldReference[], name: String?, map: String?)

Examples

Specify a multi-field unique attribute on two String fields

To retrieve a user, use the generated field name (firstname_lastname):

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

Specify a multi-field unique attribute on two String fields and one Boolean field

Specify a multi-field unique attribute that includes a relation field

Specify a custom name for a multi-field unique attribute

To retrieve a user, use the custom field name (admin_identifier):

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

@@index

Defines an index in the database.

Relational databases

• Corresponding database construct: INDEX
• There are some additional index configuration options that cannot be provided via the Prisma schema yet. These include:
  • PostgreSQL and CockroachDB:
    • Define index fields as expressions (e.g. CREATE INDEX title ON public."Post"((lower(title)) text_ops);)
    • Create indexes concurrently with CONCURRENTLY

MongoDB

Arguments

| | sort | No | String | Allows you to specify in what order the entries of the index or constraint are stored in the database. The available options are asc and desc. | | clustered | No | Boolean | Defines whether the index is clustered or non-clustered. Defaults to false.

SQL Server only.

| | type | No | identifier | Allows you to specify an index access method. Defaults to BTree.

PostgreSQL and CockroachDB only.

| | ops | No | identifier or a function | Allows you to define the index operators for certain index types.

PostgreSQL only.

| | where | No | function or object | Defines a partial index that only includes rows matching the specified condition. Accepts raw("SQL expression") or an object literal like { field: value }.

PostgreSQL, SQLite, SQL Server, and CockroachDB. Requires the partialIndexes Preview feature.

|

The name of the fields argument on the @@index attribute can be omitted:

@@index(fields: [title, author])
@@index([title, author])

The length and sort arguments are added to the relevant field names:

@@index(fields: [title(length:10), author])
@@index([title(sort: Asc), author(sort: Desc)])

Signature

@@index(_ fields: FieldReference[], map: String?, where: raw(String) | { field: value }?)

Note: The where argument accepts either raw("SQL expression") for raw SQL predicates or an object literal like { field: value } for type-safe conditions. See Configuring partial indexes for details.

Note: With the partialIndexes Preview feature, the where argument is available. Before this Preview feature, the signature was:

@@index(_ fields: FieldReference[], map: String?)

Examples

Assume you want to add an index for the title field of the Post model

Define a single-column index (Relational databases only)

model Post {
  id      Int     @id @default(autoincrement())
  title   String
  content String?

  @@index([title])
}

Define a multi-column index (Relational databases only)

model Post {
  id      Int     @id @default(autoincrement())
  title   String
  content String?

  @@index([title, content])
}

Define an index with a name (Relational databases only)

model Post {
  id      Int     @id @default(autoincrement())
  title   String
  content String?

  @@index(fields: [title, content], name: "main_index")
}

Define an index on a composite type field (Relational databases only)

type Address {
  street String
  number Int
}

model User {
  id      Int     @id
  email   String
  address Address

  @@index([address.number])
}

@relation

Defines meta information about the relation. Learn more.

Relational databases

• Corresponding database constructs: FOREIGN KEY / REFERENCES

MongoDB

• If your model's primary key is of type ObjectId in the underlying database, both the primary key and the foreign key must have the @db.ObjectId attribute

Arguments

The name of the name argument on the @relation attribute can be omitted (references is required):

@relation(name: "UserOnPost", references: [id])
@relation("UserOnPost", references: [id])

// or

@relation(name: "UserOnPost")
@relation("UserOnPost")

Signature

@relation(_ name: String?, fields: FieldReference[]?, references: FieldReference[]?, onDelete: ReferentialAction?, onUpdate: ReferentialAction?, map: String?)

With SQLite, the signature changes to:

@relation(_ name: String?, fields: FieldReference[]?, references: FieldReference[]?, onDelete: ReferentialAction?, onUpdate: ReferentialAction?)

Examples

See: The @relation attribute.

@map

Maps a field name or enum value from the Prisma schema to a column or document field with a different name in the database. If you do not use @map, the Prisma field name matches the column name or document field name exactly.

See Using custom model and field names to see how @map and @@map changes the generated Prisma Client.

General

• @map does not rename the columns / fields in the database
• @map does change the field names in the generated client

MongoDB

Your @id field must include @map("_id"). For example:

model User {
  id String @default(auto()) @map("_id") @db.ObjectId
}

Arguments

The name of the name argument on the @map attribute can be omitted:

@map(name: "is_admin")
@map("users")

Signature

@map(_ name: String)

Examples

Map the firstName field to a column called first_name

The generated client:

await prisma.user.create({
  data: {
    firstName: "Yewande", // first_name */} firstName
  },
});

Map an enum named ADMIN to a database enum named admin

enum Role {
  ADMIN    @map("admin")
  CUSTOMER
}

In Prisma ORM v7 and later, the generated TypeScript enum uses the mapped values:

export const Role = {
  ADMIN: "admin",
  CUSTOMER: "CUSTOMER",
} as const;

This means Role.ADMIN evaluates to "admin", not "ADMIN".

@@map

Maps the Prisma schema model name to a table (relational databases) or collection (MongoDB) with a different name, or an enum name to a different underlying enum in the database. If you do not use @@map, the model name matches the table (relational databases) or collection (MongoDB) name exactly.

See Using custom model and field names to see how @map and @@map changes the generated Prisma Client.

Arguments

The name of the name argument on the @@map attribute can be omitted

@@map(name: "users")
@@map("users")

Signature

@@map(_ name: String)

Examples

Map the User model to a database table/collection named users

The generated client:

await prisma.user.create({
  // users */} user
  data: {
    name: "Yewande",
  },
});

Map the Role enum to a native enum in the database named _Role its values to lowercase values in the database

enum Role {
  ADMIN    @map("admin")
  CUSTOMER @map("customer")

  @@map("_Role")
}

@updatedAt

Automatically stores the time when a record was last updated. If you do not supply a time yourself, Prisma Client will automatically set the value for fields with this attribute.

• Compatible with DateTime fields
• Implemented at Prisma ORM level

Arguments

N/A

Signature

@updatedAt

Examples

@ignore

Add @ignore to a field that you want to exclude from Prisma Client (for example, a field that you do not want Prisma Client users to update). Ignored fields are excluded from the generated Prisma Client. The model's create method is disabled when doing this for required fields with no @default (because the database cannot create an entry without that data).

• Prisma ORM automatically adds @ignore to fields that refer to invalid models when you introspect.

Examples

The following example demonstrates manually adding @ignore to exclude the email field from Prisma Client:

schema.prisma

model User {
  id    Int    @id
  name  String
  email String @ignore // this field will be excluded
}

@@ignore

Add @@ignore to a model that you want to exclude from Prisma Client (for example, a model that you do not want Prisma users to update). Ignored models are excluded from the generated Prisma Client.

• Prisma ORM adds @@ignore to an invalid model during introspection. (It also adds @ignore to relations pointing to such a model)

Examples

In the following example, the Post model is invalid because it does not have a unique identifier. Use @@ignore to exclude it from the generated Prisma Client API:

schema.prisma

/// The underlying table does not contain a valid unique identifier and can therefore currently not be handled by Prisma Client.
model Post {
  id       Int  @default(autoincrement()) // no unique identifier
  author   User @relation(fields: [authorId], references: [id])
  authorId Int

  @@ignore
}

In the following example, the Post model is invalid because it does not have a unique identifier, and the posts relation field on User is invalid because it refers to the invalid Post model. Use @@ignore on the Post model and @ignore on the posts relation field in User to exclude both the model and the relation field from the generated Prisma Client API:

schema.prisma

/// The underlying table does not contain a valid unique identifier and can therefore currently not be handled by Prisma Client.
model Post {
  id       Int  @default(autoincrement()) // no unique identifier
  author   User @relation(fields: [authorId], references: [id])
  authorId Int

  @@ignore
}

model User {
  id    Int     @id @default(autoincrement())
  name  String?
  posts Post[]  @ignore
}

@@schema

Add @@schema to a model to specify which schema in your database should contain the table associated with that model. Learn more about adding multiple schema's here.

Arguments

The name of the name argument on the @@schema attribute can be omitted

@@schema(name: "auth")
@@schema("auth")

Signature

@@schema(_ name: String)

Examples

Map the User model to a database schema named auth

generator client {
  provider        = "prisma-client"
  output          = "./generated"
}

datasource db {
  provider = "postgresql"
  schemas  = ["auth"] 
}

model User {
  id   Int    @id @default(autoincrement())
  name String

  @@schema("auth") 
}

@shardKey

The @shardKey attribute is only compatible with PlanetScale databases. It enables you define a shard key on a field of your model:

model User {
  id     String @default(uuid())
  region String @shardKey
}

@@shardKey

The @@shardKey attribute is only compatible with PlanetScale databases. It enables you define a shard key on multiple fields of your model:

model User {
  id         String @default(uuid())
  country    String
  customerId String
  @@shardKey([country, customerId])
}

auto()

Represents default values that are automatically generated by the database.

MongoDB

Used to generate an ObjectId for @id fields:

id  String  @map("_id") @db.ObjectId @default(auto())

Relational databases

The auto() function is not available on relational databases.

Example

Generate ObjectId (MongoDB only)

model User {
  id   String  @id @default(auto()) @map("_id") @db.ObjectId
  name String?
}

autoincrement()

Create a sequence of integers in the underlying database and assign the incremented values to the ID values of the created records based on the sequence.

• Compatible with Int on most databases (BigInt on CockroachDB)

• Implemented on the database-level, meaning that it manifests in the database schema and can be recognized through introspection. Database implementations:

Examples

Generate autoincrementing integers as IDs (Relational databases only)

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

sequence()

Create a sequence of integers in the underlying database and assign the incremented values to the values of the created records based on the sequence.

Optional arguments

Examples

Generate sequencing integers as IDs

model User {
  id   Int    @id @default(sequence(maxValue: 4294967295))
  name String
}

cuid()

Generate a globally unique identifier based on the cuid spec.

If you'd like to use cuid2 values, you can pass 2 as an argument to the cuid function: cuid(2).

• Compatible with String.
• Implemented by Prisma ORM and therefore not "visible" in the underlying database schema. You can still use cuid() when using introspection by manually changing your Prisma schema and generating Prisma Client, in that case the values will be generated by Prisma ORM.
• Since the length of cuid() output is undefined per the cuid creator, a safe field size is 30 characters, in order to allow for enough characters for very large values. If you set the field size as less than 30, and then a larger value is generated by cuid(), you might see Prisma Client errors such as Error: The provided value for the column is too long for the column's type.
• For MongoDB: cuid() does not generate a valid ObjectId. You can use @db.ObjectId syntax if you want to use ObjectId in the underlying database. However, you can still use cuid() if your _id field is not of type ObjectId.

Examples

Generate cuid() values as IDs

Generate cuid(2) values as IDs based on the cuid2 spec

uuid()

Generate a globally unique identifier based on the UUID spec. Prisma ORM supports versions 4 (default) and 7.

• Compatible with String.
• Implemented by Prisma ORM and therefore not "visible" in the underlying database schema. You can still use uuid() when using introspection by manually changing your Prisma schema and generating Prisma Client, in that case the values will be generated by Prisma ORM.
• For relational databases: If you do not want to use Prisma ORM's uuid() function, you can use the native database function with dbgenerated.
• For MongoDB: uuid() does not generate a valid ObjectId. You can use @db.ObjectId syntax if you want to use ObjectId in the underlying database. However, you can still use uuid() if your _id field is not of type ObjectId.

Examples

Generate uuid() values as IDs using UUID v4

Generate uuid(7) values as IDs using UUID v7

ulid()

Generate a universally unique lexicographically sortable identifier based on the ULID spec.

• ulid() will produce 128-bit random identifier represented as a 26-character long alphanumeric string, e.g.: 01ARZ3NDEKTSV4RRFFQ69G5FAV

Examples

Generate ulid() values as IDs

nanoid()

Generated values based on the Nano ID spec. nanoid() accepts an integer value between 2 and 255 that specifies the length of the generate ID value, e.g. nanoid(16) will generated ID with 16 characters. If you don't provide a value to the nanoid() function, the default value is 21.

• Compatible with String.
• Implemented by Prisma ORM and therefore not "visible" in the underlying database schema. You can still use uuid() when using introspection by manually changing your Prisma schema and generating Prisma Client, in that case the values will be generated by Prisma ORM.
• For MongoDB: nanoid() does not generate a valid ObjectId. You can use @db.ObjectId syntax if you want to use ObjectId in the underlying database. However, you can still use nanoid() if your _id field is not of type ObjectId.

Examples

Generate nanoid() values with 21 characters as IDs

Generate nanoid() values with 16 characters as IDs

now()

Set a timestamp of the time when a record is created.

General

• Compatible with DateTime

Relational databases

• Implemented on the database-level, meaning that it manifests in the database schema and can be recognized through introspection. Database implementations:

MongoDB

• Implemented at Prisma ORM level

Examples

Set current timestamp value when a record is created

dbgenerated(...)

Represents default values that cannot be expressed in the Prisma schema (such as random()).

Relational databases

• Compatible with any scalar type

• Can not be an empty string dbgenerated("")

• Accepts a String value, which allows you to:

  • Set default values for Unsupported types
  • Override default value behavior for supported types

• String values in dbgenerated(...) might not match what the DB returns as the default value, because values such as strings may be explicitly cast (e.g. 'hello'::STRING). When a mismatch is present, Prisma Migrate indicates a migration is still needed. You can use prisma db pull to infer the correct value to resolve the discrepancy. (Related issue)

Examples

Set default value for Unsupported type

circle     Unsupported("circle")?   @default(dbgenerated("'<(10,4),11>'::circle"))

Override default value behavior for supported types

You can also use dbgenerated(...) to set the default value for supported types. For example, in PostgreSQL you can generate UUIDs at the database level rather than rely on Prisma ORM's uuid():

model User {
  id   String  @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
  id   String  @id @default(uuid()) @db.Uuid
  test String?
}

FieldReference[]

An array of field names: [id], [firstName, lastName]

String

A variable length text in double quotes: "", "Hello World", "Alice"

Expression

An expression that can be evaluated by Prisma ORM: 42.0, "", Bob, now(), cuid()

Defines an enum .

• Enums are natively supported by PostgreSQL and MySQL
• Enums are implemented and enforced at Prisma ORM level in SQLite and MongoDB

Naming conventions

• Enum names must start with a letter (they are typically spelled in PascalCase)
• Enums must use the singular form (e.g. Role instead of role, roles or Roles).
• Must adhere to the following regular expression: [A-Za-z][A-Za-z0-9_]*

Examples

Specify an enum with two possible values

Specify an enum with two possible values and set a default value

Defines a composite type.

Naming conventions

Type names must:

• start with a letter (they are typically spelled in PascalCase)
• adhere to the following regular expression: [A-Za-z][A-Za-z0-9_]*

Examples

Define a Product model with a list of Photo composite types

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

type Photo {
  height Int
  width  Int
  url    String
}