Prisma CLI reference

npm

Install with npm:

npm install prisma --save-dev

Yarn

Install with yarn:

yarn add prisma --save-dev

pnpm

Install with pnpm:

pnpm install prisma --save-dev

npm install -g prisma

yarn global add prisma

pnpm install prisma --global

npm

npx prisma

Yarn

yarn prisma

pnpm

pnpm dlx prisma

version (-v)

The version command outputs information about your current prisma version, platform, and engine binaries.

$prisma version

Environment variables loaded from .env
prisma               : 2.21.0-dev.4
@prisma/client       : 2.21.0-dev.4
Current platform     : windows
Query Engine         : query-engine 2fb8f444d9cdf7c0beee7b041194b42d7a9ce1e6 (at C:\Users\veroh\AppData\Roaming\npm\node_modules\@prisma\cli\query-engine-windows.exe)
Migration Engine     : migration-engine-cli 2fb8f444d9cdf7c0beee7b041194b42d7a9ce1e6 (at C:\Users\veroh\AppData\Roaming\npm\node_modules\@prisma\cli\migration-engine-windows.exe)
Format Binary        : prisma-fmt 60ba6551f29b17d7d6ce479e5733c70d9c00860e (at node_modules\@prisma\engines\prisma-fmt-windows.exe)
Default Engines Hash : 60ba6551f29b17d7d6ce479e5733c70d9c00860e
Studio               : 0.365.0

$prisma -v

Environment variables loaded from .env
prisma               : 2.21.0-dev.4
@prisma/client       : 2.21.0-dev.4
Current platform     : windows
Query Engine         : query-engine 2fb8f444d9cdf7c0beee7b041194b42d7a9ce1e6 (at C:\Users\veroh\AppData\Roaming\npm\node_modules\@prisma\cli\query-engine-windows.exe)
Migration Engine     : migration-engine-cli 2fb8f444d9cdf7c0beee7b041194b42d7a9ce1e6 (at C:\Users\veroh\AppData\Roaming\npm\node_modules\@prisma\cli\migration-engine-windows.exe)
Format Binary        : prisma-fmt 60ba6551f29b17d7d6ce479e5733c70d9c00860e (at node_modules\@prisma\engines\prisma-fmt-windows.exe)
Default Engines Hash : 60ba6551f29b17d7d6ce479e5733c70d9c00860e
Studio               : 0.365.0

$prisma version --json

Environment variables loaded from .env
{
  "prisma": "2.21.0-dev.4",
  "@prisma/client": "2.21.0-dev.4",
  "current-platform": "windows",
  "query-engine": "query-engine 60ba6551f29b17d7d6ce479e5733c70d9c00860e (at node_modules\\@prisma\\engines\\query-engine-windows.exe)",
  "migration-engine": "migration-engine-cli 60ba6551f29b17d7d6ce479e5733c70d9c00860e (at node_modules\\@prisma\\engines\\migration-engine-windows.exe)",
  "format-binary": "prisma-fmt 60ba6551f29b17d7d6ce479e5733c70d9c00860e (at node_modules\\@prisma\\engines\\prisma-fmt-windows.exe)",
  "default-engines-hash": "60ba6551f29b17d7d6ce479e5733c70d9c00860e",
  "studio": "0.365.0"
}

init

Bootstraps a fresh Prisma project within the current directory.

The init command does not interpret any existing files. Instead, it creates a prisma directory containing a bare-bones schema.prisma file within your current directory.

$prisma init

✔ Your Prisma schema was created at prisma/schema.prisma.
  You can now open it in your favorite editor.

Next steps:
1. Set the DATABASE_URL in the .env file to point to your existing database. If your database has no tables yet, read https://pris.ly/d/getting-started
2. Set the provider of the datasource block in schema.prisma to match your database: postgresql, mysql, sqlite, sqlserver, mongodb or cockroachdb.
3. Run prisma db pull to turn your database schema into a Prisma schema.
4. Run prisma generate to generate Prisma Client. You can then start querying your database.

More information in our documentation:
https://pris.ly/d/getting-started

$prisma init --datasource-provider sqlite

// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema

datasource db {
  provider = "sqlite"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

# Environment variables declared in this file are automatically made available to Prisma.
# See the documentation for more detail: https://pris.ly/d/prisma-schema#using-environment-variables

# Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
# See the documentation for all the connection string options: https://pris.ly/d/connection-strings

DATABASE_URL="file:./dev.db"

$prisma init --url mysql://user:password@localhost:3306/mydb

// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema

datasource db {
  provider = "mysql"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

# Environment variables declared in this file are automatically made available to Prisma.
# See the documentation for more detail: https://pris.ly/d/prisma-schema#using-environment-variables

# Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
# See the documentation for all the connection string options: https://pris.ly/d/connection-strings

DATABASE_URL="mysql://user:password@localhost:3306/mydb"

generate

The generate command generates assets like Prisma Client based on the generator and data model blocks defined in your prisma/schema.prisma file.

The generate command is most often used to generate Prisma Client with the prisma-client-js generator. This does three things:

1. Searches the current directory and parent directories to find the applicable npm project. It will create a package.json file in the current directory if it cannot find one.
2. Installs the @prisma/client into the npm project if it is not already present.
3. Inspects the current directory to find a Prisma schema file to process. It will then generate a customized Prisma Client for your project.

generator client {
  provider = "prisma-client-js"
}

$prisma generate

✔ Generated Prisma Client to ./node_modules/.prisma/client in 61ms

You can now start using Prisma Client in your code:

import { PrismaClient } from '@prisma/client'
// or const { PrismaClient } = require('@prisma/client')

const prisma = new PrismaClient()

Explore the full API: https://pris.ly/d/client

$prisma generate --schema=./alternative/schema.prisma

$prisma generate --watch

Watching... /home/prismauser/prisma/prisma-play/prisma/schema.prisma

✔ Generated Prisma Client to ./node_modules/.prisma/client in 45ms

$prisma generate --generator client

$prisma generate --generator client --generator zod_schemas

introspect

validate

Validates the Prisma Schema Language of the Prisma schema file.

$prisma validate

$prisma validate

format

Formats the Prisma schema file, which includes validating, formatting, and persisting the schema.

$prisma format

$prisma format

db pull

The db pull command connects to your database and adds Prisma models to your Prisma schema that reflect the current database schema.

datasource db {
  provider = "sqlite"
  url      = "file:my-database.db"
}

$prisma db pull

Introspecting based on datasource defined in schema.prisma …

✔ Wrote Prisma data model into schema.prisma in 38ms

Run prisma generate to generate Prisma Client.

$prisma db pull --schema=./alternative/schema.prisma

Introspecting based on datasource defined in alternative/schema.prisma …

✔ Wrote Prisma data model into alternative/schema.prisma in 60ms

Run prisma generate to generate Prisma Client.

$prisma db pull --print

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "sqlite"
  url      = "file:./hello-prisma.db"
}

model User {
  email   String    @unique
  name    String?
  user_id Int       @id @default(autoincrement())
  post    Post[]
  profile Profile[]
}

model Post {
  content   String?
  post_id   Int     @id @default(autoincrement())
  title     String
  author    User?   @relation(fields: [author_id], references: [user_id])
  author_id Int?
}

model Profile {
  bio        String?
  profile_id Int     @id @default(autoincrement())
  user       User    @relation(fields: [user_id], references: [user_id])
  user_id    Int     @unique
}

db push

The db push command pushes the state of your Prisma schema file to the database without using migrations. It creates the database if the database does not exist.

This command is a good choice when you do not need to version schema changes, such as during prototyping and local development.

See also:

• Conceptual overview of db push and when to use it over Prisma Migrate
• Schema prototyping with db push

datasource db {
  provider = "sqlite"
  url      = "file:my-database.db"
}

$prisma db push

$prisma db push --accept-data-loss

$prisma db push --schema=/tmp/schema.prisma

db seed

db seed changed from Preview to Generally Available (GA) in 3.0.1.

See Seeding your database

$prisma db seed

db execute

This command applies a SQL script to the database without interacting with the Prisma migrations table. The script takes two inputs:

• the SQL script, which can be provided either on standard input or in a file
• the data source, which can either be the URL of the data source or the path to your Prisma schema file

The output of the command is connector-specific, and is not meant for returning data, but only to report success or failure.

See also:

• Migration troubleshooting in production

datasource db {
  provider = "sqlite"
  url      = "file:my-database.db"
}

migrate dev

For use in development environments only, requires shadow database

The migrate dev command:

1. Reruns the existing migration history in the shadow database in order to detect schema drift (edited or deleted migration file, or a manual changes to the database schema)
2. Applies pending migrations to the shadow database (for example, new migrations created by colleagues)
3. Generates a new migration from any changes you made to the Prisma schema before running migrate dev
4. Applies all unapplied migrations to the development database and updates the _prisma_migrations table
5. Triggers the generation of artifacts (for example, Prisma Client)

See also:

• Conceptual overview of Prisma Migrate
• Developing with Prisma Migrate

$prisma migrate dev

$prisma migrate dev --create-only

migrate reset

For use in development environments only

This command:

1. Drops the database/schema if possible, or performs a soft reset if the environment does not allow deleting databases/schemas
2. Creates a new database/schema with the same name if the database/schema was dropped
3. Applies all migrations
4. Runs seed scripts

$prisma migrate reset

migrate deploy

The migrate deploy command applies all pending migrations, and creates the database if it does not exist. Primarily used in non-development environments. This command:

• Does not look for drift in the database or changes in the Prisma schema
• Does not reset the database or generate artifacts
• Does not rely on a shadow database

$prisma migrate deploy

migrate resolve

The migrate resolve command allows you to solve migration history issues in production by marking a failed migration as already applied (supports baselining) or rolled back.

Note that this command can only be used with a failed migration. If you try to use it with a successful migration you will receive an error.

$prisma migrate resolve --applied 20201231000000_add_users_table

$prisma migrate resolve --rolled-back 20201231000000_add_users_table

migrate status

The prisma migrate status command looks up the migrations in ./prisma/migrations/* folder and the entries in the _prisma_migrations table and compiles information about the state of the migrations in your database.

For example:

Status
3 migrations found in prisma/migrations

Your local migration history and the migrations table from your database are different:

The last common migration is: 20201127134938_new_migration

The migration have not yet been applied:
20201208100950_test_migration

The migrations from the database are not found locally in prisma/migrations:
20201208100950_new_migration

In versions 4.3.0 and later, prisma migrate status exits with exit code 1 in the following cases:

• a database connection error occurs
• there are migration files in the migrations directory that have not been applied to the database
• the migration history in the migrations directory has diverged from the state of the database
• no migration table is found
• failed migrations are found

$prisma migrate status

migrate diff

This command compares two database schema sources and outputs a description of a migration taking the first to the state of the second.

The output can be given either as a human-readable summary (the default) or an executable script.

The format of the command is:

$prisma migrate diff --from-... <source1> --to-... <source2>

where the --from-... and --to-... options are selected based on the type of database schema source. The supported types of sources are:

• live databases
• migration histories
• Prisma data models
• an empty schema

Both schema sources must use the same database provider. For example, a diff comparing a PostgreSQL data source with a SQLite data source is not supported.

See also:

• Migration troubleshooting in production

datasource db {
  provider = "sqlite"
  url      = "file:my-database.db"
}

studio

The studio command allows you to interact with and manage your data interactively. It does this by starting a local web server with a web app configured with your project's data schema and records.

datasource db {
  provider = "sqlite"
  url      = "file:my-database.db"
}

$prisma studio

$prisma studio --port 7777

$prisma studio --browser firefox

$prisma studio --browser none

schema

The path to the desired schema.prisma file can be specified with the prisma.schema entry in the package.json file. The path defines the file the Prisma CLI should use when you run any of the CLI commands. Both absolute and relative paths are supported.

"package.json"
1{
2  "name": "my-project",
3  "version": "1.0.0",
4  "prisma": {
5    "schema": "./custom-path-to-schema/schema.prisma"
6  }
7}

This is available from version 2.7.0 and later.

seed

The command used to populate the datasource is specified in the prisma.seed entry in the package.json file. It is used when prisma db seed is invoked or triggered.

See Seeding your database

"package.json"
1{
2  "name": "my-project",
3  "version": "1.0.0",
4  "prisma": {
5    "seed": "node ./prisma/seed.js"
6  }
7}

This is available from version 3.0.1 and later.