Schema location
Documentation regarding proper location of Prisma Schema including default naming and multiple files.
The default name for the Prisma Schema is a single file schema.prisma in your prisma folder. When your schema is named like this, the Prisma CLI will detect it automatically.
Prisma Schema location
The Prisma CLI looks for the Prisma Schema in the following locations, in the following order:
-
The location specified by the
--schemaflag, which is available when youintrospect,generate,migrate, andstudio:prisma generate --schema=./alternative/schema.prisma -
The location specified in the
prisma.config.tsfile:prisma.config.ts import { defineConfig } from "prisma/config"; export default defineConfig({ schema: "prisma/", ... }); -
Default locations:
./prisma/schema.prisma./schema.prisma
The Prisma CLI outputs the path of the schema that will be used. The following example shows the terminal output for prisma db pull:
Environment variables loaded from .env
Prisma Schema loaded from prisma/schema.prisma // [!code highlight]
Introspecting based on datasource defined in prisma/schema.prisma …
✔ Introspected 4 models and wrote them into prisma/schema.prisma in 239ms
Run prisma generate to generate Prisma Client.Multi-file Prisma schema
If you prefer splitting your Prisma schema into multiple files, you can have a setup that looks as follows:
prisma/
├── migrations
├── models
│ ├── posts.prisma
│ ├── users.prisma
│ └── ... other `.prisma` files
└── schema.prismaUsage
When using a multi-file Prisma schema, you must always explicitly specify the location of the directory that contains your schema files (including the main schema.prisma file with your generator block).
You can do this in two ways:
-
pass the
--schemaoption to your Prisma CLI command (e.g.prisma migrate dev --schema ./prisma) -
set the
schemaproperty inprisma.config.ts(for Prisma ORM v7):prisma.config.ts import { defineConfig, env } from "prisma/config"; import "dotenv/config"; export default defineConfig({ schema: "prisma/", migrations: { path: "prisma/migrations", seed: "tsx prisma/seed.ts", }, datasource: { url: env("DATABASE_URL"), }, });
We recommend using the Prisma Config file to specify the location of your Prisma schema. This is the most flexible way to specify the location of your Prisma schema alongside other configuration options.
The schema.prisma file (which contains your generator block) must be located in the same directory that you specify in your schema configuration. For example, if you configure schema: 'prisma', your schema.prisma file must be at prisma/schema.prisma, not in a subdirectory like prisma/models/schema.prisma.
You must also place the migrations directory at the same level as your schema.prisma file.
For example, assuming schema.prisma defines the generator block, here's the correct directory structure:
# All files must be inside the `prisma/` directory
# `migrations` and `schema.prisma` must be at the same level
prisma/
├── migrations
├── models
│ ├── posts.prisma
│ └── users.prisma
└── schema.prisma # Contains generator blockIf your schema files are in a prisma/ directory (as shown above), the Prisma CLI commands like prisma generate and prisma migrate dev will work without additional configuration, as ./prisma/schema.prisma is a default location.
Tips for multi-file Prisma Schema
We've found that a few patterns work well with this feature and will help you get the most out of it:
- Organize your files by domain: group related models into the same file. For example, keep all user-related models in
user.prismawhile post-related models go inpost.prisma. - Use clear naming conventions: schema files should be named clearly and succinctly. Use names like
user.prismaandpost.prismaand notmyModels.prismaorCommentFeaturesSchema.prisma. - Have an obvious "main" schema file: while you can now have as many schema files as you want, you'll still need a place where you define your
generatorblock. We recommend having a single schema file that's obviously the "main" file so that this block is easy to find.main.prisma,schema.prisma, andbase.prismaare a few we've seen that work well.
Generators
Generators in your Prisma schema specify what assets are generated when the `prisma generate` command is invoked. This page explains how to configure generators
Models
Learn about the concepts for building your data model with Prisma: Models, scalar types, enums, attributes, functions, IDs, default values and more