# Prisma > import Prerequisites from '../../_components/_prerequisites.mdx' ## Pages - [Quickstart with Prisma ORM and SQLite](quickstart-prisma-postgres.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Quickstart with Prisma ORM and PostgreSQL](quickstart-sqlite.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Quickstart with Prisma ORM and MySQL](quickstart-postgresql.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Quickstart with Prisma ORM and SQL Server](quickstart-mysql.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Quickstart with Prisma ORM and PlanetScale MySQL](quickstart-sql-server.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Quickstart with Prisma ORM and PlanetScale Postgres](quickstart-planetscale.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Quickstart with Prisma ORM and CockroachDB](quickstart-planetscale-postgres.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Quickstart with Prisma ORM and MongoDB](quickstart-cockroachdb.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Add Prisma ORM to an existing Prisma Postgres project](quickstart-mongodb.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Add Prisma ORM to an existing SQLite project](add-to-existing-project-prisma-postgres.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Add Prisma ORM to an existing PostgreSQL project](add-to-existing-project-sqlite.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Add Prisma ORM to an existing MySQL project](add-to-existing-project-postgresql.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Add Prisma ORM to an existing SQL Server project](add-to-existing-project-mysql.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Add Prisma ORM to an existing PlanetScale MySQL project](add-to-existing-project-sql-server.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Add Prisma ORM to an existing PlanetScale Postgres project](add-to-existing-project-planetscale.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Add Prisma ORM to an existing CockroachDB project](add-to-existing-project-planetscale-postgres.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Add Prisma ORM to an existing MongoDB project](add-to-existing-project-cockroachdb.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [From the CLI](add-to-existing-project-mongodb.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Use Prisma Postgres with Kysely](prisma-postgres-from-the-cli.md): This page provides a step-by-step guide for Prisma Postgres after setting it up with`prisma init --db`: - [Use Prisma Postgres with Drizzle ORM](quickstart-kysely.md): [Kysely](https://kysely.dev) is a type-safe TypeScript SQL query builder that provides TypeScript support and a fluen... - [Use Prisma Postgres with TypeORM](quickstart-drizzle-orm.md): [Drizzle ORM](https://orm.drizzle.team) is a TypeScript ORM. In this guide, you'll learn how to connect Drizzle ORM t... - [Use Prisma Postgres with Prisma ORM](quickstart-typeorm.md): [TypeORM](https://typeorm.io) is a TypeScript ORM. In this guide, you'll learn how to connect TypeORM to [Prisma Post... - [Import data from an existing PostgreSQL database](quickstart-prisma-orm.md): import Prerequisites from '../../_components/_prerequisites.mdx' - [Import data from an existing MySQL database](prisma-postgres-import-from-existing-database-postgresql.md): This guide provides step-by-step instructions for importing data from an existing PostgreSQL database into Prisma Pos... - [Prisma Postgres](prisma-postgres-import-from-existing-database-mysql.md): This guide provides step-by-step instructions for importing data from an existing MySQL database into Prisma Postgres. - [Get Started](prisma-postgres-index.md): Create a project directory and navigate into it: - [Quickstart with Prisma ORM](getting-started-index.md): import { - [Add Prisma ORM to an existing project](getting-started-quickstart.md): import { Redirect } from '@docusaurus/router'; - [Getting started with Prisma ORM](getting-started-add-to-existing-project.md): import { Redirect } from '@docusaurus/router'; - [What is Prisma ORM?](getting-started-index-2.md): You can either start with a fresh Prisma ORM project with a database of your choice or add Prisma ORM to an existing ... - [Why Prisma ORM?](introduction-what-is-prisma.md): Prisma ORM is an [open-source](https://github.com/prisma/prisma) next-generation ORM. It consists of the following pa... - [Should you use Prisma ORM?](introduction-why-prisma.md): On this page, you'll learn about the motivation for Prisma ORM and how it compares to other database tools like tradi... - [Data modeling](introduction-should-you-use-prisma.md): Prisma ORM is a new kind of ORM that - like any other tool - comes with its own tradeoffs. This page explains when Pr... - [Introduction to Prisma ORM](introduction-data-modeling.md): The term _data modeling_ refers to the **process of defining the shape and structure of the objects in an application... - [REST](introduction-index.md): This page gives a high-level overview of what Prisma ORM is and how it works. - [GraphQL](prisma-in-your-stack-rest.md): When building REST APIs, Prisma Client can be used inside your _route controllers_ to send databases queries. - [Fullstack](prisma-in-your-stack-graphql.md): [GraphQL](https://graphql.org/) is a query language for APIs. It is often used as an alternative to RESTful APIs, but... - [Is Prisma ORM an ORM?](prisma-in-your-stack-fullstack.md): Fullstack frameworks, such as Next.js, Remix or SvelteKit, blur the lines between the server and the client. These fr... - [Prisma ORM in your stack](prisma-in-your-stack-is-prisma-an-orm.md): To answer the question briefly: _Yes, Prisma ORM is a new kind of ORM that fundamentally differs from traditional ORM... - [Database drivers](prisma-in-your-stack-index.md): Prisma ORM provides a fully type-safe API and simplified database access. You can use Prisma ORM tools to build a Gra... - [PostgreSQL](databases-database-drivers.md): One of Prisma Client's components is the [Query Engine](/orm/more/under-the-hood/engines) (which is implemented in Ru... - [MySQL/MariaDB](databases-postgresql.md): The PostgreSQL data source connector connects Prisma ORM to a [PostgreSQL](https://www.postgresql.org/) database server. - [SQLite](databases-mysql.md): The MySQL data source connector connects Prisma ORM to a [MySQL](https://www.mysql.com/) or [MariaDB](https://mariadb... - [Prisma ORM MongoDB database connector](databases-sqlite.md): The SQLite data source connector connects Prisma ORM to a [SQLite](https://www.sqlite.org/) database file. These file... - [SQL Server on Windows (local)](databases-mongodb.md): This guide discusses the concepts behind using Prisma ORM and MongoDB, explains the commonalities and differences bet... - [SQL Server on Docker](sql-server-sql-server-local.md): :::info Quick summary - [Microsoft SQL Server](sql-server-sql-server-docker.md): :::info Quick summary - [CockroachDB](sql-server-index.md): The Microsoft SQL Server data source connector connects Prisma ORM to a [Microsoft SQL Server](https://learn.microsof... - [PlanetScale MySQL](databases-cockroachdb.md): This guide discusses the concepts behind using Prisma ORM and CockroachDB, explains the commonalities and differences... - [PlanetScale Postgres](databases-planetscale.md): Prisma ORM and [PlanetScale](https://planetscale.com/) together provide a development arena that optimizes rapid, typ... - [Supabase](databases-planetscale-postgres.md): Prisma ORM and [PlanetScale Postgres](https://planetscale.com/) work together seamlessly, combining Prisma's type-saf... - [Connect to Supabase via connection pooling with Supavisor.](databases-supabase.md): This guide discusses the concepts behind using Prisma ORM and Supabase, explains the commonalities and differences be... - [Connect to Neon with Pooling.](databases-neon.md): This guide explains how to: - [Cloudflare D1](databases-turso.md): This guide discusses the concepts behind using Prisma ORM and Turso, explains the commonalities and differences betwe... - [Databases](databases-cloudflare-d1.md): This page discusses the concepts behind using Prisma ORM and Cloudflare D1, explains the commonalities and difference... - [Beyond Prisma ORM](databases-index.md): Learn about the different databases Prisma ORM supports. - [Overview](overview-beyond-prisma-orm.md): As a Prisma ORM user, you're already experiencing the power of type-safe database queries and intuitive data modeling... - [Data sources](overview-index.md) - [Generators](overview-data-sources.md): A data source determines how Prisma ORM connects to your database, and is represented by the [`datasource`](/orm/refe... - [Keep the generated Prisma Client + query engine out of version control](overview-generators.md): A Prisma schema can have one or more generators, represented by the [`generator`](/orm/reference/prisma-schema-refere... - [All files must be inside the `prisma/` directory](overview-location.md): The default name for the Prisma Schema is a single file`schema.prisma`in your`prisma`folder. When your schema is ... - [Models](overview-index-2.md): The Prisma Schema (or _schema_ for short) is the main method of configuration for your Prisma ORM setup. It consists ... - [One-to-one relations](data-model-models.md): The data model definition part of the [Prisma schema](/orm/prisma-schema) defines your application models (also calle... - [One-to-many relations](relations-one-to-one-relations.md): :::info Quick summary - [Many-to-many relations](relations-one-to-many-relations.md): This page introduces one-to-many relations and explains how to use them in your Prisma schema. - [Self-relations](relations-many-to-many-relations.md): :::info Quick summary - [Special rules for referential actions in SQL Server and MongoDB](relations-self-relations.md): A relation field can also reference its own model, in this case the relation is called a _self-relation_. Self-relati... - [Referential actions](referential-actions-special-rules-for-referential-actions.md): :::info Quick summary - [Relation mode](referential-actions-index.md): Referential actions determine what happens to a record when your application deletes or updates a related record. - [Troubleshooting relations](relations-relation-mode.md): - What is`relationMode`in Prisma? - [Relations](relations-troubleshooting-relations.md): Modelling your schema can sometimes offer up some unexpected results. This section aims to cover the most prominent o... - [Indexes](relations-index.md): A relation is a _connection_ between two models in the Prisma schema. For example, there is a one-to-many relation be... - [Views](data-model-indexes.md): Prisma ORM allows configuration of database indexes, unique constraints and primary key constraints. This is in Gener... - [Database mapping](data-model-views.md): Database views allow you to name and store queries. In relational databases, views are [stored SQL queries](https://w... - [Multi-schema](data-model-database-mapping.md): The [Prisma schema](/orm/prisma-schema) includes mechanisms that allow you to define names of certain database object... - [External tables](data-model-multi-schema.md): PostgreSQL, CockroachDB, and SQL Server allow you to organize database tables into named groups. These groups are kno... - [Unsupported database features (Prisma Schema)](data-model-externally-managed-tables.md): _Externally managed tables_ (or _external tables_ for short) in Prisma ORM are tables that can be **queried via Prism... - [Table inheritance](data-model-unsupported-database-features.md): Not all database functions and features of Prisma ORM's supported databases have a Prisma Schema Language equivalent.... - [Data model](data-model-table-inheritance.md): Table inheritance is a software design pattern that allows the modeling of hierarchical relationships between entitie... - [What is introspection?](data-model-index.md) - [PostgreSQL extensions](prisma-schema-introspection.md): You can introspect your database using the Prisma CLI in order to generate the [data model](/orm/prisma-schema/data-m... - [Prisma schema](prisma-schema-postgresql-extensions.md): This page is about [PostgreSQL extensions](https://www.postgresql.org/docs/current/external-extensions.html) and expl... - [Introduction to Prisma Client](prisma-schema-index.md) - [Generating Prisma Client](setup-and-configuration-introduction.md): import { - [Instantiating Prisma Client](setup-and-configuration-generating-prisma-client.md): Prisma Client is a generated database client that's tailored to your database schema. By default, Prisma Client is ge... - [Connection management](setup-and-configuration-instantiate-prisma-client.md): The following example demonstrates how to import and instantiate your [generated client](/orm/prisma-client/setup-and... - [Connection pool](databases-connections-connection-management.md): :::info Quick summary - [Configure Prisma Client with PgBouncer](databases-connections-connection-pool.md): :::info Quick summary - [PgBouncer (pooled) connection string used by Prisma Client.](databases-connections-pgbouncer.md): An external connection pooler like PgBouncer holds a connection pool to the database, and proxies incoming client con... - [Connection URL to your database using PgBouncer.](databases-connections-index.md): Databases can handle a limited number of concurrent connections. Each connection requires RAM, which means that simpl... - [Configuring error formatting](setup-and-configuration-custom-model-and-field-names.md): The Prisma Client API is generated based on the models in your [Prisma schema](/orm/prisma-schema). Models are _typic... - [Read replicas](setup-and-configuration-error-formatting.md): By default, Prisma Client uses [ANSI escape characters](https://en.wikipedia.org/wiki/ANSI_escape_code) to pretty pri... - [Database polyfills](setup-and-configuration-read-replicas.md): Read replicas enable you to distribute workloads across database replicas for high-traffic workloads. The [read repli... - [No Rust engine](setup-and-configuration-database-polyfills.md): Prisma Client provides features that are typically either not achievable with particular databases or require extensi... - [Setup & configuration](setup-and-configuration-no-rust-engine.md): As of [v6.16.0](https://pris.ly/release/6.16.0), usage of Prisma ORM without [Rust engine](/orm/more/under-the-hood/e... - [CRUD](setup-and-configuration-index.md): This section describes how to set up, generate, configure, and instantiate`PrismaClient`, as well as when and how t... - [Select fields](queries-crud.md): This page describes how to perform CRUD operations with your generated Prisma Client API. CRUD is an acronym that sta... - [Relation queries](queries-select-fields.md): By default, when a query returns records (as opposed to a count), the result includes: - [Filtering and Sorting](queries-relation-queries.md): A key feature of Prisma Client is the ability to query [relations](/orm/prisma-schema/data-model/relations) between t... - [Pagination](queries-filtering-and-sorting.md): Prisma Client supports filtering with the`where`query option, and sorting with the`order... - [Aggregation, grouping, and summarizing](queries-pagination.md): Prisma Client supports both offset pagination and cursor-based pagination. - [Transactions and batch queries](queries-aggregation-grouping-summarizing.md): Prisma Client allows you to count records, aggregate number fields, and select distinct field values. - [Full-text search](queries-transactions.md): A database transaction refers to a sequence of read/write operations that are _guaranteed_ to either succeed or fail ... - [Custom validation](queries-full-text-search.md): Prisma Client supports full-text search for **PostgreSQL** databases in versions 2.30.0 and later, and **MySQL** data... - [Computed fields](queries-custom-validation.md): You can add runtime validation for your user input for Prisma Client queries in one of the following ways: - [Excluding fields](queries-computed-fields.md): Computed fields allow you to derive a new field based on existing data. A common example is when you want to compute ... - [Custom models](queries-excluding-fields.md): By default Prisma Client returns all fields from a model. You can use [`select`](/orm/prisma-client/queries/select-fi... - [Case sensitivity](queries-custom-models.md): As your application grows, you may find the need to group related logic together. We suggest either: - [Query optimization using Prisma Optimize](queries-case-sensitivity.md): Case sensitivity affects **filtering** and **sorting** of data, and is determined by your [database collation](#datab... - [Queries](queries-query-optimization-performance.md): This guide shows how to identify and optimize query performance, debug performance issues, and address common challen... - [TypedSQL](queries-index.md) - [Raw queries](using-raw-sql-typedsql.md): To start using TypedSQL in your Prisma project, follow these steps: - [SafeQL & Prisma Client](using-raw-sql-raw-queries.md): :::warning - [Write your own SQL](using-raw-sql-safeql.md): This page explains how to improve the experience of writing raw SQL in Prisma ORM. It uses [Prisma Client extensions]... - [Composite types](using-raw-sql-index.md): While the Prisma Client API aims to make all your database queries intuitive, type-safe, and convenient, there may st... - [Null and undefined](special-fields-and-types-composite-types.md): :::warning - [Working with Json fields](special-fields-and-types-null-and-undefined.md): :::warning - [Working with scalar lists](special-fields-and-types-working-with-json-fields.md): Use the [`Json`](/orm/reference/prisma-schema-reference#json) Prisma ORM field type to read, write, and perform basic... - [Working with compound IDs and unique constraints](special-fields-and-types-working-with-scalar-lists-arrays.md): [Scalar lists](/orm/reference/prisma-schema-reference#-modifier) are represented by the`[]`modifier and are only av... - [Fields & types](special-fields-and-types-working-with-composite-ids-and-constraints.md): Composite IDs and compound unique constraints can be defined in your Prisma schema using the [`@@id`](/orm/reference/... - [`model`: Add custom methods to your models](special-fields-and-types-index.md): This section covers various special fields and types you can use with Prisma Client. - [`client`: Add methods to Prisma Client](client-extensions-model.md): :::info - [`query`: Create custom Prisma Client queries](client-extensions-client.md): :::info - [`result`: Add custom fields and methods to query results](client-extensions-query.md): :::info - [Fine-Grained Authorization (Permit)](client-extensions-result.md): :::info - [Shared Prisma Client extensions](shared-extensions-permit-rbac.md): :::info Quick summary - [Type utilities](shared-extensions-index.md): You can share your [Prisma Client extensions](/orm/prisma-client/client-extensions) with other users, either as packa... - [Shared packages & examples](client-extensions-type-utilities.md): Several type utilities exist within Prisma Client that can assist in the creation of highly type-safe extensions. - [Extensions](client-extensions-extension-examples.md): The following is a list of extensions we've built at Prisma: - [Prisma validator](client-extensions-index.md): :::info - [Operating against partial structures of your model types](type-safety-prisma-validator.md): The [`Prisma.validator`](/orm/reference/prisma-client-reference#prismavalidator) is a utility function that takes a g... - [Type safety](type-safety-operating-against-partial-structures-of-model-types.md): When using Prisma Client, every model from your [Prisma schema](/orm/prisma-schema) is translated into a dedicated Ty... - [Unit testing](type-safety-index.md): The generated code for Prisma Client contains several helpful types and utilities that you can use to make your appli... - [Integration testing](testing-unit-testing.md): Unit testing aims to isolate a small portion (unit) of code and test it for logically predictable behaviors. It gener... - [Set the version of docker compose to use](testing-integration-testing.md): Integration tests focus on testing how separate parts of the program work together. In the context of applications us... - [Deploy Prisma ORM](testing-index.md): This section describes how to approach testing an application that uses Prisma Client. - [Deploy to Heroku](deployment-deploy-prisma.md): Projects using Prisma Client can be deployed to many different cloud platforms. Given the variety of cloud platforms ... - [Deploy to Render](traditional-deploy-to-heroku.md): In this guide, you will set up and deploy a Node.js server that uses Prisma ORM with PostgreSQL to [Heroku](https://w... - [Deploy to Koyeb](traditional-deploy-to-render.md): This guide explains how to deploy a Node.js server that uses Prisma ORM and PostgreSQL to Render. - [Deploy to Sevalla](traditional-deploy-to-koyeb.md): In this guide, you will set up and deploy a Node.js server that uses Prisma ORM with PostgreSQL to [Koyeb](https://ww... - [Deploy to Fly.io](traditional-deploy-to-sevalla.md): This guide explains how to deploy a Node.js server that uses Prisma ORM and PostgreSQL to [Sevalla](https://sevalla.c... - [Deploy to Railway](traditional-deploy-to-flyio.md): This guide explains how to deploy a Node.js server that uses Prisma ORM and PostgreSQL to Fly.io. - [Traditional servers](traditional-deploy-to-railway.md): This guide explains how to deploy an app that uses Prisma ORM and Prisma Postgres to [Railway](https://railway.com?ut... - [Deploy to Azure Functions](traditional-index.md): If your application is deployed via a Platform-as-a-Service (PaaS) provider, whether containerized or not, it is a tr... - [Deploy to Vercel](serverless-deploy-to-azure-functions.md): This guide explains how to avoid common issues when deploying a Node.js-based function app to Azure using [Azure Func... - [Deploy to AWS Lambda](serverless-deploy-to-vercel.md): This guide takes you through the steps to set up and deploy a serverless application that uses Prisma to [Vercel](htt... - [Deploy to Netlify](serverless-deploy-to-aws-lambda.md): :::info Quick summary - [Connect to DB](serverless-deploy-to-netlify.md): This guide covers the steps you will need to take in order to deploy your application that uses Prisma ORM to [Netlif... - [Deploying edge functions with Prisma ORM](serverless-index.md): If your application is deployed via a "Serverless Function" or "Function-as-a-Service (FaaS)" offering and uses a sta... - [Deploy to Cloudflare Workers & Pages](edge-overview.md): You can deploy an application that uses Prisma ORM to the edge. Depending on which edge function provider and which d... - [Deploy to Vercel Edge Functions & Middleware](edge-deploy-to-cloudflare.md): :::info Quick summary - [Deploy to Deno Deploy](edge-deploy-to-vercel.md): This page covers everything you need to know to deploy an app that uses Prisma Client for talking to a database in [V... - [Get API info](edge-deploy-to-deno-deploy.md): With this guide, you can learn how to build and deploy a REST API to [Deno Deploy](https://deno.com/deploy). The appl... - [Module bundlers](edge-index.md): If your application is deployed via an "Edge Function" offering or is deployed from a [serverless](/orm/prisma-client... - [Deploying database changes with Prisma Migrate](deployment-module-bundlers.md): _Module bundlers_ bundle JavaScript modules into a single JavaScript file. Most bundlers work by copying over the Jav... - [Deploy migrations from a local environment](deployment-deploy-database-changes-with-prisma-migrate.md): To apply pending migrations to staging, testing, or production environments, run the`migrate deploy`command as part... - [Caveats when deploying to AWS platforms](deployment-deploy-migrations-from-a-local-environment.md): There are two scenarios where you might consider deploying migrations directly from a local environment to a producti... - [Deploy to a different OS](deployment-caveats-when-deploying-to-aws-platforms.md): The following describes some caveats you might face when deploying to different AWS platforms. - [Deployment](deployment-deploy-to-a-different-os.md): Prisma Client depends on the [query engine](/orm/more/under-the-hood/engines) that is running as a binary on the same... - [Logging](deployment-index.md): This section describes how to deploy Node.js applications that use Prisma Client and TypeScript to various platforms. - [Metrics](observability-and-logging-logging.md): Use the`PrismaClient`[`log`](/orm/reference/prisma-client-reference#log) parameter to configure [log levels](/orm/r... - [HELP prisma_client_queries_total Total number of Prisma Client queries executed](observability-and-logging-metrics.md): Prisma Client metrics give you a detailed insight into how Prisma Client interacts with your database. You can use th... - [SQL comments](observability-and-logging-opentelemetry-tracing.md): Tracing provides a detailed log of the activity that Prisma Client carries out, at an operation level, including the ... - [Observability & logging](observability-and-logging-sql-comments.md): SQL comments allow you to append metadata to your database queries, making it easier to correlate queries with applic... - [Debugging](observability-and-logging-index.md): :::tip Get query insights and analytics with Prisma Optimize - [enable only `prisma:engine`-level debugging output](debugging-and-troubleshooting-debugging.md): You can enable debugging output in Prisma Client and Prisma CLI via the [`DEBUG`](/orm/reference/environment-variable... - [Troubleshooting binary size and deployment issues](debugging-and-troubleshooting-handling-exceptions-and-errors.md): In order to handle different types of errors you can use`instanceof`to check what the error is and handle it accord... - [Debugging & troubleshooting](debugging-and-troubleshooting-troubleshooting-binary-size-issues.md): If you encounter **large bundle sizes**, **slow builds**, or **deployment errors** related to Prisma’s Rust engine bi... - [Prisma Client](debugging-and-troubleshooting-index.md): :::tip Get query insights and analytics with Prisma Optimize - [Getting started with Prisma Migrate](prisma-client-index.md) - [Overview on Prisma Migrate](prisma-migrate-getting-started.md): This page explains how to get started with migrating your schema in a development environment using Prisma Migrate. - [Mental model](understanding-prisma-migrate-overview.md): :::info - [About migration histories](understanding-prisma-migrate-mental-model.md): This guide provides a conceptual overview of database migrations using Prisma Migrate when working with relational da... - [About the shadow database](understanding-prisma-migrate-migration-histories.md): This page explains how Prisma ORM uses migration histories to track changes to your schema. - [Limitations and known issues](understanding-prisma-migrate-shadow-database.md): The shadow database is a second, _temporary_ database that is **created and deleted automatically**\* each time you r... - [or](understanding-prisma-migrate-limitations-and-known-issues.md): The following limitations apply to Prisma Migrate. - [Understanding Prisma Migrate](understanding-prisma-migrate-legacy-migrate.md): **Important!** This page documents legacy Prisma Migrate (Experimental) available in version 2.12.0 and earlier. [Pri... - [Seeding](understanding-prisma-migrate-index.md) - [-e Exit immediately when a command returns a non-zero status.](workflows-seeding.md): This guide describes how to seed your database using Prisma Client and Prisma ORM's integrated seeding functionality.... - [Native database types](workflows-team-development.md): This guide has been moved to the [guides section](/guides/implementing-schema-changes). You can find the guide there. - [Native database functions](workflows-native-database-types.md): Prisma Migrate translates the model defined in your [Prisma schema](/orm/prisma-schema) into features in your database. - [Prototyping your schema](workflows-native-database-functions.md): In PostgreSQL, some [native database functions](/orm/prisma-schema/data-model/unsupported-database-features#native-da... - [Troubleshooting](workflows-prototyping-your-schema.md): The Prisma CLI has a dedicated command for prototyping schemas: [`db push`](/orm/reference/prisma-cli-reference#db-push) - [Baselining a database](workflows-troubleshooting.md): This guide describes how to resolve issues with Prisma Migrate in a development environment, which often involves res... - [Customizing migrations](workflows-baselining.md): Baselining is the process of initializing a migration history for a database that: - [Data migrations](workflows-customizing-migrations.md): :::warning - [Squashing migrations](workflows-data-migration.md): This guide has been moved to our new [guides section](/guides/data-migration). You can find the guide there. - [Generating down migrations](workflows-squashing-migrations.md): This guide describes how to squash multiple [migration files](/orm/prisma-migrate/understanding-prisma-migrate/migrat... - [Patching & hotfixing](workflows-generating-down-migrations.md): This guide describes how to generate a down migration SQL file that reverses a given [migration file](/orm/prisma-mig... - [Unsupported database features (Prisma Migrate)](workflows-patching-and-hotfixing.md): Patching or hotfixing a database involves making an often time critical change directly in production. For example, y... - [Development and production](workflows-unsupported-database-features.md): Prisma Migrate uses the Prisma schema to determine what features to create in the database. However, some database fe... - [Workflows](workflows-development-and-production.md): This page explains how to use Prisma Migrate commands in development and production environments. - [Prisma Migrate](workflows-index.md) - [Prisma CLI](prisma-migrate-index.md) - [Prisma Studio](tools-prisma-cli.md): The Prisma command line interface (CLI) is the primary way to interact with your Prisma project from the command line... - [❌ This will cause an error](tools-prisma-studio.md): Prisma Studio is a standalone visual database editor that lets you view and manipulate data directly in your browser.... - [Prisma Client API reference](tools-index.md) - [Prisma schema reference](reference-prisma-client-reference.md): :::tip Use Prisma ORM without Rust binaries - [Prisma CLI reference](reference-prisma-schema-reference.md): Defines a [data source](/orm/prisma-schema/overview/data-sources) in the Prisma schema. - [Environment variables declared in this file are automatically made available to Prisma.](reference-prisma-cli-reference.md): This document describes the Prisma CLI commands, arguments, and options. - [Environment variables reference](reference-error-reference.md): For more information about how to work with exceptions and error codes, see [Handling exceptions and errors](/orm/pri... - [enable only `prisma:client`-level debugging output](reference-environment-variables-reference.md): This document describes different environment variables and their use cases. - [`migrations` and `schema.prisma` are on the same level](reference-prisma-config-reference.md): The Prisma Config file configures the Prisma CLI, including subcommands like`migrate`and`studio`, using TypeScript. - [Supported databases](reference-database-features.md): This page gives an overview of the features which are provided by the databases that Prisma ORM supports. Additionall... - [Connection URLs](reference-supported-databases.md): Prisma ORM currently supports the following databases. - [System requirements](reference-connection-urls.md): Prisma ORM needs a connection URL to be able to connect to your database, e.g. when sending queries with [Prisma Clie... - [Prisma Client & Prisma schema](reference-system-requirements.md): This page provides an overview of the system requirements for Prisma ORM. - [Prisma CLI Preview features](preview-features-client-preview-features.md): When we release a new Prisma Client or Prisma schema feature, it often starts in Preview so that you can test it and ... - [Preview features](preview-features-cli-preview-features.md): When we release a new Prisma CLI feature, it often starts in Preview so that you can test it and submit your feedback... - [Reference](preview-features-index.md): Some Prisma ORM features are released as [Previews](/orm/more/releases#preview). [Share your feedback on all Preview ... - [Engines](reference-index.md): The reference section of the documentation is a collection of reference pages that describe the Prisma ORM APIs and d... - [Under the hood](under-the-hood-engines.md): :::warning[Prisma ORM v7 is Rust binary-free by default] - [Upgrade to Prisma ORM 7](under-the-hood-index.md): This page gives an overview of the Prisma ORM internals and how it works "under the hood". - [Using --schema](upgrading-versions-upgrading-to-prisma-7.md): Prisma ORM v7 introduces **breaking changes** when you upgrade from an earlier Prisma ORM version. This guide explain... - [rejectOnNotFound changes](upgrading-versions-upgrading-to-prisma-6.md): Prisma ORM v6 introduces a number of **breaking changes** when you upgrade from an earlier Prisma ORM version. This g... - [jsonProtocol changes](upgrading-to-prisma-5-rejectonnotfound-changes.md): As of Prisma ORM version 5.0.0, the deprecated parameter`rejectOnNotFound`has been removed. Depending on if your pr... - [Upgrade to Prisma ORM 5](upgrading-to-prisma-5-jsonprotocol-changes.md): As of Prisma ORM version 5.0.0, the new`jsonProtocol`is the default. There are some changes that directly result fr... - [Upgrade to Prisma ORM 4](upgrading-to-prisma-5-index.md): Prisma ORM 5.0.0 introduces a number of changes, including the usage of our new JSON Protocol, [which make Prisma Cli... - [Named constraints upgrade path](upgrading-versions-upgrading-to-prisma-4.md): Prisma ORM 4 introduces a number of **breaking changes** when you upgrade from an earlier Prisma ORM version. This gu... - [Referential actions upgrade path](upgrading-to-prisma-3-named-constraints.md): After upgrading to Prisma ORM 3, the default naming convention for constraint and index names will change and your pr... - [Upgrade to Prisma ORM 3](upgrading-to-prisma-3-referential-actions.md): Prisma ORM version 2.x prevents deletion of connected records in some Prisma Client functions, and does not let you c... - [Codemods](upgrading-to-prisma-3-index.md): Prisma ORM 3 introduces a number of **breaking changes** if you are upgrading from an earlier version (any 2.x versio... - [Upgrading versions](upgrading-versions-codemods.md): :::info Quick summary - [Upgrading to use Preview features](upgrading-versions-index.md): To upgrade to the latest version of Prisma ORM: - [How to upgrade](upgrade-guides-upgrading-to-use-preview-features.md): Preview features are new features that can only be used by opting in using a corresponding feature flag. - [Schema incompatibilities in MySQL](upgrade-from-prisma-1-how-to-upgrade.md): This page helps you make an informed decision on when and how to upgrade from Prisma 1 to Prisma ORM version 2._x_ an... - [Schema incompatibilities in PostgreSQL](upgrade-from-prisma-1-schema-incompatibilities-mysql.md): Each section on this page describes a potential problem when upgrading from Prisma 1 to Prisma ORM 2._x_ and later an... - [Upgrading the Prisma ORM layer (MySQL)](upgrade-from-prisma-1-schema-incompatibilities-postgresql.md): :::info Quick summary - [remove global installation](upgrade-from-prisma-1-upgrading-the-prisma-layer-mysql.md): This page explains the first step of your upgrade process: Taking your Prisma 1 configuration and upgrading it to Pri... - [remove global installation](upgrade-from-prisma-1-upgrading-the-prisma-layer-postgresql.md): This page explains the first step of your upgrade process: Taking your Prisma 1 configuration and upgrading it to Pri... - [prisma-binding to Nexus](upgrade-from-prisma-1-upgrading-nexus-prisma-to-nexus.md): :::info - [import Post from './generated/prisma.graphql'](upgrade-from-prisma-1-upgrading-prisma-binding-to-nexus.md): :::info - [import Post from './generated/prisma.graphql'](upgrade-from-prisma-1-upgrading-prisma-binding-to-sdl-first.md): This upgrade guide describes how to migrate a Node.js project that's based on [Prisma 1](https://github.com/prisma/pr... - [Upgrade from MongoDB Beta](upgrade-from-prisma-1-upgrading-a-rest-api.md): This upgrade guide describes how to migrate a Node.js project that's based on [Prisma 1](https://github.com/prisma/pr... - [Upgrade from Prisma 1](upgrade-from-prisma-1-upgrade-from-mongodb-beta.md): This guide helps you migrate from the Prisma 1 MongoDB Beta to MongoDB on Prisma ORM 2 or later. To learn more about ... - [Upgrade guides](upgrade-from-prisma-1-index.md) - [Cursor](upgrade-guides-index.md) - [Tabnine](ai-tools-cursor.md): [Cursor](https://www.cursor.com/) is an AI-powered code editor designed to boost productivity by automating repetitiv... - [Windsurf](ai-tools-tabnine.md): [Tabnine](https://www.tabnine.com/) is a an AI software development platform that comes as an [extension](https://www... - [GitHub Copilot](ai-tools-windsurf.md): [Windsurf Editor](https://windsurf.com/editor/) is an AI-powered code editor designed to boost productivity by automa... - [GitHub Copilot Instructions for Prisma Workspace](ai-tools-github-copilot.md): GitHub Copilot is an AI coding assistant that speeds up your Prisma ORM workflows, so you spend less time on boilerpl... - [AI tools](ai-tools-chatgpt.md): [ChatGPT](https://openai.com/chatgpt) is a large language model-based chatbot developed by OpenAI. You can extend its... - [TypeORM](ai-tools-index.md): Scaffold a new Prisma project with a new database using the`prisma init --prompt`command: - [Sequelize](comparisons-prisma-and-typeorm.md): This page compares Prisma ORM and [TypeORM](https://typeorm.io/). If you want to learn how to migrate from TypeORM to... - [Mongoose](comparisons-prisma-and-sequelize.md): This page compares the Prisma ORM and [Sequelize](https://sequelize.org/docs/v6/) APIs. - [Drizzle](comparisons-prisma-and-mongoose.md): This page compares the Prisma ORM and [Mongoose](https://mongoosejs.com/docs/guide.html) APIs. If you want to learn h... - [Comparing Prisma ORM](comparisons-prisma-and-drizzle.md): Prisma and Drizzle take different approaches to working with databases. While Drizzle appeals to developers who prefe... - [Managing Prisma ORM environment variables and settings](comparisons-index.md): Find out how Prisma ORM compares to ORMs and ODMs in the Node.js and TypeScript ecosystem. - [environment variable already set in the environment of the system](development-environment-environment-variables.md): An environment variable is a key value pair of string data that is stored on your machine's local environment. Refer ... - [Development environment](development-environment-editor-setup.md): This page describes how you can configure your editor for an optimal developer experience when using Prisma ORM. - [Setting up a local PostgreSQL database](development-environment-index.md): This section describes using`env`variables, editors, and workspaces in your development environment. - [An introduction to PostgreSQL data types](dataguide-setting-up-a-local-postgresql-database.md): This page explains how to install and configure a [PostgreSQL database server](https://www.postgresql.org/docs/curren... - [Working with dates in PostgreSQL](dataguide-introduction-to-data-types.md): One of the primary features of relational databases in general is the ability to define [schemas](/orm/more/help-and-... - [Connecting to PostgreSQL databases](dataguide-date-types.md): The ability to store date values inside of your database allows you to add a time element to your queries and analysi... - [Introduction to PostgreSQL connection URIs](dataguide-connecting-to-postgresql-databases.md): One of the first things you'll need to think about when working with a [PostgreSQL](/orm/more/help-and-troubleshootin... - [Glossary of common database terminology](dataguide-connection-uris.md): Connecting to your database server is usually one of the first tasks you need to accomplish when designing and config... - [Dataguide](dataguide-database-glossary.md): When dealing with databases, there is a lot of terminology that you must learn in order to understand the technology,... - [Autocompletion in GraphQL resolvers with JavaScript](dataguide-index.md): Learn how databases work, how to choose the right one, and how to use databases with your applications to their full ... - [Modeling and querying many-to-many relations](help-and-troubleshooting-autocompletion-in-graphql-resolvers-with-js.md): When using GraphQL with TypeScript, you always get autocompletion for the Prisma Client instance in your GraphQL reso... - [Converting Implicit many-to-many relation to Explicit many-to-many relation](help-and-troubleshooting-working-with-many-to-many-relations.md): Modeling and querying many-to-many relations in relational databases can be challenging. This article shows two examp... - [Comprehensive Guide to Using Prisma ORM with Next.js](help-and-troubleshooting-implicit-to-explicit-conversion.md): Many-to-many relationships are an important aspect of relational databases, allowing multiple records in one table to... - [Solve package error with vercel/pkg](help-and-troubleshooting-nextjs-help.md): Prisma ORM and Next.js form a powerful combination for building modern, server-side rendered, and API-driven web appl... - [Compare columns of the same table with raw queries](help-and-troubleshooting-pkg-issue.md): If you use [vercel/pkg](https://github.com/vercel/pkg) to package your Node.js project, then you might encounter an`... - [Vercel build dependency caching workaround](help-and-troubleshooting-comparing-columns-through-raw-queries.md): Comparing different columns from the same table is a common scenario that developers encounter. Some examples include... - [Netlify build dependency caching workaround](help-and-troubleshooting-vercel-caching-issue.md): If you deploy an application using Prisma ORM to [Vercel](https://vercel.com/), you may run into the following error ... - [Data validation with CHECK constraints (PostgreSQL)](help-and-troubleshooting-netlify-caching-issue.md): If you deploy an application using Prisma ORM to [Netlify](https://www.netlify.com/), you may run into the following ... - [Using the Nuxt Prisma Module](help-and-troubleshooting-check-constraints.md): This page explains how to configure [check constraints](https://www.postgresql.org/docs/9.4/ddl-constraints.html#DDL-... - [Optimizing TypeScript performance with large Prisma schemas](help-and-troubleshooting-prisma-nuxt-module.md): :::warning - [Optimizing TypeScript performance with large Prisma schemas](help-and-troubleshooting-typescript-performance-optimization.md): When working with large database schemas in Prisma applications, a simple change in the type definition strategy can ... - [ORM releases and maturity levels](help-and-troubleshooting-index.md): This section provides a number of common problems that developers might encounter when using Prisma ORM and provides ... - [More resources for Prisma ORM](more-releases.md): This page explains the release process of Prisma ORM, how it's versioned and how to deal with breaking changes that m... - [ORM](more-index.md) - [npx create-db](orm-index.md): [Prisma ORM](https://github.com/prisma/prisma) is a Node.js and TypeScript ORM with an intuitive data model, automate... - [Import data from an existing PostgreSQL database](introduction-npx-create-db.md): [`create-db`](https://create-db.prisma.io/) is an open-source CLI tool that provisions temporary [Prisma Postgres](/p... - [Management API](introduction-import-from-existing-database.md): If you have an existing database and want to import your data into Prisma Postgres, you can use one of our guides: - [Management API SDK](introduction-management-api.md): This page covers the Prisma Management API which enables you to programmatically manage [platform](/platform/about) r... - [Overview on Prisma Postgres](introduction-management-api-sdk.md): The [`@prisma/management-api-sdk`](https://www.npmjs.com/package/@prisma/management-api-sdk) is a TypeScript SDK for ... - [Introduction to Prisma Postgres](introduction-overview.md): [Prisma Postgres](https://www.prisma.io/postgres?utm_source=docs) is a managed PostgreSQL database service that easil... - [Prisma Postgres FAQ](introduction-index-2.md): Get familiar with Prisma Postgres and its core concepts. This section covers what Prisma Postgres is and how to begin... - [Troubleshooting Prisma Postgres issues](more-faq.md): Common questions about how Prisma Postgres works, how queries are billed, and how it integrates with the Prisma ORM. - [More resources for Prisma Postgres](more-troubleshooting.md): This guide helps resolve common issues when working with Prisma Postgres. - [Caching queries in Prisma Postgres](more-index-2.md): Explore additional topics related to Prisma Postgres, including known limitations, troubleshooting guides, and freque... - [Connection pooling](database-caching.md): Prisma Postgres supports built-in query caching to reduce database load and improve query performance. You can config... - [Backups](database-connection-pooling.md): Prisma Postgres provides built-in [connection pooling](https://www.prisma.io/dataguide/database-tools/connection-pool... - [Download from the official PostgreSQL website:](database-backups.md): On [Pro and Business plans](https://www.prisma.io/pricing), Prisma Postgres automatically creates snapshots of your d... - [Local development with Prisma Postgres](database-postgres-extensions.md): Prisma Postgres supports [PostgreSQL extensions](https://www.postgresql.org/docs/current/sql-createextension.html), s... - [Direct connections](database-local-development.md): [Prisma Postgres](/postgres) is a production-grade, cloud-native database and is ideal for staging and production env... - [Embed Studio](database-direct-connections.md): Prisma Postgres is the perfect choice for your applications, whether you connect to it via [Prisma ORM](/orm) or any ... - [For SQLite support](prisma-studio-embedding-studio.md): Prisma Studio can be embedded in your own application via the [`@prisma/studio-core`](https://www.npmjs.com/package/@... - [Prisma Studio](prisma-studio-studio-in-vs-code.md): You can use Prisma Studio directly in VS Code via the [Prisma VS Code extension](https://marketplace.visualstudio.com... - [Serverless driver](prisma-studio-index.md): Prisma Postgres comes with Prisma Studio built-in. You can use it in several ways: - [Error reference](database-serverless-driver.md): The Prisma Postgres serverless driver ([`@prisma/ppg`](https://www.npmjs.com/package/@prisma/ppg)) is a lightweight c... - [API reference](api-reference-error-reference.md): When working with Prisma Postgres, you may encounter errors often highlighted by specific error codes during developm... - [Netlify](database-index.md): Learn how Prisma Postgres implements foundational database features such as built-in caching, connection pooling, bac... - [Vercel](integrations-netlify.md): The [Netlify extension for Prisma Postgres](https://www.netlify.com/integrations/prisma) connects your Netlify sites ... - [Firebase Studio](integrations-vercel.md): The [Vercel Marketplace integration for Prisma Postgres](https://www.vercel.com/marketplace/prisma) connects your Ver... - [MCP server](integrations-idx.md): If you want to explore Prisma Postgres without leaving your browser, you can try it out the via Google's [Firebase St... - [Run the async main function](integrations-mcp-server.md): The [Model-Context-Protocol](https://modelcontextprotocol.io/introduction) (MCP) gives LLMs a way to call APIs and th... - [Fly.io](integrations-viewing-data.md): You can view and edit your data in Prisma Postgres using either [Prisma Studio](/orm/tools/prisma-studio) or 3rd part... - [❌ Wrong order or path](integrations-flyio.md): [Fly.io](https://fly.io/) is a cloud application platform that lets you deploy full-stack applications globally. This... - [Tools & Integrations](integrations-raycast.md): [Raycast](https://www.raycast.com/) is a blazingly fast, extendable launcher for macOS that lets you control your too... - [Setup](integrations-index.md): Learn how Prisma Postgres works with popular 3rd-party platforms such as Vercel, Netlify, and Firebase Studio. - [Recordings](query-optimization-setup.md): Before you begin with Prisma Optimize for Prisma Postgres, ensure you have the following: - [Excessive number of rows returned](query-optimization-recordings.md): The recordings feature helps developers debug and isolate sets of queries into distinct sessions, known as recordings... - [Using CURRENT_TIME](recommendations-excessive-number-of-rows-returned.md): Optimize provides recommendations to help you identify and resolve performance issues caused by excessive number of r... - [Unnecessary indexes](recommendations-current-time.md): The following raw SQL query uses the`CURRENT_TIME`function: - [Long-running transactions](recommendations-unnecessary-indexes.md): Optimize detects unnecessary indexes and recommends removing them to improve database performance. - [Indexing on unique columns](recommendations-long-running-transactions.md): Optimize provides actionable recommendations to help you identify and resolve performance issues caused by **long-run... - [Storing large objects or BLOBs in the database](recommendations-indexing-on-unique-columns.md): Optimize identifies redundant indexing on unique columns and provides recommendations for better database performance. - [Queries on unindexed columns](recommendations-storing-blob-in-database.md): Optimize provides recommendations to help identify and resolve performance issues caused by storing large objects in ... - [Full table scans caused by LIKE operations](recommendations-queries-on-unindexed-columns.md): Optimize provides recommendations to help you identify and resolve performance issues caused by missing database inde... - [Repeated query](recommendations-full-table-scans-caused-by-like-operations.md): Optimize provides recommendations to help you identify and resolve performance issues caused by full table scans from... - [Overfetching](recommendations-repeated-query.md): Optimize provides recommendations to help you identify and resolve performance issues caused by repeated queries. - [Using @db.Money](recommendations-select-returning.md): Optimize provides recommendations to help you identify and resolve performance issues caused by over-fetched data. - [Using @db.Char(n)](recommendations-avoid-db-money.md): Optimize provides recommendations to help you identify and resolve performance issues caused by the use of`@db.Money... - [Using @db.VarChar(n)](recommendations-avoid-char.md): Optimize provides recommendations to help you identify and resolve performance issues caused by the use of`@db.Char(... - [Using timestamp(0) or timestamptz(0)](recommendations-avoid-varchar.md): Optimize provides recommendations to help you identify and resolve performance issues caused by the use of`@db.VarCh... - [Recommendations](recommendations-avoid-timestamp-timestampz-0.md): Optimize provides recommendations to help you identify and resolve performance issues caused by the use of`@db.Times... - [Query optimization with Prisma AI](recommendations-index.md): Optimize provides recommendations focused on performance improvements such as indexing issues, excessive data retriev... - [Performance metrics](query-optimization-prisma-ai.md): Prisma AI enables you to ask follow-up questions on a provided [recommendation](/postgres/query-optimization/recommen... - [Query optimization for Prisma Postgres](query-optimization-performance-metrics.md): An Optimize recording session provides detailed insights into the latencies of executed queries, capturing key metric... - [Quickstart with Prisma ORM](query-optimization-index.md): Understand how Prisma Postgres helps you optimize query performance using the Prisma Optimize toolkit. This section c... - [Import data from an existing PostgreSQL database](getting-started-quickstart-2.md): import { Redirect } from '@docusaurus/router'; - [Getting started](getting-started-import-from-existing-database.md): import { Redirect } from '@docusaurus/router'; - [Prisma Postgres](getting-started-index-3.md): To **bootstrap a new Prisma ORM project with a Prisma Postgres database**, run the following command in your terminal: - [Getting started with Prisma Accelerate](postgres-index.md): :::info[note] - [New Accelerate connection string with generated API_KEY](accelerate-getting-started.md): To get started with Accelerate, you will need the following: - [Caching queries in Prisma Accelerate](accelerate-connection-pooling.md): Accelerate provides built-in connection pooling to efficiently manage database connections. It's included as part of ... - [Static IP](accelerate-caching.md): Prisma Accelerate provides global caching for read queries using TTL, Stale-While-Revalidate (SWR), or a combination ... - [API Reference](accelerate-static-ip.md): You can enable static IP for Accelerate when your security setup requires IP allowlisting or if you're implementing f... - [Known limitations about Prisma Accelerate](accelerate-api-reference.md): The Accelerate API reference documentation is based on the following schema: - [Evaluating](accelerate-known-limitations.md): Below are descriptions of known limitations when using Accelerate. If you encounter any additional ones, please share... - [Local development for Prisma Accelerate](accelerate-evaluating.md): Prisma Accelerate optimizes database interactions through advanced connection pooling and global edge caching. Its co... - [Accelerate FAQ](accelerate-local-development.md): Prisma Accelerate efficiently scales production traffic with integrated connection pooling and a global database cache. - [Troubleshooting Prisma Accelerate issues](accelerate-faq.md): Enable static IP for Accelerate when your security setup requires IP allowlisting or if you're implementing firewalls... - [Feedback](accelerate-troubleshoot.md): When working with Prisma Accelerate, you may encounter errors often highlighted by specific error codes during develo... - [Prisma Accelerate examples](accelerate-feedback.md): You can submit any feedback about Accelerate in our [Discord server](https://pris.ly/discord?utm_source=docs&utm_medi... - [Compare Accelerate](accelerate-examples.md): Here is a list of ready-to-run example projects that demonstrate how to use Prisma Accelerate: - [General](accelerate-compare.md): Prisma Accelerate supports products that serve a global audience, with a global caching system and connection pool th... - [Maturity levels](platform-about.md): The [Console](https://console.prisma.io/login) enables you to manage and configure your projects that use Prisma Data... - [Support](platform-maturity-levels.md): Prisma releases updates to Prisma Data Platform multiple times per week, as opposed to the Prisma ORM that we release... - [About the Platform CLI](platform-support.md): Your feedback is invaluable, and we encourage you to share your experiences with us on [Discord](https://pris.ly/disc... - [Commands](platform-cli-about.md): This guide demonstrates how to access the Prisma Data Platform using the [Prisma CLI](/orm/tools/prisma-cli). Get sta... - [Platform CLI](platform-cli-commands.md): This document describes the Prisma Data Platform's integrated Prisma CLI commands, arguments, and options. - [Platform](platform-cli-index.md) - [Writing style](platform-index.md): Learn about the main concepts and workflows of the [Prisma Data Platform](https://console.prisma.io/login). - [Word choice](style-guide-writing-style.md): We assume that our audience has basic software development knowledge. Our audience know how to use their tools, such ... - [Spelling, punctuation, and formatting](style-guide-word-choice.md): Avoid words like "easy", "just", "simple", and "basic". If users have a hard time completing the task that is suppose... - [Docs example data model](style-guide-spelling-punctuation-formatting.md): In keeping with our conversational style, some contractions are OK: - [Prisma product and component names](style-guide-schema-models.md): `User`and`Post`are the canonical models that we use in our examples throughout the Prisma docs. - [Prisma docs image guidelines](style-guide-prisma-product-names.md): - The Prisma Data Platform (or just "PDP" - no definite article - after the first mention) - [User interface (GUI) guidelines](style-guide-image-guidelines.md): You can take screenshots with your favorite tool. We find it very easy to use SnagIt when you need to edit screenshot... - [Boilerplate content](style-guide-user-interace-guidelines.md): To document a complete task (such as _Create a new project_), use numbered lists to organize separate steps into a se... - [Prisma docs style guide](style-guide-boilerplate-content.md): You can use the following phrases and blocks of content as templates when you work on the docs. - [MDX components](style-guide-index.md): This guide contains guidelines for contributors to the Prisma docs. Its goal is to ensure consistency throughout the ... - [Front matter](docs-components-mdx-examples.md): This page describes how to use the custom [MDX](https://mdxjs.com/) components (e.g. code blocks) in the Prisma docs. - [Prisma docs components](docs-components-frontmatter.md): Front matter that informs the meta information of a page. - [Writing template](docs-components-index.md) - [About](about-template.md): A short introduction that encourages visitors to read on. - [Getting Started](about-index.md): This section of our docs is about... the docs! - [Recordings in Prisma Optimize](optimize-getting-started.md): Before you begin with Prisma Optimize, ensure you have the following: - [Recommendations](optimize-recordings.md): The recordings feature helps developers debug and isolate sets of queries into distinct sessions, known as recordings... - [Prisma AI](optimize-recommendations.md): Optimize provides recommendations focused on performance improvements such as indexing issues, excessive data retriev... - [Performance metrics](optimize-prisma-ai.md): Prisma AI enables you to ask follow-up questions on a provided [recommendation](/postgres/query-optimization/recommen... - [FAQ](optimize-performance-metrics.md): An Optimize recording session provides detailed insights into the latencies of executed queries, capturing key metric... - [Known limitations about Prisma Optimize](optimize-faq.md): To learn more about frequently asked questions around Prisma Optimize and query recommendations, [visit this page](/p... - [Migrate data using the expand and contract pattern](optimize-known-limitations.md): Below are the known limitations when using Prisma Optimize. If you are aware of any limitations that are missing, ple... - [How to manage schema changes in a team](guides-data-migration.md): When making changes to your database schema in production, it's crucial to ensure data consistency and avoid downtime... - [How to migrate from TypeORM to Prisma ORM](guides-implementing-schema-changes.md): When working in a team, managing database schema changes can be challenging. This guide shows you how to effectively ... - [How to migrate from Sequelize to Prisma ORM](guides-migrate-from-typeorm.md): This guide shows you how to migrate your application from TypeORM to Prisma ORM. We'll use an extended version of the... - [How to migrate from Mongoose to Prisma ORM](guides-migrate-from-sequelize.md): This guide shows you how to migrate your application from Sequelize to Prisma ORM. We'll use an extended version of t... - [How to migrate from Drizzle to Prisma ORM](guides-migrate-from-mongoose.md): This guide shows you how to migrate your application from Mongoose to Prisma ORM. We'll use a [sample project](https:... - [How to use Prisma ORM with Cloudflare D1](guides-migrate-from-drizzle.md): This guide shows you how to migrate your application from Drizzle to Prisma ORM. We'll use a sample project based off... - [Apply to local database](guides-cloudflare-d1.md): This guide shows you how to use Prisma ORM with Cloudflare D1, a serverless SQL database that runs on Cloudflare's ed... - [How to use Prisma ORM and Prisma Postgres with Next.js](guides-turborepo.md): Prisma is a powerful ORM for managing databases, and [Turborepo](https://turbo.build/) simplifies monorepo workflows.... - [How to use Prisma ORM and Prisma Postgres with Nuxt](guides-nextjs.md): - How to set up Prisma with Next.js? - [How to use Prisma in Docker](guides-nuxt.md): This guide shows you how to set up Prisma ORM in a Nuxt application with [Prisma Postgres](https://prisma.io/postgres). - [How to use Prisma ORM and Prisma Postgres in a pnpm workspaces monorepo](guides-docker.md): - How to run Prisma in Docker containers? - [How to use Prisma ORM with multiple databases in a single app](guides-use-prisma-in-pnpm-workspaces.md): Prisma is a powerful ORM for managing your database, and when combined with [pnpm Workspaces](https://pnpm.io/workspa... - [How to use Prisma ORM with TanStack Start](guides-multiple-databases.md): This guide shows you how to use multiple databases using Prisma ORM in a single [Next.js app](https://nextjs.org/). Y... - [Database URL for PostgreSQL](guides-tanstack-start.md): Prisma ORM simplifies database interactions, and [TanStack Start](https://tanstack.com/start/latest/docs/framework/re... - [How to use Prisma ORM and Prisma Postgres with SolidStart](guides-react-router-7.md): This guide shows you how to use Prisma ORM with [React Router 7](https://reactrouter.com/), a multi-strategy router t... - [How to set up Datadog tracing with Prisma ORM and Prisma Postgres](guides-solid-start.md): Prisma ORM streamlines database access with type-safe queries and a smooth developer experience. SolidStart, a modern... - [Placeholder url you have to replace](guides-data-dog.md): In this guide, you'll learn how to set up Datadog tracing for a new Prisma project. By combining the`@prisma/instrum... - [How to use Prisma ORM and Prisma Postgres with Clerk Auth and Next.js](guides-sveltekit.md): Prisma ORM simplifies database access with type-safe queries, and when paired with [SvelteKit](https://svelte.dev/doc... - [Clerk](guides-clerk-nextjs.md): [Clerk](https://clerk.com/) is a drop-in auth provider that handles sign-up, sign-in, user management, and webhooks s... - [How to use Prisma ORM and Prisma Postgres with Astro](guides-shopify.md): [Shopify](https://www.shopify.com/) is a popular platform for building e-commerce stores. This guide will show you ho... - [How to use Prisma ORM and Prisma Postgres with Better Auth and Next.js](guides-astro.md): - How to integrate Prisma with Astro? - [Better Auth](guides-betterauth-nextjs.md): [Better Auth](https://better-auth.com/) is a modern, open-source authentication solution for web applications. It's b... - [Set up Supabase with Accelerate Connection Pool](guides-management-api.md): This guide walks you through how to use the Prisma Postgres Management API, to power experiences like the [`npx creat... - [Set up Neon with Accelerate Connection Pool](guides-supabase-accelerate.md): This guides teaches you how to add connection pooling to a PostgreSQL database hosted on [Supabase](https://supabase.... - [How to use Prisma ORM with Permit.io](guides-neon-accelerate.md): This guides teaches you how to add connection pooling to a PostgreSQL database hosted on [Neon](https://neon.tech/) u... - [How to provision preview databases with GitHub Actions and Prisma Postgres](guides-permit-io-access-control.md): [Permit.io](https://www.permit.io/) is an authorization-as-a-service platform that lets you implement fine-grained ac... - [Prevent concurrent runs of the same PR](guides-github-actions.md): This guide shows you how to automatically create and delete [Prisma Postgres](https://www.prisma.io/postgres) databas... - [How to use AI SDK with Prisma ORM, Prisma Postgres, and Next.js for chat applications](guides-management-api-basic.md): This guide walks you through setting up a basic TypeScript project that uses the [Prisma Postgres Management API](/po... - [How to use Prisma ORM and Prisma Postgres with Auth.js and Next.js](guides-ai-sdk-nextjs.md): Prisma ORM streamlines database access with type-safe queries, and when paired with [Next.js](https://nextjs.org/) an... - [How to embed Prisma Studio in a Next.js app](guides-authjs-nextjs.md): [Auth.js](https://authjs.dev/) is a flexible, open-source authentication library designed to simplify adding authenti... - [How to use Prisma ORM and Prisma Postgres with Bun](guides-embed-studio-nextjs.md): Prisma Studio can be embedded directly into your Next.js application using the [`@prisma/studio-core`](https://www.np... - [Instant app deployment with Vercel and Prisma Postgres](guides-bun.md): [Bun](https://bun.sh) is a fast JavaScript runtime that includes a bundler, test runner, and package manager. In this... - [How to use Prisma ORM and Prisma Postgres with Hono](guides-vercel-app-deployment.md): This guide shows you how to implement instant app deployment using [Vercel](https://vercel.com)'s API with integrated... - [How to use Prisma ORM and Prisma Postgres with Better Auth and Astro](guides-hono.md): Prisma ORM offers type-safe database access, and [Hono](https://hono.dev/) is built for fast, lightweight web apps. T... - [Better Auth](guides-betterauth-astro.md): [Better Auth](https://better-auth.com/) is a modern, open-source authentication solution for web apps. It's built wit... - [How to use Prisma ORM and Prisma Postgres with Cloudflare Workers](guides-deno-integration.md): [Deno Deploy](https://deno.com/deploy) includes a feature that allows you to provision a Prisma Postgres database dir... - [How to use Prisma ORM and Prisma Postgres with Clerk Auth and Astro](guides-cloudflare-workers.md): Prisma ORM provides type-safe database access, and [Cloudflare Workers](https://workers.cloudflare.com/) enables you ... - [Prisma](guides-clerk-astro.md): [Clerk](https://clerk.com/) is a drop-in auth provider that handles sign-up, sign-in, user management, and webhooks s... - [How to use Prisma ORM and Prisma Postgres with Elysia](guides-nestjs.md): This guide shows you how to use Prisma ORM with [NestJS](https://nestjs.com/), a progressive Node.js framework for bu... - [Health check](guides-elysia.md): [Elysia](https://elysiajs.com/) is an ergonomic web framework for building high-performance backend servers with Bun.... - [How to write guides for Prisma ORM](guides-management-api-api-clients.md): Postman is a popular API client with testing, collaboration, and automation features for working with REST APIs. - [Guides](guides-making-guides.md): This guide shows you how to write guides for Prisma ORM documentation. It covers the required structure, formatting, ... - [Build faster with Prisma + AI](guides-index.md): Welcome to the Guides section! Here you'll find practical, step-by-step guides to help you accomplish specific tasks ... - [Set up Astro + Prisma + Prisma Postgres](ai-index.md): import { - [Specify the following for Cursor rules](prompts-astro.md): Include this prompt in your AI assistant to guide consistent code generation for Astro + Prisma + Prisma Postgres pro... - [Specify the following for Cursor rules](prompts-nextjs.md): Before using this prompt, you need to create a new Next.js project: - [Specify the following for Cursor rules](prompts-prisma-7.md): Include this prompt in your AI assistant to guide in upgrading to Prisma ORM 7.0. - [Specify the following for Cursor rules](prompts-turborepo.md): Include this prompt in your AI assistant to guide consistent code generation for Turborepo + Prisma + Prisma Postgres... - [Build a Tweet SaaS with Next.js, Prisma Postgres, and Ollama](tutorials-linktree-clone.md): In this comprehensive vibe coding tutorial, you'll build a complete **Linktree clone SaaS** application from scratch ... - [Save a tweet](tutorials-typefully-clone.md): In this comprehensive vibe coding tutorial, you'll build **TweetSmith**, a tweet polishing application that transform...