\n\n## What is Prisma?\n\nPrisma ORM is a **next-generation ORM** that consists of these tools:\n\n- [**Prisma Client**](https://www.prisma.io/docs/orm/prisma-client): Auto-generated and type-safe query builder for Node.js & TypeScript\n- [**Prisma Migrate**](https://www.prisma.io/docs/orm/prisma-migrate): Declarative data modeling & migration system\n- [**Prisma Studio**](https://github.com/prisma/studio): GUI to view and edit data in your database\n\nPrisma Client can be used in _any_ Node.js or TypeScript backend application (including serverless applications and microservices). This can be a [REST API](https://www.prisma.io/docs/concepts/overview/prisma-in-your-stack/rest), a [GraphQL API](https://www.prisma.io/docs/concepts/overview/prisma-in-your-stack/graphql), a gRPC API, or anything else that needs a database.\n\n**If you need a database to use with Prisma ORM, check out [Prisma Postgres](https://www.prisma.io/docs/getting-started/prisma-orm/quickstart/prisma-postgres?utm_source=github&utm_medium=prisma-readme) or if you are looking for our MCP Server, head [here](https://github.com/prisma/mcp).**\n\n## Getting started\n\n### Quickstart (5min)\n\nThe fastest way to get started with Prisma is by following the quickstart guides. You can choose either of two databases:\n\n- [Prisma Postgres](https://www.prisma.io/docs/getting-started/prisma-orm/quickstart/prisma-postgres)\n- [SQLite](https://www.prisma.io/docs/getting-started/prisma-orm/quickstart/sqlite)\n\n### Bring your own database\n\nIf you already have your own database, you can follow these guides:\n\n- [Add Prisma to an existing project](https://www.prisma.io/docs/getting-started/prisma-orm/add-to-existing-project/postgresql)\n- [Set up a new project with Prisma from scratch](https://www.prisma.io/docs/getting-started/setup-prisma/start-from-scratch/relational-databases-typescript-postgresql)\n\n## How Prisma ORM works\n\nThis section provides a high-level overview of how Prisma ORM works and its most important technical components. For a more thorough introduction, visit the [Prisma documentation](https://www.prisma.io/docs/).\n\n### The Prisma schema\n\nEvery project that uses a tool from the Prisma toolkit starts with a [Prisma schema file](https://www.prisma.io/docs/orm/prisma-schema). The Prisma schema allows developers to define their _application models_ in an intuitive data modeling language and configure _generators_.\n\n```prisma\n// Data source\ndatasource db {\n provider = \"postgresql\"\n}\n\n// Generator\ngenerator client {\n provider = \"prisma-client\"\n output = \"../generated\"\n}\n\n// Data model\nmodel Post {\n id Int @id @default(autoincrement())\n title String\n content String?\n published Boolean @default(false)\n author User? @relation(fields: [authorId], references: [id])\n authorId Int?\n}\n\nmodel User {\n id Int @id @default(autoincrement())\n email String @unique\n name String?\n posts Post[]\n}\n```\n\nIn this schema, you configure three things:\n\n- **Data source**: Specifies your database type and thus defines the features and data types you can use in the schema\n- **Generator**: Indicates that you want to generate Prisma Client\n- **Data model**: Defines your application models\n\n### `prisma.config.ts`\n\nDatabase connection details are defined via [`prisma.config.ts`](https://www.prisma.io/docs/orm/prisma-schema/prisma-config-reference).\n\n```ts\nimport { defineConfig } from 'prisma/config'\n\nexport default defineConfig({\n datasource: {\n url: 'postgres://...',\n },\n})\n```\n\nIf you store the database connection string in `process.env`, an `env` function can help you access it in a type safe way and throw an error if it is missing at run time:\n\n```ts\nimport { defineConfig, env } from 'prisma/config'\n\nexport default defineConfig({\n datasource: {\n url: env('DATABASE_URL'),\n },\n})\n```\n\nPrisma ORM does not load the `.env` files for you automatically. If you want to populate the environment variables from a `.env` file, consider using a package such as [`dotenv`](https://www.npmjs.com/package/dotenv) or [`@dotenvx/dotenvx`](https://www.npmjs.com/package/@dotenvx/dotenvx).\n\nThe configuration file may look like this in that case:\n\n```ts\nimport 'dotenv/config'\nimport { defineConfig, env } from 'prisma/config'\n\nexport default defineConfig({\n datasource: {\n url: env('DATABASE_URL'),\n },\n})\n```\n\nTo start a local PostgreSQL development server without using Docker and without any configuration, run `prisma dev`:\n\n```sh\nnpx prisma dev\n```\n\nAlternatively, spin up an instant Prisma Postgres® database in the cloud:\n\n```sh\nnpx create-db --interactive\n```\n\n---\n\n### The Prisma data model\n\nOn this page, the focus is on the data model. You can learn more about [Data sources](https://www.prisma.io/docs/orm/prisma-schema/overview/data-sources) and [Generators](https://www.prisma.io/docs/orm/prisma-schema/overview/generators) on the respective docs pages.\n\n#### Functions of Prisma models\n\nThe data model is a collection of [models](https://www.prisma.io/docs/orm/prisma-schema/data-model/models). A model has two major functions:\n\n- Represent a table in the underlying database\n- Provide the foundation for the queries in the Prisma Client API\n\n#### Getting a data model\n\nThere are two major workflows for \"getting\" a data model into your Prisma schema:\n\n- Generate the data model from [introspecting](https://www.prisma.io/docs/orm/prisma-schema/introspection) a database\n- Manually writing the data model and mapping it to the database with [Prisma Migrate](https://www.prisma.io/docs/orm/prisma-migrate)\n\nOnce the data model is defined, you can [generate Prisma Client](https://www.prisma.io/docs/orm/prisma-client/setup-and-configuration/generating-prisma-client) which will expose CRUD and more queries for the defined models. If you're using TypeScript, you'll get full type-safety for all queries (even when only retrieving the subsets of a model's fields).\n\n---\n\n### Accessing your database with Prisma Client\n\n#### Step 1: Install Prisma\n\nFirst, install Prisma CLI as a development dependency and Prisma Client:\n\n```\nnpm install prisma --save-dev\nnpm install @prisma/client\n```\n\n#### Step 2: Set up your Prisma schema\n\nEnsure your Prisma schema includes a `generator` block with an `output` path specified:\n\n```prisma\ngenerator client {\n provider = \"prisma-client\"\n output = \"../generated\"\n}\n\ndatasource db {\n provider = \"postgresql\" // mysql, sqlite, sqlserver, mongodb or cockroachdb\n}\n```\n\n#### Step 3: Configure Prisma Config\n\nConfigure the Prisma CLI using a `prisma.config.ts` file. This file configures Prisma CLI subcommands like `migrate` and `studio`. Create a `prisma.config.ts` file in your project root:\n\n```ts\nimport { defineConfig, env } from 'prisma/config'\n\ntype Env = {\n DATABASE_URL: string\n}\n\nexport default defineConfig({\n schema: 'prisma/schema.prisma',\n migrations: {\n path: 'prisma/migrations',\n },\n datasource: {\n url: env('DATABASE_URL'),\n },\n})\n```\n\n**Note**: Environment variables from `.env` files are not automatically loaded when using `prisma.config.ts`. You can use `dotenv` by importing `dotenv/config` at the top of your config file. For Bun, `.env` files are automatically loaded.\n\nLearn more about [Prisma Config](https://www.prisma.io/docs/orm/reference/prisma-config-reference) and all available configuration options.\n\n#### Step 4: Generate Prisma Client\n\nGenerate Prisma Client with the following command:\n\n```\nnpx prisma generate\n```\n\nThis command reads your Prisma schema and _generates_ the Prisma Client code in the location specified by the `output` path in your generator configuration.\n\nAfter you change your data model, you'll need to manually re-generate Prisma Client to ensure the generated code gets updated:\n\n```\nnpx prisma generate\n```\n\nRefer to the documentation for more information about [\"generating the Prisma client\"](https://www.prisma.io/docs/orm/prisma-client/setup-and-configuration/generating-prisma-client).\n\n#### Step 5: Use Prisma Client to send queries to your database\n\nOnce the Prisma Client is generated, you can import it in your code and send queries to your database.\n\n##### Import and instantiate Prisma Client\n\nYou can import and instantiate Prisma Client from the output path specified in your generator configuration. When instantiating the Client, you need to provide a [driver adapter](https://www.prisma.io/docs/orm/core-concepts/supported-databases/database-drivers#how-to-use-driver-adapters) to its constructor. For example, when using PostgreSQL with a driver adapter:\n\n```ts\nimport { PrismaClient } from './generated/client'\nimport { PrismaPg } from '@prisma/adapter-pg'\n\nconst adapter = new PrismaPg({ connectionString: process.env.DATABASE_URL })\nconst prisma = new PrismaClient({ adapter })\n```\n\nTo load environment variables, you can use `dotenv` by importing `dotenv/config`, use `tsx --env-file=.env`, `node --env-file=.env`, or Bun (which loads `.env` automatically).\n\nNow you can start sending queries via the generated Prisma Client API, here are a few sample queries. Note that all Prisma Client queries return _plain old JavaScript objects_.\n\nLearn more about the available operations in the [Prisma Client docs](https://www.prisma.io/docs/orm/prisma-client) or watch this [demo video](https://www.youtube.com/watch?v=LggrE5kJ75I&list=PLn2e1F9Rfr6k9PnR_figWOcSHgc_erDr5&index=4) (2 min).\n\n##### Retrieve all `User` records from the database\n\n```ts\nconst allUsers = await prisma.user.findMany()\n```\n\n##### Include the `posts` relation on each returned `User` object\n\n```ts\nconst allUsers = await prisma.user.findMany({\n include: { posts: true },\n})\n```\n\n##### Filter all `Post` records that contain `\"prisma\"`\n\n```ts\nconst filteredPosts = await prisma.post.findMany({\n where: {\n OR: [{ title: { contains: 'prisma' } }, { content: { contains: 'prisma' } }],\n },\n})\n```\n\n##### Create a new `User` and a new `Post` record in the same query\n\n```ts\nconst user = await prisma.user.create({\n data: {\n name: 'Alice',\n email: 'alice@prisma.io',\n posts: {\n create: { title: 'Join us for Prisma Day 2021' },\n },\n },\n})\n```\n\n##### Update an existing `Post` record\n\n```ts\nconst post = await prisma.post.update({\n where: { id: 42 },\n data: { published: true },\n})\n```\n\n#### Usage with TypeScript\n\nNote that when using TypeScript, the result of this query will be _statically typed_ so that you can't accidentally access a property that doesn't exist (and any typos are caught at compile-time). Learn more about leveraging Prisma Client's generated types on the [Advanced usage of generated types](https://www.prisma.io/docs/orm/prisma-client/type-safety/operating-against-partial-structures-of-model-types) page in the docs.\n\n## Community\n\nPrisma has a large and supportive [community](https://www.prisma.io/community) of enthusiastic application developers. You can join us on [Discord](https://pris.ly/discord) and here on [GitHub](https://github.com/prisma/prisma/discussions).\n\n## Badges\n\n[](https://prisma.io) [](https://prisma.io)\n\nBuilt something awesome with Prisma? 🌟 Show it off with these [badges](https://github.com/prisma/presskit?tab=readme-ov-file#badges), perfect for your readme or website.\n\n```\n[](https://prisma.io)\n```\n\n```\n[](https://prisma.io)\n```\n\n## Security\n\nIf you have a security issue to report, please contact us at [security@prisma.io](mailto:security@prisma.io?subject=[GitHub]%20Prisma%202%20Security%20Report%20).\n\n## Support\n\n### Ask a question about Prisma\n\nYou can ask questions and initiate [discussions](https://github.com/prisma/prisma/discussions/) about Prisma-related topics in the `prisma` repository on GitHub.\n\n👉 [**Ask a question**](https://github.com/prisma/prisma/discussions/new)\n\n### Create a bug report for Prisma\n\nIf you see an error message or run into an issue, please make sure to create a bug report! You can find [best practices for creating bug reports](https://www.prisma.io/docs/guides/other/troubleshooting-orm/creating-bug-reports) (like including additional debugging output) in the docs.\n\n👉 [**Create bug report**](https://pris.ly/prisma-prisma-bug-report)\n\n### Submit a feature request\n\nIf Prisma currently doesn't have a certain feature, be sure to check out the [roadmap](https://www.prisma.io/docs/more/roadmap) to see if this is already planned for the future.\n\nIf the feature on the roadmap is linked to a GitHub issue, please make sure to leave a 👍 reaction on the issue and ideally a comment with your thoughts about the feature!\n\n👉 [**Submit feature request**](https://github.com/prisma/prisma/issues/new?assignees=&labels=&template=feature_request.md&title=)\n\n## Contributing\n\nRefer to our [contribution guidelines](https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md) and [Code of Conduct for contributors](https://github.com/prisma/prisma/blob/main/CODE_OF_CONDUCT.md).\n\n## Tests Status\n\n- Prisma Tests Status:\n [](https://github.com/prisma/prisma/actions/workflows/test.yml?query=branch%3Amain)\n- Ecosystem Tests Status:\n [](https://github.com/prisma/ecosystem-tests/actions/workflows/test.yaml?query=branch%3Adev)\n","readmeFilename":"README.md"}
![](\"https://img.shields.io/npm/v/prisma.svg?style=flat\")
\n ![](\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\"){kind=icon}
\n ![](\"https://img.shields.io/badge/license-Apache%202-blue\"){kind=icon}
\n ![\"Discord\"](\"https://img.shields.io/discord/937751382725886062?label=Discord\")
\n