Prisma is a modern ORM (Object-Relational Mapping) that facilitates interaction with databases in Node.js and TypeScript applications. One of Prisma's most important features is the migration system, which allows you to keep the database schema synchronized with the application's data model. In this post, we will explore the Prisma workflow using migrations.

What are Migrations?

Migrations are a method for controlling and applying changes to the database schema in a systematic and versioned way. They allow you to define structural changes to the database, such as creating or altering tables, in an incremental and reversible manner.

Prisma Workflow with Migrations

The typical workflow with migrations in Prisma involves the following steps:

1. Installation and Initial Configuration
2. Schema Definition
3. Creating a Migration
4. Migration Application
5. Migration Management

Step 1: Installation and Initial Configuration

First, we need to install Prisma in the project and initialize it:

npm install @prisma/client
npx prisma init

This command creates a prism directory containing a schema.prisma file, where we define our data model.

Step 2: Schema Definition

In the schema.prisma file, we define the models that represent the database tables. For example, let's define a model User:

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

Here, we are defining a User table with id, email and name columns.

Step 3: Creating a Migration

After defining or changing the schema, we create a migration to reflect these changes in the database:

npx prisma migrate dev --name init

The migrate dev command creates a new migration and applies the changes to the database. The --name parameter allows you to give the migration a descriptive name, like init in the example above.

Step 4: Migration Application

Migrations are automatically applied to the database when we use the migrate dev command. This ensures that the database is always in sync with the data model defined in schema.prisma.

If you want to apply migrations in a production environment, use the command:

npx prisma migrate deploy

This command applies all pending migrations to the production database.

Step 5: Migration Management

Prisma keeps a history of all migrations applied to the database. This is useful for tracking changes and reverting migrations if necessary. To see the migration history, you can use:

npx prisma migrate status

This command shows the current status of migrations, including which migrations have been applied and which are pending.

Practical Example

Let's see a practical example of how to add a new field to the User model and create a migration for this change.

1. Add the field to the User model in schema.prisma:
   

   model User {
     id        Int     @id @default(autoincrement())
     email     String  @unique
     name      String?
     birthdate DateTime?
   }
   
   

2. Create a new migration:
   

   npx prisma migrate dev --name add-birthdate-to-user
   
   

3. Apply migration:

   The migrate dev command already applies the migration to the database. Now the database will have the new birthdate field in the User table.

4. Check migration status:
   

   npx prisma migrate status
   
   

   This command will show that the add-birthdate-to-user migration was applied successfully.

Conclusion

Prisma's workflow using migrations is an efficient and safe way to manage changes to the database schema. Through a clear sequence of steps – defining the schema, creating migrations, applying changes and managing the migration history – it is possible to keep the database synchronized with the application's data model, facilitating the development and maintenance of the software.

With Prisma, you not only simplify database management, but you also gain a powerful tool to ensure that all changes are traceable and reversible, contributing to a more robust and agile development process.