Skip to main content

Prisma Documentation Docs

Guides

Every guide in Prisma Documentation Docs.

Introduction

Prisma AccelerateGetting started

Migrating off Accelerate

Migrate to Prisma PostgresConnect to Prisma Postgres without AccelerateKeep your existing database

Features

Connection PoolingCaching queriesLocal developmentStatic IPExamplesEvaluatingCompare Accelerate

Reference

API Reference

More

Known limitationsTroubleshootingFAQFeedback

Start

Choose a Prisma ORM setup pathDeploy the full Prisma stackDeploy your first app

Prisma ORM

Introduction to Prisma ORMRelease statusSupported databasescreate-prismaFrom scratch

Prisma Postgres

Import from MySQLFrom the CLI

Upgrade Prisma ORM

Prisma ORM 7 to 8 (PostgreSQL)Prisma ORM 6 to 8 (MongoDB)

Introduction

Prisma ORMCore conceptsComing from Prisma ORM 7Prisma Postgrescreate-dbBest Postgres for AI apps

Data Modeling

OverviewRelational data modelingMongoDB data modeling

Contract Authoring

The data contractAuthor in PSLEditor supportAuthor in TypeScriptcontract.json and contract.d.tsSupported database features

Fundamentals

Reading dataWriting dataRelations and joinsTransactionsAdvanced queries

Migrations

How migrations workThe migration graphGenerating a migrationEditing a migrationApplying a migrationRollbacks and recovery

Middleware

How middleware worksBuilt-in: budgetsBuilt-in: lintsBuilt-in: cacheAuthoring custom middleware

Extensions

ExtensionsUsing extensions

Reference

Prisma ORM API referenceORM client referenceSQL query builder referencePipeline builder referenceRaw queries referenceTransactions and runtime referenceMigration APIError reference

Database

DatabaseConnecting to your databaseConnection poolingQuery InsightsBackupsExtensionsServerless driver

Tools & Integrations

RaycastMCPStudioVSCode

Infrastructure as Code

TerraformPulumi

More

Error referenceTroubleshootingPrisma Postgres FAQMigrate from EA to GA

Getting Started

Prisma 7 setup paths

Prisma ORM

Prisma PostgresSQLitePostgreSQLMySQLSQL ServerPlanetScaleCockroachDBMongoDBPostgreSQLMongoDBPrisma PostgresSQLitePostgreSQLMySQLSQL ServerPlanetScaleCockroachDBMongoDBPostgreSQLMongoDB

Prisma Postgres

Prisma ORMImport from PostgreSQLImport from MySQLFrom the CLIPrisma ORMKyselyDrizzle ORMTypeORM

Build

ComposerLocal Development

Deploy

ComputeStorage

Manage

ConsoleQuery Insights

Reference

GuidesCLIREST APIAI

Introduction

Core conceptsGetting started

Concepts

Apps and ModulesServices and contractsService inputDatabasesObject storageBuilding blocks

Workflows

Local developmentTestingDeployingPort an existing app

Reference

Limitations

Tools

CursorCodexWindsurfGitHub CopilotChatGPTTabnineAgent Skills

Prompts

Next.js + PrismaAstro + PrismaTurborepo + PrismaMigrate to Prisma v7

Tutorials

Linktree Clone SaaSBuild a Tweet SaaS with Next.js, Prisma Postgres, and Ollama

Reference

Introduction

Getting StartedConceptsGetting started

Features

Database MetricsBranchingDeploymentsKeeping instances awakeRequest timeoutImage TransformationsObject storageEnvironment variablesDomains

Integrations

GitHubDeploy on pushDeploy ButtonAlchemy

More

Feature MaturitySupportPricingFAQKnown limitations

Introduction

OverviewGlobal flagsConfigurationEnvironment variablesError reference

Standalone commands

initgeneratevalidateformatstudiodebugversion

Migrate commands

migratedevresetdeploystatusresolvediff

Dev commands

devls rm startstop

DB commands

db pullpushseedexecute

Console commands

platformstatus

Platform

authbranchbucketdeploydevgitinitpostgresprojectservice

ORM

contract emitcontract infercontract printdb initdb migratedb schemadb signdb updatedb verifyorm init

Migration

migration newmigration planmigration showmigration statusmigration ref

Utility

feedbackskillstelemetry

Local Development

Local appLocal storageLocal Postgres

Introduction

Prisma ORMPrisma 7

Prisma Client

Prisma ClientIntroduction to Prisma ClientGenerating Prisma ClientCustom model and field namesRead replicasDatabase polyfillsConfiguring error formattingIntroduction to Prisma ClientGenerating Prisma ClientInstantiating Prisma ClientDatabase connectionsConnection poolConnection managementConfigure Prisma Client with PgBouncerDatabase connectionsConnection poolConnection managementConfigure Prisma Client with PgBouncerCustom model and field namesRead replicasDatabase polyfillsNo Rust engineConfiguring error formattingCRUDSelect fieldsExcluding fieldsRelation queriesFiltering and sortingPaginationAggregation, grouping, and summarizingTransactions and batch queriesFull-text searchQuery optimizationCRUDSelect fieldsExcluding fieldsRelation queriesFiltering and SortingPaginationAggregation, grouping, and summarizingComputed fieldsCustom modelsTransactions and batch queriesFull-text searchCase sensitivityCustom validationQuery optimizationWhat are Client ExtensionsAdd methods to Prisma ClientAdd custom methods to your modelsCreate custom Prisma Client queriesAdd custom fields and methods to query resultsType utilitiesExtensionsclient: Add methods to Prisma Clientmodel: Add custom methods to your modelsquery: Create custom Prisma Client queriesresult: Add custom fields and methods to query resultsType utilitiesShared Prisma Client extensionsFine-Grained Authorization (Permit)Shared Prisma Client extensionsFine-Grained Authorization (Permit)Shared packages & examplesShared packages & examplesDeploy Prisma ORMDeploying database changes with Prisma MigrateDeploy migrations from a local environmentCaveats when deploying to AWS platformsDeploy Prisma ORMDeploying database changes with Prisma MigrateDeploy migrations from a local environmentDeploy to a different OSModule bundlersCaveats when deploying to AWS platformsDeploy to VercelDeploy to AWS LambdaDeploy to Azure FunctionsDeploy to NetlifyServerless functionsDeploy to VercelDeploy to AWS LambdaDeploy to Azure FunctionsDeploy to NetlifyDeploying edge functions with Prisma ORMDeploy to Vercel Edge Functions & MiddlewareDeploy to Cloudflare Workers & PagesDeploy to Deno DeployEdge functionsDeploying edge functions with Prisma ORMDeploy to Vercel Edge Functions & MiddlewareDeploy to Cloudflare Workers & PagesDeploy to Deno DeployDeploy to HerokuDeploy to RailwayDeploy to Fly.ioDeploy to KoyebDeploy to RenderDeploy to SevallaTraditional serversDeploy to HerokuDeploy to RailwayDeploy to Fly.ioDeploy to KoyebDeploy to RenderDeploy to SevallaLoggingOpenTelemetry tracingSQL commentsLoggingMetricsOpenTelemetry tracingSQL commentsDebuggingHandling exceptions and errorsDebuggingHandling exceptions and errorsTroubleshooting binary size and deployment issuesFields & typesWorking with Json fieldsWorking with scalar listsWorking with compound IDs and unique constraintsComposite typesNull and undefinedFields & typesWorking with Json fieldsWorking with scalar listsWorking with compound IDs and unique constraintsComposite typesNull and undefinedUnit testingIntegration testingTestingUnit testingIntegration testingType safety OverviewHow to use Prisma ORM's type systemOperating against partial structures of your model typesType safetyHow to use Prisma ORM's type systemPrisma validatorOperating against partial structures of your model typesWrite your own SQLRaw queriesTypedSQLSafeQL & Prisma ClientWrite your own SQLRaw queriesTypedSQLSafeQL & Prisma Client

Prisma Migrate

Getting started with Prisma MigrateOverview on Prisma MigrateMental modelAbout migration historiesAbout the shadow databaseLimitations and known issuesLegacy Prisma MigrateOverview of Prisma MigrateGetting started with Prisma MigrateUnderstanding MigrationsMigration historiesAbout the shadow databaseLimitations and known issuesPrototyping your schemaDevelopment and productionBaselining a databaseCustomizing migrationsGenerating down migrationsSquashing migrationsPatching & hotfixingSeedingNative database typesNative database functionsUnsupported database features (Prisma Migrate)TroubleshootingPrototyping your schemaDevelopment and productionTeam developmentBaselining a databaseCustomizing migrationsData migrationsGenerating down migrationsSquashing migrationsPatching & hotfixingSeedingNative database typesNative database functionsUnsupported database features (Prisma Migrate)Troubleshooting

Introduction

Getting StartedPartner Integration

Authentication & Tools

Using API ClientsAuthenticationSDK

Endpoints

Delete databaseGet databaseList databasesGet list of databasesUpdate databaseRestore database (destructive)Create databaseCreate databaseGet list of backupsGet database usage metricsGet list of database connectionsCreate database connection stringDelete integrationRevoke integration tokensGet integration by IDGet list of integrationsGet list of integrationsDelete projectGet projectGet list of projectsUpdate projectTransfer projectCreate project with a postgres databaseGet workspace subscriptionGet workspaceGet list of workspacesDelete connectionGet connectionList connectionsRotate connection credentialsCreate connectionGet all regionsGet current authenticated principalGet Prisma Accelerate regionsGet Prisma Postgres regionsDelete bucket keyDelete bucketList bucket keysGet bucketList bucketsUpdate bucketCreate bucket keyCreate bucketDelete service tokenList service tokensCreate service tokenPoll an approval

Introduction

Getting StartedStudio with Prisma ORM

Integrations

Studio in VS CodeEmbed Studio

Suggest an edit