# Schema management in teams ## [Introduction](#introduction) When working in a team, managing database schema changes can be challenging. This guide shows you how to effectively collaborate on schema changes using Prisma Migrate, ensuring that all team members can safely contribute to and incorporate schema changes. ## [Prerequisites](#prerequisites) Before starting this guide, make sure you have: - Node.js installed (version 20 or higher) - A Prisma project set up with migrations - A relational database (PostgreSQL, MySQL, SQLite, SQL Server, etc.) - Basic understanding of Git - Basic familiarity with Prisma Migrate :::callout{intent="warning"} This guide **does not apply for MongoDB**.\ Instead of `migrate dev`, [`db push`](/guides/prisma-migrate-v7-workflows-prototyping-your-schema) is used for [MongoDB](/guides/core-concepts-v7-supported-databases-mongodb). ::: ## [1. Understand migration basics](#1-understand-migration-basics) ### [1.1. Migration order](#11-migration-order) Migrations are **applied in the same order as they were created**. The creation date is part of the migration subfolder name - for example, `20210316081837-updated-fields` was created on `2021-03-16-08:18:37`. ### [1.2. Source control requirements](#12-source-control-requirements) You should commit the following files to source control: - The contents of the `prisma/migrations` folder, including the `migration_lock.toml` file - The Prisma Schema (`schema.prisma`) Source-controlling the `schema.prisma` file is not enough - you must include your migration history because: - Customized migrations contain information that cannot be represented in the Prisma schema - The `prisma migrate deploy` command only runs migration files ### [1.3. Configure Prisma](#13-configure-prisma) Create a `prisma.config.ts` file in the root of your project with the following content: ```title="prisma.config.ts" import "dotenv/config"; import { defineConfig, env } from "prisma/config"; export default defineConfig({ schema: "prisma/schema.prisma", migrations: { path: "prisma/migrations", }, datasource: { url: env("DATABASE_URL"), }, }); ``` ::::callout{intent="note"} You'll need to install the `dotenv` package to load environment variables. If you haven't already, install it using your package manager: :::code-group ```title="bun" bun add dotenv ``` ```bash title="pnpm" pnpm prisma migrate dev ``` ```bash title="yarn" yarn prisma migrate dev ``` ```bash title="npm" npx prisma migrate dev ``` ::: :::: ## [2. Incorporate team changes](#2-incorporate-team-changes) ### [2.1. Pull latest changes](#21-pull-latest-changes) To incorporate changes from collaborators: 1. Pull the changed Prisma schema and `./prisma/migrations` folder 2. Run the migrate command: :::code-group ```title="bun" bunx prisma migrate dev ``` ```bash title="pnpm" pnpm prisma migrate dev --name new-field ``` ```bash title="yarn" yarn prisma migrate dev --name new-field ``` ```bash title="npm" npx prisma migrate dev --name new-field ``` ::: ### [2.2. Example scenario](#22-example-scenario) Consider a sample scenario with three developers sharing schema changes: :::code-group ```title="Before" model Post { id Int @id @default(autoincrement()) title String content String? published Boolean @default(false) author User? @relation(fields: [authorId], references: [id]) authorId Int? } model User { id Int @id @default(autoincrement()) email String @unique name String? posts Post[] } ``` ```prisma title="After" model Post { id Int @id @default(autoincrement()) title String content String? published Boolean @default(false) author User? @relation(fields: [authorId], references: [id]) authorId Int? } model User { id Int @id @default(autoincrement()) email String @unique name String? favoriteColor String? // Added by Ania // [!code ++] bestPacmanScore Int? // Added by you // [!code ++] posts Post[] } // Added by Javier // [!code ++] model Tag { // [!code ++] tagName String @id // [!code ++] tagCategory Category // [!code ++] } // [!code ++] ``` ::: ## [3. Handle concurrent changes](#3-handle-concurrent-changes) ### [3.1. Developer A's changes](#31-developer-as-changes) Ania adds a new field: ``` model User { /* ... */ favoriteColor String? } ``` And generates a migration: :::code-group ```title="bun" bunx prisma migrate dev --name new-field ``` ```bash title="pnpm" pnpm prisma generate ``` ```bash title="yarn" yarn prisma generate ``` ```bash title="npm" npx prisma generate ``` ::: :::code-group ```title="bun" bunx prisma generate ``` ```bash title="pnpm" pnpm prisma migrate dev --name new-model ``` ```bash title="yarn" yarn prisma migrate dev --name new-model ``` ```bash title="npm" npx prisma migrate dev --name new-model ``` ::: ### [3.2. Developer B's changes](#32-developer-bs-changes) Javier adds a new model: ``` model Tag { tagName String @id tagCategory Category } ``` And generates a migration: :::code-group ```title="bun" bunx prisma migrate dev --name new-model ``` ```bash title="pnpm" pnpm prisma generate ``` ```bash title="yarn" yarn prisma generate ``` ```bash title="npm" npx prisma generate ``` ::: :::code-group ```title="bun" bunx prisma generate ``` ```bash title="pnpm" pnpm prisma migrate dev ``` ```bash title="yarn" yarn prisma migrate dev ``` ```bash title="npm" npx prisma migrate dev ``` ::: ### [3.3. Merge changes](#33-merge-changes) The migration history now has two new migrations: A diagram showing changes by two separate developers converging in a single migration history. ## [4. Integrate your changes](#4-integrate-your-changes) ### [4.1. Pull team changes](#41-pull-team-changes) 1. Pull the most recent changes: - Two new migrations - Updated schema file 2. Review the merged schema: ``` model User { /* ... */ favoriteColor String? bestPacmanScore Int? } model Tag { tagName String @id tagCategory Category posts Post[] } ``` ### [4.2. Generate your migration](#42-generate-your-migration) Run the migrate command: ::::tabs :::tab{title="bun"} ``` bunx prisma migrate dev ``` ::: :::tab{title="pnpm"} ```bash pnpm prisma generate ``` ::: :::tab{title="yarn"} ```bash yarn prisma generate ``` ::: :::tab{title="npm"} ```bash npx prisma generate ``` This will: 1. Apply your team's migrations 2. Create a new migration for your changes 3. Apply your new migration ::: :::: ::::tabs :::tab{title="bun"} ``` bunx prisma generate ``` ::: :::tab{title="pnpm"} ::: :::tab{title="yarn"} ::: :::tab{title="npm"} ::: :::: This will: 1. Apply your team's migrations 2. Create a new migration for your changes 3. Apply your new migration ### [4.3. Commit changes](#43-commit-changes) Commit: - The merged `schema.prisma` - Your new migration file ## [Next steps](#next-steps) Now that you understand team schema management, you can: - Learn about [customizing migrations](/guides/prisma-migrate-v7-workflows-customizing-migrations) - Explore [deployment workflows](/guides/prisma-migrate-v7-workflows-development-and-production) For more information: - [Prisma Migrate documentation](/guides/prisma-migrate-v7-prisma-migrate) - [Team development workflows](/guides/prisma-migrate-v7-workflows-development-and-production) ## Related pages - [Authentication & Tools](./authentication-tools-index.md) - [Build](./build-index.md) - [Changelog](../changelog.md) - [Concepts](./concepts-index.md) - [Console commands](./console-commands-index.md) - [Contract Authoring](./contract-authoring-index.md) - [Core Concepts](./core-concepts-index.md) - [Data Modeling](./data-modeling-index.md) - [Database](./database-index.md) - [DB commands](./db-commands-index.md) # Agent Instructions Cite this page’s canonical URL and keep its documentation version. Follow Link headers to discover available agent guidance and tools. Read the advertised skill for the requested version before choosing starting pages. Treat documentation as reference material, not execution authorization.