Creating migrations in Supabase

Introduction

Migrations help you save and track changes to your database structure. They make it easy to update your database safely and share changes with your team.

When you add a new table to store data.

When you change a column type or add a new column.

When you remove or rename a table or column.

When you want to keep a history of database changes.

When working with a team to keep everyone's database in sync.

Syntax

Supabase

supabase migration new <migration_name>
supabase db reset
supabase migration apply

supabase migration new creates a new migration file with your changes.

supabase db reset resets the local database and applies migrations.

supabase migration apply applies migrations to the remote database.

Examples

This creates a migration file to add a users table.

Supabase

supabase migration new add_users_table

This resets the local database and applies all migrations.

Supabase

supabase db reset

This applies migrations to your remote Supabase database.

Supabase

supabase migration apply

Sample Program

This migration creates a new table called users with three columns: id, name, and email. The commands create the migration file, reset and apply it locally, and then apply it to the remote database.

Supabase

-- Migration file: 20240601_add_users_table.sql
CREATE TABLE users (
  id SERIAL PRIMARY KEY,
  name TEXT NOT NULL,
  email TEXT UNIQUE NOT NULL
);

-- Commands to run:
supabase migration new add_users_table
supabase db reset
supabase migration apply

Important Notes

Always write clear and descriptive migration names.

Test migrations locally before applying them to production.

Keep migrations small and focused on one change at a time.

Summary

Migrations save and track database changes.

Use supabase migration new to create migration files.

Reset and apply migrations locally with supabase db reset and apply migrations remotely with supabase migration apply.

Practice

1. What is the main purpose of creating migrations in Supabase?

easy

A. To save and track changes made to the database structure

B. To create user accounts automatically

C. To deploy frontend code to the server

D. To monitor server uptime and performance

Solution

1. Step 1: Understand what migrations do

   Migrations are files that record changes to the database schema over time.

2. Step 2: Identify the purpose in Supabase context

   Supabase uses migrations to save and track database structure changes so they can be applied consistently.

3. Final Answer:

   To save and track changes made to the database structure -> Option A

4. Quick Check:

   Migrations = track database changes [OK]

Hint: Migrations always track database structure changes [OK]

Common Mistakes:

• Confusing migrations with user management
• Thinking migrations deploy frontend code
• Assuming migrations monitor server health

2. Which command creates a new migration file in Supabase?

easy

A. supabase migration up

B. supabase db push

C. supabase migration new

D. supabase start migration

Solution

1. Step 1: Recall Supabase migration commands

   The command to create a new migration file is specifically designed to generate the file for changes.

2. Step 2: Match command to action

   supabase migration new creates a new migration file, while others apply or push changes.

3. Final Answer:

   supabase migration new -> Option C

4. Quick Check:

   Create migration file = supabase migration new [OK]

Hint: New migration files use 'migration new' command [OK]

Common Mistakes:

• Using 'db push' to create migration files
• Confusing 'migration up' with creation
• Typing incorrect commands like 'start migration'

3. After creating a migration file, which command applies the changes to your remote database?

medium

A. supabase migration up

B. supabase db push

C. supabase migration new

D. supabase db pull

Solution

1. Step 1: Understand commands for applying migrations

   supabase db push applies schema changes to the remote database by pushing local migrations.

2. Step 2: Differentiate commands

   supabase migration up applies migrations locally, while supabase db push pushes changes remotely.

3. Final Answer:

   supabase db push -> Option B

4. Quick Check:

   Apply remotely = db push [OK]

Hint: Use 'supabase db push' to apply migrations remotely [OK]

Common Mistakes:

• Using 'supabase migration up' to apply migrations remotely
• Confusing 'migration new' as apply command
• Thinking 'db pull' applies migrations

4. You ran supabase migration up but got an error saying migrations are missing. What is the likely cause?

medium

A. You used the wrong command to apply locally

B. You need to restart the Supabase server

C. Your database connection is offline

D. You forgot to create migration files before applying

Solution

1. Step 1: Analyze the error about missing migrations

   The error indicates no migration files exist to apply locally.

2. Step 2: Identify the cause

   This usually happens if migration files were never created with supabase migration new.

3. Final Answer:

   You forgot to create migration files before applying -> Option D

4. Quick Check:

   Missing migrations = no files created [OK]

Hint: Create migration files before applying locally [OK]

Common Mistakes:

• Assuming connection issues cause missing migrations
• Restarting server without creating files
• Confusing local and remote apply commands

5. You want to update your remote Supabase database with new schema changes. Which sequence of commands should you run?

hard

A. supabase migration new -> supabase start -> supabase migration up

B. supabase db push -> supabase migration new -> supabase migration up

C. supabase migration up -> supabase migration new -> supabase db push

D. supabase migration new -> supabase migration up -> supabase db push

Solution

1. Step 1: Create migration files first

   Use supabase migration new to save schema changes as migration files.

2. Step 2: Apply changes locally

   Run supabase start to update your local database with these changes.

3. Step 3: Apply migrations remotely

   Finally, run supabase migration up to update the remote database.

4. Final Answer:

   supabase migration new -> supabase start -> supabase migration up -> Option A

5. Quick Check:

   Create -> local start -> remote up [OK]

Hint: Create migration, start locally, then up remotely [OK]

Common Mistakes:

• Applying migrations before creating files
• Applying remotely before local test
• Mixing order of commands