FastAPIframework~30 mins

Alembic migrations in FastAPI - Mini Project: Build & Apply

Choose your learning style10 modes available

Learn Why Deep Visual Try Challenge Project Recall Perf

Start learning this pattern below

Jump into concepts and practice - no test required

Recommended

Test this pattern10 questions across easy, medium, and hard to know if this pattern is strong

Alembic Migrations with FastAPI

📖 Scenario: You are building a simple FastAPI app to manage books in a library. You want to keep track of your database changes safely using Alembic migrations.

🎯 Goal: Create a basic Alembic migration setup for a FastAPI project. Define an initial database model, configure Alembic, generate a migration script, and apply it to create the database table.

📋 What You'll Learn

Create a SQLAlchemy model for a Book with id and title fields

Set up Alembic configuration with the correct database URL

Generate an Alembic migration script for the Book model

Apply the migration to create the books table in the database

💡 Why This Matters

🌍 Real World

Alembic migrations help developers safely update database schemas as their applications grow and change.

💼 Career

Understanding Alembic migrations is essential for backend developers working with FastAPI and SQLAlchemy to maintain database integrity.

Progress0 / 4 steps

Create the SQLAlchemy Book model

Create a SQLAlchemy model class called Book with a table name books. It should have two columns: id as an integer primary key and title as a string of max length 100.

FastAPI

from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

# Define the Book model here

Hint

Use class Book(Base): and set __tablename__ = 'books'. Define id and title columns with correct types.

Configure Alembic with the database URL

Add a variable called SQLALCHEMY_DATABASE_URL and set it to sqlite:///./test.db. This will be the database URL Alembic uses.

FastAPI

from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class Book(Base):
    __tablename__ = 'books'
    id = Column(Integer, primary_key=True)
    title = Column(String(100))

# Set the database URL for Alembic

Hint

Set SQLALCHEMY_DATABASE_URL exactly to "sqlite:///./test.db".

Generate Alembic migration script

Write a command string variable called alembic_command with the value "alembic revision --autogenerate -m 'create books table'". This command generates the migration script for the Book model.

FastAPI

from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class Book(Base):
    __tablename__ = 'books'
    id = Column(Integer, primary_key=True)
    title = Column(String(100))

SQLALCHEMY_DATABASE_URL = "sqlite:///./test.db"

# Write the Alembic revision command string

Hint

Set alembic_command to the exact Alembic command string to generate migration.

Apply Alembic migration to create the table

Write a command string variable called alembic_upgrade with the value "alembic upgrade head". This command applies the migration and creates the books table in the database.

FastAPI

from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class Book(Base):
    __tablename__ = 'books'
    id = Column(Integer, primary_key=True)
    title = Column(String(100))

SQLALCHEMY_DATABASE_URL = "sqlite:///./test.db"

alembic_command = "alembic revision --autogenerate -m 'create books table'"

# Write the Alembic upgrade command string

Hint

Set alembic_upgrade to the exact Alembic command string to apply migration.

Practice

(1/5)

1. What is the main purpose of Alembic migrations in a FastAPI project?

easy

A. To manage and apply database schema changes safely over time

B. To handle HTTP requests and responses

C. To serve static files like images and CSS

D. To create user interface components

Alembic migrations in FastAPI - Mini Project: Build & Apply

Start learning this pattern below

Practice

Solution

Step 1: Understand Alembic's role

Step 2: Identify the correct purpose

Final Answer:

Quick Check:

Solution

Step 1: Identify commands for migration scripts

Step 2: Match the command

Final Answer:

Quick Check:

Solution

Step 1: Understand the revision command

Step 2: Understand the upgrade command

Final Answer:

Quick Check:

Solution

Step 1: Identify cause of error

Step 2: Fix the migration script

Final Answer:

Quick Check:

Solution

Step 1: Create a new migration script

Step 2: Apply the migration

Final Answer:

Quick Check: