Skip to content

AMS #8062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
asmaems411-411 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

AMS #8062

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
285 changes: 50 additions & 235 deletions apps/docs/content/docs/orm/prisma-schema/overview/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,77 +1,5 @@
---
title: Overview of Prisma Schema
description: The Prisma schema is the main method of configuration when using Prisma. It is typically called schema.prisma and contains your database connection and data model
url: /orm/prisma-schema/overview
metaTitle: Prisma schema
metaDescription: Learn everything you need to know about the Prisma schema.
---

The Prisma Schema (or _schema_ for short) is the main method of configuration for your Prisma ORM setup. It consists of the following parts:

- [**Data sources**](/orm/prisma-schema/overview/data-sources): Specify the details of the data sources Prisma ORM should connect to (e.g. a PostgreSQL database)
- [**Generators**](/orm/prisma-schema/overview/generators): Specifies what clients should be generated based on the data model (e.g. Prisma Client)
- [**Data model definition**](/orm/prisma-schema/data-model/models): Specifies your application [models](/orm/prisma-schema/data-model/models#defining-models) (the shape of the data per data source) and their [relations](/orm/prisma-schema/data-model/relations)

It is typically a single file called `schema.prisma` (or multiple files with `.prisma` file extension) that is stored in a defined but customizable [location](/orm/prisma-schema/overview/location). You can also [organize your Prisma schema in multiple files](/orm/prisma-schema/overview/location#multi-file-prisma-schema) if you prefer that.

See the [Prisma schema API reference](/orm/reference/prisma-schema-reference) <span class="api"></span> for detailed information about each section of the schema.

Whenever a `prisma` command is invoked, the CLI typically reads some information from the schema, e.g.:

- `prisma generate`: Reads _all_ above mentioned information from the Prisma schema to generate the correct data source client code (e.g. Prisma Client).
- `prisma migrate dev`: Reads the data sources and data model definition to create a new migration.

You can also [use environment variables](#accessing-environment-variables-from-the-schema) inside the schema to provide configuration options when a CLI command is invoked.

## Example

The following is an example of a Prisma Schema that specifies:

- A data source (PostgreSQL or MongoDB)
- A generator (Prisma Client)
- A data model definition with two models (with one relation) and one `enum`
- Several [native data type attributes](/orm/prisma-schema/data-model/models#native-types-mapping) (`@db.VarChar(255)`, `@db.ObjectId`)


```prisma tab="Relational Databases"
datasource db {
provider = "postgresql"
}

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

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

model Post {
id Int @id @default(autoincrement())
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
published Boolean @default(false)
title String @db.VarChar(255)
author User @relation(fields: [authorId], references: [id])
authorId Int
}

enum Role {
USER
ADMIN
}
```


```prisma tab="MongoDB"
datasource db {
provider = "mongodb"
url = env("DATABASE_URL")
}

Expand All @@ -80,174 +8,61 @@ generator client {
}

model User {
id String @id @default(auto()) @map("_id") @db.ObjectId
id String @id @default(cuid())
email String @unique
name String?
passwordHash String?
stripeCustomerId String? @unique
subscriptionPlan String @default("STARTER") // STARTER, PROFESSIONAL, AGENCY
createdAt datetime @default(now())

@coderabbitai coderabbitai Bot Jul 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Fix invalid Prisma type: datetime should be DateTime.

Line 17 uses datetime (lowercase), which is not a valid Prisma scalar type. Prisma type names are case-sensitive — the correct type is DateTime, as correctly used on line 18 and in every other model in this schema. A user copying this example would hit a schema validation error.

🔧 Proposed fix 
-  createdAt        datetime      `@default`(now())
+  createdAt        DateTime      `@default`(now())
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
createdAt datetime @default(now())
createdAt DateTime `@default`(now())
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@apps/docs/content/docs/orm/prisma-schema/overview/index.mdx` at line 17,
Update the createdAt field in the Prisma schema example to use the valid
case-sensitive DateTime scalar instead of datetime, matching the existing type
usage in the surrounding model.

updatedAt DateTime @updatedAt
leads Lead[]
knowledgeBase Knowledge[]
appointments Appointment[]
}

model Lead {
id String @id @default(cuid())
userId String
user User @relation(fields: [userId], references: [id])
name String?
email String?
phone String?
company String?
status String @default("NEW") // NEW, QUALIFIED, BOOKED, HUMAN_REQUIRED
notes String?
createdAt DateTime @default(now())
messages Message[]
appointments Appointment[]
}

model Message {
id String @id @default(cuid())
leadId String
lead Lead @relation(fields: [leadId], references: [id])
sender String @default("AI") // USER, AI, HUMAN
content String
createdAt DateTime @default(now())
email String @unique
name String?
role Role @default(USER)
posts Post[]
}

model Post {
id String @id @default(auto()) @map("_id") @db.ObjectId
model Appointment {
id String @id @default(cuid())
userId String
user User @relation(fields: [userId], references: [id])
leadId String
lead Lead @relation(fields: [leadId], references: [id])
startTime DateTime
endTime DateTime
status String @default("SCHEDULED")
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
published Boolean @default(false)
title String
author User @relation(fields: [authorId], references: [id])
authorId String @db.ObjectId
}

enum Role {
USER
ADMIN
}
```


## Syntax

Prisma Schema files are written in Prisma Schema Language (PSL). See the [data sources](/orm/prisma-schema/overview/data-sources), [generators](/orm/prisma-schema/overview/generators), [data model definition](/orm/prisma-schema/data-model/models) and of course [Prisma Schema API reference](/orm/reference/prisma-schema-reference) pages for details and examples.

### VS Code

Syntax highlighting for PSL is available via a [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma) (which also lets you auto-format the contents of your Prisma schema and indicates syntax errors with red squiggly lines). Learn more about [setting up Prisma ORM in your editor](/orm/more/dev-environment/editor-setup).

### GitHub

PSL code snippets on GitHub can be rendered with syntax highlighting as well by using the `.prisma` file extension or annotating fenced code blocks in Markdown with `prisma`:

````mdx
```prisma
model User {
id Int @id @default(autoincrement())
model Knowledge {
id String @id @default(cuid())
userId String
user User @relation(fields: [userId], references: [id])
category String // e.g., "FAQ", "Pricing", "Services"
question String
answer String
createdAt DateTime @default(now())
email String @unique
name String?
}
```
````

## Accessing environment variables from the schema

You can use environment variables to provide configuration options when a CLI command is invoked, or a Prisma Client query is run.

Hardcoding URLs directly in your schema is possible but is discouraged because it poses a security risk. Using environment variables in the schema allows you to **keep secrets out of the schema** which in turn **improves the portability of the schema** by allowing you to use it in different environments.

Environment variables can be accessed using the `env()` function:

```prisma
datasource db {
provider = "postgresql"
}
```

You can use the `env()` function in the following places:

- A datasource url
- Generator binary targets

See [Environment variables](/orm/more/dev-environment/environment-variables) for more information about how to use an `.env` file during development.

## Comments

There are three types of comments that are supported in Prisma Schema Language:

- `// comment`: This comment is for the reader's clarity and is not present in the abstract syntax tree (AST) of the schema.
- `/// comment`: These comments will show up in the abstract syntax tree (AST) of the schema as descriptions to AST nodes. Tools can then use these comments to provide additional information. All comments are attached to the next available node - [free-floating comments](https://github.com/prisma/prisma/issues/3544) are not supported and are not included in the AST.
- `/* block comment */`: These comments will show up in the abstract syntax tree, similarly to `///` comments.

Here are some different examples:

```prisma
/// This comment will get attached to the `User` node in the AST
model User {
/// This comment will get attached to the `id` node in the AST
id Int @default(autoincrement())
// This comment is just for you
weight Float /// This comment gets attached to the `weight` node
}

// This comment is just for you. It will not
// show up in the AST.

/// This comment will get attached to the
/// Customer node.
model Customer {
/**
* ...and so will this comment
*/
}
```

## Auto formatting

Prisma ORM supports formatting `.prisma` files automatically. There are two ways to format `.prisma` files:

- Run the [`prisma format`](/orm/reference/prisma-cli-reference#format) <span class="api"></span> command.
- Install the [Prisma VS Code extension](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma) and invoke the [VS Code format action](https://code.visualstudio.com/docs/editor/codebasics#_formatting) - manually or on save.

There are no configuration options - [formatting rules](#formatting-rules) are fixed (similar to Golang's `gofmt` but unlike Javascript's `prettier`):

### Formatting rules

#### Configuration blocks are aligned by their = sign

```
block _ {
key = "value"
key2 = 1
long_key = true
}
```

#### Field definitions are aligned into columns separated by 2 or more spaces

```
block _ {
id String @id
first_name LongNumeric @default
}
```

#### Empty lines resets block alignment and formatting rules

```
block _ {
key = "value"
key2 = 1
key10 = true

long_key = true
long_key_2 = true
}
```

```
block _ {
id String @id
@default

first_name LongNumeric @default
}
```

#### Multiline field attributes are properly aligned with the rest of the field attributes

```
block _ {
id String @id
@default
first_name LongNumeric @default
}
```

#### Block attributes are sorted to the end of the block

```
block _ {
key = "value"

@@attribute
}
```